summaryrefslogtreecommitdiff
path: root/README.md
blob: 32d90f62b322f8f1d38771efbee6d6385aea16cb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
# DungeonCrawl

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>
- Yusif Elsharawy <yse2561@rit.edu>
- Ryan Symons <ras1178@rit.edu>