Rougelike Prototype

Based on: Bevy Template

Run your game

Running your game locally is very simple:

• Use cargo run to run a native dev build. If you're using VS Code, this template comes with a .vscode/tasks.json file.

Run release builds

• Use cargo run --profile release-native --no-default-features to run a native release build.

Linux dependencies

If you are using Linux, make sure you take a look at Bevy's Linux dependencies. Note that this template enables Wayland support, which requires additional dependencies as detailed in the link above. Wayland is activated by using the bevy/wayland feature in the Cargo.toml.

(Optional) Improve your compile times

.cargo/config_fast_builds.toml contains documentation on how to set up your environment to improve compile times. copy it to .cargo/config.toml to enable it for you, then adjust it (its gitignored).

Releases

The Game uses GitHub workflows to run tests and build releases. It requires setting a git tag with semantic versioning in order for the pipeline to run.

Development

To Activate Developer Tools see dev_tools.rs.

Known Issues

• You can increase the compilation speed by copying .cargo/config_fast_builds to .cargo/config and adjust it. This requires you to install some additional dependencies to your system.

License

The source code in this repository is licensed under the following licence:

• License

Credits

The assets in this repository are all 3rd-party. See the credits screen for more information.