diff --git a/README.md b/README.md index b6bf6dc..1e80456 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,27 @@ # Tourmaline Engine - Tormaline Engine is a game engine created for game development with C++23. -A lot of the info regarding Tourmaline has been removed from here. This is due to project still being in early phases of development. +### Currently the project is still trying to incorporate following parts (in no particular order): +- [ ] ECS (Builtin) +- [X] Logging (Builtin) +- [X] Random Generation (Builtin) +- [ ] Graphics (Magnum Graphics) +- [ ] Physics Integration (ReactPhysics3D) +- [ ] Audio (miniaudio) +- [ ] Particles (Builtin) +- [ ] Asset Archiving (Searching for a library) +- [ ] UI (Magnum UI) +- [ ] Shaders (Builtin) -# 3rd Party Used Libraries Credits +# Usability Status +Tourmaline is by no means currently usable. The project is incredible volatile with constant changes and improvements. Please wait until a release is made. + +# 3rd Party Libraries Credits - [Corrade/Magnum](https://magnum.graphics/) - graphics middleware by Vladimír "Mosra" Vondruš. - [miniaudio](https://miniaud.io/) - audio playback and capture library by David "Mackron" Reid. - [Xohiro](https://github.com/david-cortes/xoshiro_cpp/blob/master/xoshiro.h) implementation by David Blackman and Sebastiano Vigna -# Special Thanks to +# Special Thanks - [Lars "harmonyisdead"](https://github.com/larsl2005) for hosting the thenight.club services. - [Vladimír "Mosra" Vondruš](https://github.com/mosra) for their mentorship of my C++ knowledge/projects, and the people at the [magnum gitter channel](https://matrix.to/#/#mosra_magnum:gitter.im), for their continous support and feedback of this project. - [Kae "voxelfoxkae"](https://voxelfox.co.uk/) for getting me into programming seriously and mentorship. @@ -17,6 +29,9 @@ A lot of the info regarding Tourmaline has been removed from here. This is due t # Not-so frequently asked questions +### Version Scheming +Tourmaline uses a single digit that ticks up by 1 for each version. There are no major or minor updates or versions. The project can be seen as a rolling release project. + ### What is Tourmaline and Why is that the name? From [Wikipedia](https://en.wikipedia.org/wiki/Tourmaline) > Tourmaline is a crystalline silicate mineral group in which boron is compounded with elements such as aluminium, iron, magnesium, sodium, lithium, or potassium.