-
Notifications
You must be signed in to change notification settings - Fork 6
Installation
Download the correct installer based on your OS from releases page. Once downloaded, open it and install the application following the steps provided.
(WINDOWS ONLY) In order to enable ANSI colors on command line interface (cmd) you must run the provided batch file with administrator rights before playing.
(MACOS ONLY) Due to a bug with jpackage after installation, you need to run the .sh instead of the default shortcut in Applications folder.
WARNING: For the best CLI experience, it's required a minimum resolution of 1920x1080 and a monospace font; based on the font size, DPI scaling and line spacing you might want to zoom out/in your terminal, or run it in fullscreen mode. If these requirements are not met we cannot ensure a high quality CLI experience.
- Linux, MacOS or Windows OS with an active terminal.
- Java SE JDK 14 (OracleJDK or OpenJDK).
- Maven framework version 3.0 (or newer).
WARNING: For the best CLI experience, we suggest using a native linux terminal with a monospace font with size set to 12 (or below), a line spacing set to 0.9 (or below) and a screen resolution of 1920x1080 (100% DPI). The terminal should run in fullscreen mode or maximized window mode. If these requirements are not met we cannot ensure a high quality CLI experience.
Download conEmu terminal.
If you use Windows Subsystem for Linux (WSL) or MinGW you can skip to Linux installation steps.
Alternatively if you use Windows Command Line follow the steps below and run the provided .bat.
Download Oracle Java 14 or OpenJDK 14.
Extract content from the zip folder to your preferred location, then go to Start>Edit the system environment variables>Environment Variables ...
In the User Section select Path variable and click on Edit; select New and type C:\Users\<your-user>\<path-to-extracted-folder>\bin, then save and exit.
Open Start>cmd.exe and verify your Java version by typing the following command:
java -version
Download Maven.
Extract to preferred location and repeat above steps.
Verify your Maven version by typing the following command:
mvn --version
If you want to download Maven and JavaJDK with your package manager be sure to fulfill the system requirements otherwise follow the next steps.
Download JavaJDK based on your distro or OpenJDK 14 here.
Linux Platforms
Navigate to your preferred install location and extract the .tar.gz archive file using:
tar zxvf jdk-14.<version-number>-x64_bin.tar.gz
Now let's set the PATH variable by typing the following code:
cd $HOME
nano .bashrc
Add the following line to the end of .bashrc:
export PATH=/<path-to-extracted-folder/bin:$PATH
Verify your Java version by typing the following command:
java -version
Debian-Based Linux Platforms
Type:
sudo apt install /path/to/package/name.deb
Verify your Java version by typing the following command:
java -version
RPM-Based Linux Platforms
Type the following command to install the package:
rpm -ivh jdk-14.<version-number>-x64_bin.rpm
Upgrade the package using the following command:
rpm -Uvh jdk-14.<version-number>-x64_bin.rpm
You can now delete the .rpm file and verify your installation by typing:
java -version
Download Maven, extract it with:
tar zxvf maven.<version-number>-x64_bin.tar.gz
Set PATH variable by appending this command to .bashrc as previous steps:
cd $HOME
nano .bashrc
export PATH=/<path-to-extracted-folder/bin:$PATH
Download JavaJDK 14, double-click on .dmg file and Install it.
Verify your Java version by typing the following command:
java -version
Follow Linux installation steps.