Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/guillaume-haerinck/imac-tower-defense
OpenGl 4.4 game made with Entity Component System
https://github.com/guillaume-haerinck/imac-tower-defense
cpp design-pattern entity-component-system entt game-2d game-development noesis noesisgui opengl sdl2 tower-defense
Last synced: about 1 month ago
JSON representation
OpenGl 4.4 game made with Entity Component System
- Host: GitHub
- URL: https://github.com/guillaume-haerinck/imac-tower-defense
- Owner: guillaume-haerinck
- License: mit
- Created: 2019-03-13T14:13:33.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-12-10T03:05:58.000Z (about 1 year ago)
- Last Synced: 2023-12-11T03:23:26.607Z (about 1 year ago)
- Topics: cpp, design-pattern, entity-component-system, entt, game-2d, game-development, noesis, noesisgui, opengl, sdl2, tower-defense
- Language: C++
- Homepage:
- Size: 109 MB
- Stars: 41
- Watchers: 5
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- License: LICENSE
Awesome Lists containing this project
README
# Imac Tower Defense
An OpenGL 4.4 game made with Entity-Component-System design pattern. A gameplay video is [visible here](https://vimeo.com/892983458).
This is a student project for the French engineering school [IMAC](https://www.ingenieur-imac.fr/). If you're a french-speaker, you might consider to have a look at the [post-mortem](https://github.com/guillaume-haerinck/imac-tower-defense/blob/master/doc/rapport.md) (it has a lot of images) inside the `doc` folder.
## Table of Contents
[**Features**](#features)
[**Getting Started**](#getting-started)
* [**Prerequisites**](#prerequisites)
* [**Linux**](#linux)
* [**Windows**](#windows)
* [**Build**](#build)
* [**Launch**](#launch)
[**Documentation**](#documentation)
* [**Philosophy**](#philosophy)
* [**Folder structure**](#folder-structure)
**Additional info**
* [**Dependencies**](#dependencies)
* [**Inspired by**](#inspired-by)
## Getting Started
You can play the game directly if you download the [executable here](https://github.com/guillaume-haerinck/imac-tower-defense/releases/tag/1.0) (windows only).
### Prerequisites
You must install **[CMake](https://cmake.org/)** and a C++ compiler which handles **C++ 14**. More on the compiler on the next sections.
The project need your graphic card driver to be up to date, as it is using **OpenGL 4.4** core profile (released in 2013, so it should be fine).
#### Linux
The recommended compiler is g++, minimum version required is `g++ 6.1`, which is included by default on many linux distribution. You can update it with :
```bash
sudo apt-get install build-essential
```
You will also need the OpenGl and SDL2 packages.
```bash
sudo apt-get install libsdl2-dev
sudo apt-get install libglu1-mesa-dev mesa-common-dev
```
#### Windows
The recommended compiler is MSVC. To install it you will need [Visual Studio](https://visualstudio.microsoft.com/fr/) (which is not VSCode) and select the C++ development package during installation. The [MingW](http://www.mingw.org/) compiler will work as well if you prefer to use it.
### Build
The `CMakeLists.txt` file ensure that the project will work on Linux and Windows platforms.
You can build and launch the project in many different ways, we covered a few of them :
#### `Option 1: Bash (Linux only)`
Go to this folder with a terminal, and enter those commands.
```bash
cmake .
make
./bin/imac-tower-defense
```
It means that you are genererating a Makefile, then using it to build the project, and finally running the binaries from the current working directory (needed to find assets).
#### `Option 2: Visual Studio (Windows only)`
From Visual Studio 2017, you don't need to generate a visual studio project with cmake. You can simply open visual studio, browse the toolbar to *File->Open->Cmake...* and select the `CMakeLists.txt` at the root of this directory. From this point, you have to make sure that you are using a **x86 build configuration**, and running the **imac-tower-defense target**. If everything is done, simply press `f5` or click on the green arrow at the top.
If you add files, you will need to re-generate the cache for a successfull build. To do so, right click on `CMakeLists.txt` and use `Generate Cache for imac-tower-defense`
#### `Option 3: VSCode`
You will need the `CMakeTools` extension from vector-of-bools. If you want to change the source code, I highly recommend using the `C/C++` extension from Microsoft and the `CMake` extension from twxs.
From this point, when you will open the repository folder with VSCode, it will prompt you to configure the projet. You must select a x86 kit, for exemple the `Visual Studio Community 2017 - x86` kit. Once the configuration is done, you can compile the project by pressing `f7`. The .exe file will be outputed in `build/Debug` folder. You can launch it by pressing `f5`, but make sure to pick your operating system.
### Launch
Before launching the compiled binaries, **make sure that the working directory is set to this folder**, or the shaders files and images will not be found by the program. If you are unsure about how to do it, just copy the builded files to this folder before launching them. (by default, they will be in the `bin/Debug` folder).
## Documentation
### Philosophy
The project follows the **Entity Component System** design pattern. It has been made possible with the great [ENTT](https://github.com/skypjack/entt) library.
Our game is concieved as a state machine, and works like this architecture :
### Folder structure
| Folder | Description |
| ------------- | ----------------- |
| **src** | **Source code** |
| `main.cpp` | Entry point of the game |
| `components` | Struct of data for entities |
| `component-factories` | Creation of complex components |
| `entity-factories` | Classes used to build entities |
| `events` | Struct of data defining event types |
| `graphics` | Wrapper classes for OpenGL objects |
| `gui` | User interface logic |
| `logger` | Error and log handlers for the game |
| `services` | Functionalities needed anywhere, like playing a sound |
| `systems` | Update the game and the entities based on their components (all the game logic is there) |
| **core** | **Constants, Game state machine and map loading** |
| `game-states` | The different states of the game (title menu, in-level, game over, ...) |
| `level` | Read .ITD and .PPM files, and construct a graph from them |
| **res** | **Ressources loaded at runtime** |
| `audio` | Musics and sound effects used accross the game |
| `fonts` | Fonts used accross the game |
| `gui` | XAML files describing the view for each user interface |
| `images` | Images and spritesheets used by the game |
| `levels` | .ITD and .PPM describing the levels of the game |
| `shaders` | GLSL shaders used by openGL for rendering |
| **doc** | **Documentation** |
| **lib** | **Dependencies** |
## Dependencies
- [OpenGL](http://docs.gl/) - The graphic API used
- [GLM](https://glm.g-truc.net/) - The opengl maths library
- [SDL2](https://wiki.libsdl.org/) - The library used to create a valid OpenGl context
- [ENTT](https://github.com/skypjack/entt) - The ECS framework
- [SPDLog](https://github.com/gabime/spdlog) - Logging lib
- [NeosisGUI](https://www.noesisengine.com/) - GUI WPF lib for end users
- [Imgui](https://github.com/ocornut/imgui) - Immediate mode GUI lib for debugging
- [Debugbreak](https://github.com/scottt/debugbreak) - Cross-platform code breakpoint header
- [StbImage](https://github.com/nothings/stb) - Load images
- [FMOD](https://www.fmod.com/) - Load and play adaptative audio
- [Box2D](https://box2d.org/) - 2D Physics library
## Useful articles
- [Awesome Opengl](https://github.com/eug/awesome-opengl) - A list of useful tools for OpenGl
- [Awesome Readme](https://github.com/matiassingers/awesome-readme) - A list of great readme files
- [Pathfinding](https://www.redblobgames.com/pathfinding/tower-defense/) - Red blob games's article on pathfinding
## Inspired by
- [tddod](https://github.com/Daivuk/tddod) - Data oriented tower defense using ENTT library
- [Unity tower defense template](https://unity3d.com/learn/tutorials/s/tower-defense-template) - Tower defense game made with Unity engine
- [Unreal engine tower defense template](https://docs.unrealengine.com/en-us/Resources/SampleGames/StrategyGame) - Tower defense game made with Unreal Engine
- [RayWenderlich TD](https://www.raywenderlich.com/2709-how-to-make-a-tower-defense-game-tutorial) - Tower defense game made in Objective C
- [ENTT Pacman](https://github.com/Kerndog73/EnTT-Pacman) - Pacman game using ENTT library
## Authors
- **Jules Fouchy** - Processing star
- **Cyrielle Lassarre** - Designer of the worlds
- **Guillaume Haerinck** - Coding maniac