Skip to content
r5nePublic

About

An interactive, hand-drawn pixel art atlas.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

339 Commits

Folders and files

Repository files navigation

Faerite

Faerite banner GitHub Actions workflow status GitHub Actions workflow status

An interactive, hand-drawn pixel art atlas.

Installation

v0.0.5+

Faerite can be downloaded straight from the releases tab. Simply extract the downloaded zip for the corresponding operating system. You will find the executable inside (or in the /bin folder on linux).

Faerite can also be downloaded and ran directly from the terminal which some may find more convenient.

Important

Replace the LATEST x.x.x variable used in all the commands with the latest version number e.g. 0.0.5.

On Linux
LATEST="x.x.x" && wget -N "https://github.com/r5ne/faerite/releases/download/v$LATEST/faerite-$LATEST-linux.zip" && unzip -o "faerite-$LATEST-linux.zip" && ./Faerite/bin/Faerite
On Windows

Using Powershell:

$LATEST="x.x.x"; Invoke-WebRequest -Uri "https://github.com/r5ne/faerite/releases/download/v$LATEST/faerite-$LATEST-windows.zip" -OutFile "faerite-$LATEST-windows.zip"; Expand-Archive -Path "faerite-$LATEST-windows.zip" -DestinationPath "." -Force; .\Faerite\Faerite.exe

Using Command Prompt:

Note

Since variables cannot be set and used in the same line you must first set the LATEST variable in a separate line.

set LATEST=x.x.x
curl -LO "https://github.com/r5ne/faerite/releases/download/v%LATEST%/faerite-%LATEST%-windows.zip" && tar -xf "faerite-%LATEST%-windows.zip" && .\Faerite\Faerite.exe

v0.0.1 - v0.0.4:

# Using Java 25+.
# Note that v0.0.1 - v0.0.3 are only compiled for Linux as indicated by the filename.
java -jar faerite-[version number].jar

Compiling from source

Requirements:

  • Faerite v0.0.5+
  • openjdk 25.0.4+
  • Apache Maven 3.9.16+
  • Git v1.8.2+
  • Git LFS v3.7.1+

Faerite can be downloaded, compiled and ran all from the terminal using the following commands.

Important

Replace the LATEST x.x.x variable used in all of the commands with the latest version number e.g. 0.0.5.

On Linux
VERSION="x.x.x" && git clone --depth 1 --branch "v$VERSION" https://github.com/r5ne/faerite && cd faerite && mvn clean compile javafx:jlink && jpackage --type app-image --runtime-image target/image --name Faerite --module faerite/faerite.Main --dest out && out/Faerite/bin/Faerite
On Windows

Using Powershell:

$LATEST="x.x.x"; git clone --depth 1 --branch "v$VERSION" https://github.com/r5ne/faerite; cd faerite; mvn clean compile javafx:jlink; jpackage --type app-image --runtime-image target\image --name Faerite --module faerite\faerite.Main --dest out; .\Faerite\Faerite.exe

Using Command Prompt:

Note

Since variables cannot be set and used in the same line you must first set the LATEST variable in a separate line.

set LATEST=x.x.x
git clone --depth 1 --branch "v$VERSION" https://github.com/r5ne/faerite && cd faerite && mvn clean compile javafx:jlink && jpackage --type app-image --runtime-image target\image --name Faerite --module faerite\faerite.Main --dest out && out\Faerite\Faerite.exe

Licence

Faerite is licenced under the MIT Licence.

Credits

  • Wikidata API for providing data for most of the program's statistics.
  • MAPresso for Köppen-Geiger climate classifications and their descriptions.

Special Thanks

About

An interactive, hand-drawn pixel art atlas.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Contributors

Languages