igneous

Igneous is an open source game engine written in C++.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

• CMake
• OpenAL Redistributable
• OpenAL SDK

Environment Variables

The install directory for the OpenAL SDK should be added as an environment variable named OPENALDIR in your system. This is not necessary, but is a safeguard in case CMake cannot find the install directory in one of the default search paths.

Checkout

git clone https://github.com/MissingBitStudios/igneous.git
cd igneous
git submodule update --init --recursive

Build

mkdir build
cd build
cmake ..
cmake --build .

Update

git pull
git submodule sync
git submodule update --init --recursive

Documentation

The API reference and tutorials are available on https://igneous.readthedocs.io

Built With

• Assimp - Website
• bgfx
• Bullet Physics - Website
• EnTT
• GLFW - Website
• GLM - Website
• Dear ImGui
• OpenAL
• RakNet - Website
• spdlog
• stb

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Changelog

All notable changes to this project will be documented in CHANGELOG.md. The changelog format is based on Keep a Changelog and adheres to Semantic Versioning.

Versioning

We use SemVer for versioning. For the versions available, see the releases page.

Authors

• widberg
• pcguy123

See also the list of contributors who participated in this project.

License

This project is licensed under the Creative Commons Attribution 4.0 International Public License (CC-BY-4.0) - see the LICENSE.md file for details.

Acknowledgements

• Thank you to the authors of the dependencies used.
• Thank you to the amazing teachers on YouTube: ThinMatrix, TheChernoProject, thebennybox, Code Rad, and Derek Banas.