(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 most straightforward approach is to just clone this repo directly into your project:
git clone git@github.com:jakubtomsu/ravn.git
And then add ravn/ into your .gitignore files since it's a nested repo.
If you're on windows, you might not need to do any/most of this setup at all. But a complete setup looks like this:
- put
slang-compiler.dll/libslang.soin your project root dir - put
SDL3.dllin your project root dir - run
cloneandbuildscripts inravn/imgui/
Some people might prefer to use git subtrees instead of cloning. This is how to download the repo, and update to latest changes:
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