Rust game template

Starter project with build tooling and current architecture best practices to be used as base for Rust game projects.

Contents based on the TCOD Roguelike Tutorial.

The WASM build should be playable in browser at https://rsaarelm.github.io/rust-game-template/.

Instructions

Install the Rust compiler toolchain and call rustup install to install the compiler.

Build and run the desktop GUI version:

cargo --release run

Build and run the TTY terminal version:

cargo --release --no-default-features --features=tty run

If you're using NixOS, you can run nix develop in the project directory to enter a development shell and then call just run or just run-tty.

Features

• Uses navni to allow compiling for either into a GUI application or a terminal textmode application.

• Uses miniquad for GUI and WASM builds.

• A WASM build is automatically built and deployed using Github actions.

• Uses hecs as entity-component-system for storing runtime entities.

• Uses IDM for data files.

• Automatically detects Colemak and Dvorak keyboard layouts and reconfigures movement keys accordingly.