Raylib Template

A template repo for raylib-rs projects.

You will need raylib installed:

brew install raylib

And you will need Emscripten installed for web builds:

brew install emscripten

Or...

brew install just
just setup

just

Important

Cross-compilation is achieved using cross alongside custom Docker images. You will need Docker installed and running in order to cross-compile.

Setting Up

1. Clone this repository

   git clone --depth=1 https://github.com/snailcreature/raylib_template.git <your project name>

2. Point it at your remote repository¹

   git remote set-url origin <your repo url>

3. Update Cargo.toml with your project details
4. Update project_identifier in the justfile (unless you are me)
5. Ensure just is installed and run the setup command

   just setup

Tip

Run

PROJ=<your_project_name>

then

git clone --depth=1 https://github.com/snailcreature/raylib_template.git $PROJ
cd ./$PROJ
just setup

Inclusions

This template includes a handful of data structures and programming patterns implemented for ease of use:

1. Ecstasy - an ECS implementation (see also: Ecstatic)
2. Cacao - a very basic events system with observers and commands
3. Quartermaster - an asset manager with automatic memory management
4. Ringo - a pseudorandom number generator
5. rlimgui - DearIMGUI compatibility layer
6. platform_compat - Compatibility layer to ensure asset paths work across platforms

Documentation

Check the docs folder for documentation on the various elements of this project

Related Projects

• raylib - [https://github.com/raysan5/raylib]
• sola-raylib
• raylib-rs

Disclaimer

No AI was knowingly used in the research or creation of this project.

---

References

Footnotes

1. Answer to "How to properly fork a local git repository?"; CodeWizard - https://stackoverflow.com/a/58113672 ↩