TheTraveler

The Traveler

Stable: 4.5.1
Devel: 4.5.2

This is The Traveler source code on GitHub! You can mod the game, help optimizing, create new game levels and make any changes you want to it! Please, read the License section for more information of what you can do.

ℹ️ About

The Traveler GitHub Repository has been moved to the Note Studios organization. Altough the project is still maintained by me, It has been moved to make the Note Studios in-game logo and face make more sense, so I created this organization and moved the repo here. Even so, you can still use the repo in my account. It has just the main(stable) branch, meaning it’s stable commits. I am just a single person, so feel free to contribute to the project if you want!

🎮 How can I play?

You can play The Traveler right away on Game Jolt or you can build your own with the source!

🧰 Playing from source

This section will guide you on how to build the game and run it with from the source code.

📦 Dependencies

The Traveler needs some dependencies to be installed to make the game run. Such as:

Needed

Java or OpenJDK
Gradle

Optional

Project’s Required Libraries

See under the Libs folder for more information.

📥 Cloning Repository

You can clone this repo Installing Git (recommended) or just downloading the source here, on GitHub:

Using Git: open a new terminal in the desired folder and paste:
```
git clone https://github.com/notestudios/TheTraveler.git
```
After that, Git will start cloning the repo in your current working directory.
Using GitHub CLI(gh)
```
gh repo clone notestudios/TheTraveler
```
The GitHub CLI will start clonning the repo in you current working directory.
Using GitHub:
1. Select the desired branch in the left corner(stable: main; testing: development);
2. Click in the green <> Code dropdown in the right corner of the project files:
3. In the opened menu: click on the Download ZIP button:
4. Open your system’s Downloads folder and extract the downloaded ZIP file (7zip, RAR)

🔨 Compiling

This repository uses Gradle for building and running, you can Install Gradle Tool or use the project one.

Windows: Open a new Windows Terminal, Powershell or CMD window on the project path and use the following comand:
```
.\gradlew.bat build
```
Linux/macOS: Open a new terminal in the project folder and run:
```
./gradlew build
```

🎉 Running

To run the project build you made previously, in the same terminal window, run the following command:

Windows: In the project folder, use the following comand:
```
.\gradlew.bat run
```
Linux/macOS: In the project folder, run:
```
./gradlew run
```
After that, the game will start, if it does not start, open a new issue here, copy and paste the output of the used command in the issue content and I will help you! Have fun!

❤️ Contributing

I want to Contribute!

You’re free to contribute with translations, game experience, interface, design changes and many more! If you just want to suggest a change, or suggest a feature, you can create a New Issue or a Start a Discussion and say what you want to be in the game!

📜 License

This repository is using the GNU General Public License v3, so you can help getting the game better for everyone! See the License Permissions for more information. The code can be modified at any time!

This game has some bugs and other things to do, so if you can, please help me getting the game better. I’ll be happy for your help!

This site is open source. Improve this page.