https://github.com/MissingBitStudios/igneous

Igneous is an open source game engine written in C++.
https://github.com/MissingBitStudios/igneous

assimp bgfx bullet-physics cmake cpp directx entt game-development game-engine glfw glm imgui linux macos metal openal opengl raknet windows

Last synced: 17 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/MissingBitStudios/igneous
• Owner: MissingBitStudios
• License: cc-by-4.0
• Created: 2018-11-23T02:50:42.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2020-10-03T01:56:19.000Z (over 4 years ago)
• Last Synced: 2024-11-14T22:35:02.243Z (6 months ago)
• Topics: assimp, bgfx, bullet-physics, cmake, cpp, directx, entt, game-development, game-engine, glfw, glm, imgui, linux, macos, metal, openal, opengl, raknet, windows
• Language: C++
• Size: 78.7 MB
• Stars: 49
• Watchers: 6
• Forks: 8
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

• AwesomeCppGameDev - igneous

README

        
# igneous

[![GitHub tag](https://img.shields.io/github/tag/MissingBitStudios/igneous.svg)](https://github.com/MissingBitStudios/igneous/releases)

[![Build Status](https://travis-ci.org/MissingBitStudios/igneous.svg?branch=master)](https://travis-ci.org/MissingBitStudios/igneous)

[![Documentation Status](https://readthedocs.org/projects/igneous/badge/?version=latest)](https://igneous.readthedocs.io/en/latest/?badge=latest)

[![Join the chat at https://discord.gg/CCUwTar](https://img.shields.io/badge/chat-on_discord-7389D8.svg?logo=discord&logoColor=ffffff&labelColor=6A7EC2)](https://discord.gg/CCUwTar)

[![Join the chat at https://www.reddit.com/r/igneous/](https://img.shields.io/badge/chat-on_reddit-FF5700.svg?logo=reddit&logoColor=ffffff&labelColor=FF4500)](https://www.reddit.com/r/igneous/)

[![Track on https://trello.com/b/05omR9Mj/igneous](https://img.shields.io/badge/track-on_trello-007BC2.svg?logo=trello&logoColor=ffffff&labelColor=026AA7)](https://trello.com/b/05omR9Mj/igneous)

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

![Barn](docs/source/img/barn.png)

## 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

```sh

git clone https://github.com/MissingBitStudios/igneous.git

cd igneous

git submodule update --init --recursive

```

### Build

```sh

mkdir build

cd build

cmake ..

cmake --build .

```

### Update

```sh

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](https://github.com/assimp/assimp) - [Website](http://assimp.sourceforge.net/)

* [bgfx](https://github.com/bkaradzic/bgfx)

* [Bullet Physics](https://github.com/bulletphysics/bullet3) - [Website](http://bulletphysics.org/)

* [EnTT](https://github.com/skypjack/entt)

* [GLFW](https://github.com/glfw/glfw) - [Website](http://www.glfw.org/)

* [GLM](https://github.com/g-truc/glm) - [Website](https://glm.g-truc.net/)

* [Dear ImGui](https://github.com/ocornut/imgui)

* [OpenAL](https://www.openal.org/)

* [RakNet](https://github.com/facebookarchive/RakNet) - [Website](http://www.raknet.net/)

* [spdlog](https://github.com/gabime/spdlog)

* [stb](https://github.com/nothings/stb)

## Contributing

Please read [CONTRIBUTING.md](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](CHANGELOG.md). The changelog format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## Versioning

We use [SemVer](http://semver.org/spec/v2.0.0.html) for versioning. For the versions available, see the [releases page](https://github.com/MissingBitStudios/igneous/releases). 

## Authors

* [widberg](https://github.com/widberg)

* [pcguy123](https://github.com/pcguy123)

See also the list of [contributors](https://github.com/MissingBitStudios/igneous/graphs/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](LICENSE.md) file for details.

## Acknowledgements

* Thank you to the authors of the dependencies used.

* Thank you to the amazing teachers on YouTube: [ThinMatrix](https://www.youtube.com/user/ThinMatrix), [TheChernoProject](https://www.youtube.com/user/TheChernoProject), [thebennybox](https://www.youtube.com/user/thebennybox), [Code Rad](https://www.youtube.com/user/YouKondziu), and [Derek Banas](https://www.youtube.com/user/derekbanas).