A WIP game where you climb.
See below for build/run instructions, and see the checklist script for how to get started modifying a copy of the template to suit your needs.
-
Install Rust via rustup.rs.
-
Install WebAssembly target:
rustup target add wasm32-unknown-unknown
- Start dev server:
cargo run-wasm peak --release
- Visit
http://localhost:8000with your browser.
These extra features can be adding then to the run-wasm features flag. Note that these are comma separated. For instance to activate invariant-checking and logging you can run:
cargo run-wasm peak --release --features invariant-checking,logging
The desktop version attempts to be cross platform. Only Linux and Windows have been tested at this time.
-
Install Rust via rustup.rs.
-
Build via cargo
cargo build --release --bin peak
- Run the executable
./target/release/peak
When building the Linux version, some additional packages may be needed to support building the alsa library this program uses for sound, on Linux.
On Ubuntu, these packages can be installed as follows:
sudo apt install libasound2-dev pkg-config
If you don't care about sound you can build with the enabled-by-default "non-web-sound" feature flag turned off:
cargo build --release --bin peak --no-default-features
As of this writing, a library that this program uses does not allow specifying that parts of the screen need to be redrawn, on Wayland.
For now, you can run the executable with the WINIT_UNIX_BACKEND environment variable set to "x11" as a workaround.
WINIT_UNIX_BACKEND="x11" ./target/release/peak
With this enabled violations of certain invariants will result in a panic. These checks are disabled in default mode since (presumably) a player would prefer the game doing something weird to outright crashing.
Enables additional generic logging. With this feature disabled, the logs will be compiled out, leaving no appreciable run-time overhead.
Enables sound when not building for the web. On by default.
licensed under Apache or MIT, at your option.