diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 47 |
1 files changed, 45 insertions, 2 deletions
@@ -1,6 +1,49 @@ -# Project Title +# DungeonCrawl -Team members: +A rust Dungeon Crawler! + +## Requirements + +DungeonCrawl builds raylib into the binary, and thus needs the build tools needed for raylib. + +1. Rust version 1.88.0 +2. CMake +3. Clang (must set LIGCLANG\_PATH) +4. GLFW or SDL2 (see features) +5. X11 or Wayland (linux only, see features) +6. Pulseaudio and alsa (linux only) + +## Build (Desktop) + +To build for desktop run the following. The binary will be located in `target/release/game`. + +``` +cargo build --release --path game +``` + +## Build (Web) + +Web builds require the [emscripten](https://emscripten.org/docs/getting_started/downloads.html) toolchain. + +Download that, and make sure its added into your path, and the `EMSDK` env variable is set. If you use the SDK and `source ./emsdk_env.sh` like the recommended installation instructions state, this should already be done for you. + +To build for web, invoke the makefile. The output website will be in `dist`. + +``` +make web +``` + +## Features + +`x11` (default) - Enables X11 protocol support (linux only). + +`wayland` - Enables wayland support (linux only). + +`sdl` - Uses SDL2 instead of GLFW. GLFW is used if this feature is not set. + +`static` - Includes the audio and images files statically in the binary. This is ignored for wasm builds. + +## Contributors - Freya Murphy <freya@freyacat.org> - Audrey Fuller <alf9310@rit.edu> |