In order to quickly run the game, there are binaries available for OSX, Windows, and Linux under this repository's releases.
To run the game from the binaries, simply download either osx.dmg, windows.zip, or linux.tgz and extract it somewhere. Open the main folder
in the extracted folder, and run the main executable. Note that the windows version of this release differs slightly in the OSX version,
where the fonts are not 1:1 match to that of the OSX executable and may have some minor graphical defects. The linux build was created with a Manjaro VDE!
In order to run the game from the source code, you'll need to start by downloading and installing Racket here.
Once Racket is installed, you can launch DrRacket which an IDE for developing programs in Racket. This project relies on two third party packages that you can install directly from DrRacket.
To install the packages, you'll need to go to File > Install Package, then you can paste into a git URL to the package you want to install.
You will need to install two packages:
These packages are jpverkamp's implementation of prototype system and simplex/perlin noise. Once those packages are installed, you're ready to run the game or hack on the repository some more. To gain a better understanding of what the code is doing, feel free to check out jpverkamp's wonderful tutorial on writing a roguelike in racket, where most of my code base comes from.
To run the game, open src/main.rkt in DrRacket and run the file.