(read as raven)
RAVN is a collection of lightweight libraries for game and engine development in Odin.
Warning
EARLY ALPHA VERSION: Not stable yet. Expect major breaking changes.
See Cheatsheet for quick API overview.
Install Odin and make sure it's in your path. Check the Official Install docs for more info. The main RAVN branch should always compile on the latest Odin master branch.
The recommended approach is using git subtrees, a nicer alternative to submodules or manual copy-pasting.
Here are the commands to clone the library into your project, and to pull the latest upstream changes. It will appear just as a regular directory.
git subtree add --prefix=ravn https://github.com/jakubtomsu/ravn main --squash
git subtree pull --prefix=ravn https://github.com/jakubtomsu/ravn main --squash
You can run demos from the examples/ directory with something like the following command:
odin run examples\triangle
Most wanted type of contributions is bugfixes. Both Issues and PRs are acceptable.
Please include odin report output and a code sample to reproduce the issue if applicable.
If you want a new feature, it is recommended to discuss it on Discord first.
- Keep things simple
- Ensure coherency with the rest of the code
- Use the default Odin naming conventions