Installation

System requirements

• Windows OS, macOS or Linux with an ANSI-capable terminal emulator
• Java SE JDK 18 (OracleJDK or OpenJDK)
• Maven framework version 3.0 (or newer)

WARNING ⚠️ : A screen resolution of 1920x1080 or more is required to render, see and play the GUI properly. If these requirements are not met, we cannot ensure that the game will behave as designed.

Windows

Installing Terminal

If using Windows 10 or newer, the recommended terminal emulator is "Windows Terminal", obtainable by using this link.

Installing Java

1. Download the compressed archive from Oracle or OpenJDK;
2. Extract content from the zip folder to your preferred location (we recommend 7Zip to uncompress your files, but any un-compression software will do);
3. Then go to START -> Edit the system environment variables;
4. In the USER section select the Path variable and click Edit;
5. Select New and type C:\Users\<your-user>\<path-to-extracted-folder-jdk>\bin then save and exit;
6. Open Windows Terminal (also named just "Terminal") and verify your java version by typing the following command:

java -version

7. If the version is the 18.0.1 or later, the installation has been successful

If something went wrong with the installation try again this or another method at this link.

Installing Maven

1. Download a compressed archive from the Apache Maven Project website and select a version to download (remember for this project Maven 3.0 or later is needed)
2. Extract content from the zip folder to your preferred location (we recommend 7Zip to uncompress your files, but any un-compression software will do);
3. Then go to START -> Edit the system environment variables;
4. In the USER section select the Path variable and click Edit;
5. Select New and type C:\Users\<your-user>\<path-to-extracted-folder-maven>\bin then save and exit;
6. Open Windows Terminal (also named just "Terminal") and verify your Maven version by typing the following command:

mvn --version

7. If the version is the 3 or later, the installation has been successful

If something went wrong with the installation try again this or another method at this link.

macOS

Installing Terminal

The default terminal emulator will run the application, but the recommendation is iTerm2, obtainable directly from its website or by using the Homebrew command:

brew install --cask iterm2

Installing Java

1. Download the Java installer (.dmg) from Oracle the correct version for the system in use:
   • macOS x64 systems
   • macOS aarch64 (64-bit ARM)
2. From either the browser downloads window or from the file browser, double-click the .dmg file to start it. A Finder window appears that contains an icon of an open box and the name of the .pkg file.
3. Click Continue, the installation window will appear.
4. Click Install, a window appears that displays the message: Installer is trying to install new software. Enter your password to allow this.
5. Enter the Administrator username and password and click Install Software. The software is installed and a confirmation window is displayed.
6. Open your terminal of choice and verify your Java version by typing the following command:

java -version

7. If the version is the 18.0.1 or later, the installation has been successful

After the software is installed, you can delete the .dmg file if you want to save disk space.

Installing Maven

1. Install Homebrew (if not already installed)
2. Install Maven by using this Homebrew formula:

brew install maven

3. Open your terminal of choice and verify your Maven version by typing the following command:

mvn -version

4. If the version is the 3 or later, the installation has been successful!

Linux

If you want to download Maven and JavaJDK with your package manager be sure to fulfill the system requirements otherwise follow the next steps.

Installing Terminal

The recommended choice is GNOME Terminal, obtainable from the distribution's package manager

Installing Java

1. Download JavaJDK based on your distro here;
2. Navigate to your preferred install location and extract the .tar.gz archive file using:

tar zxvf jdk-18.<version-number>-x64_bin.tar.gz

3. Now let's set the PATH variable by typing the following code:

   cd $HOME
   nano .bashrc

4. Add the following line to the end of .bashrc:

export PATH=/<path-to-extracted-folder/bin:$PATH

5. Verify your Java version by typing the following command:

java -version

6. If the version is the 18.0.1 or later, the installation has been successful

If something went wrong with the installation try again this or another method at this link.

Installing Maven

1. Download Maven based on your distro here
2. Extract it with:

tar zxvf maven.<version-number>-x64_bin.tar.gz

3. Set PATH variable by appending this command to .bashrc as previous steps:

cd $HOME 
nano .bashrc
export PATH=/<path-to-extracted-folder/bin:$PATH

4. Open your terminal of choice and verify your Maven version by typing the following command:

mvn -v

or

mvn --version

5. If the version is the 3 or later, the installation has been successful