Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mathieu-lala/game_project
Game Project : The PURGE ~ Keimyung University ~ Fall 2020
https://github.com/mathieu-lala/game_project
cmake conan cpp cpp17 cpp20 entt game-development glfw3 imgui opengl
Last synced: 3 months ago
JSON representation
Game Project : The PURGE ~ Keimyung University ~ Fall 2020
- Host: GitHub
- URL: https://github.com/mathieu-lala/game_project
- Owner: Mathieu-Lala
- License: isc
- Archived: true
- Created: 2020-09-05T07:54:34.000Z (over 4 years ago)
- Default Branch: develop
- Last Pushed: 2020-12-19T09:01:20.000Z (about 4 years ago)
- Last Synced: 2024-09-26T06:42:38.084Z (3 months ago)
- Topics: cmake, conan, cpp, cpp17, cpp20, entt, game-development, glfw3, imgui, opengl
- Language: C++
- Homepage:
- Size: 87.3 MB
- Stars: 6
- Watchers: 4
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Game Project - The PURGE
[](https://github.com/Mathieu-Lala/game_project/graphs/commit-activity)
[](https://github.com/Mathieu-Lala/game_project/releases/)
Keimyung University - Mobile Game Development - 2020 Fall Semester
This project is a video game for PC. See the [Game Design Document](doc/ThePURGE_GameDesignDocument.pdf) for more details.
This repository contains the source code of the [game](src/Application) and his [engine](src/Engine).
## Usage
```sh
$> ./tools/launch.sh -- --help
ThePURGE 0.4.0
Usage: ./engine_main [OPTIONS]
Options:
-h,--help Print this help message and exit
--version Print the version number and exit.
--config=data/config/app.ini Read an ini file
--fullscreen BOOLEAN=1 Launch the window in fullscreen mode.
--window-width UINT=1024 Width of the window.
--window-height UINT=768 Height of the window.
--replay-path TEXT Path of the events to replay.
--replay-data TEXT Json events to replay.
--data TEXT=data/ Path of the data folder.
--output-folder TEXT=../generated/ Path of the generated output.
```
## What it looks like
See [the trailer](https://www.youtube.com/watch?v=GQxOHtLU4U0) of the game on youtube !
See [older version](./doc/history) of the project.
## Installing
### Requirements
* All platforms
* python>=3.0
* Unix systems
* g++>=10 || clang>=11
* cmake>=3.13
* Windows
* Visual Studio 2019>=16.7 && Linux CMake extension (see [the documentation](https://docs.microsoft.com/en-us/cpp/linux/cmake-linux-configure?view=vs-2019))
### Command line
You can use this command line.
```sh
# Shortcut command
$> sh -c "$(curl -fsSL https://raw.githubusercontent.com/Mathieu-Lala/game_project/develop/tools/install.sh)"
# Or
$> sh -c "$(wget -O- https://raw.githubusercontent.com/Mathieu-Lala/game_project/develop/tools/install.sh)"
```
Or clone and inspect the install script.
```sh
# Cloning the repository
$> git clone https://github.com/Mathieu-Lala/game_project.git
# Go in the project
$> cd game_project
# Installing the required environment (partial)
$> ./tools/install.sh --no-clone
```
### Recommended environment
* Unix systems
* [ccache](https://ccache.dev/)
* [cppcheck](http://cppcheck.sourceforge.net/)
* [clang-tidy](https://clang.llvm.org/extra/clang-tidy/)
* Windows
* [VS cppcheck extension](https://marketplace.visualstudio.com/items?itemName=Alexium.Cppcheckadd-in)
* [VS conan extension](https://marketplace.visualstudio.com/items?itemName=conan-io.conan-vs-extension)
* [VS GLSL extension](https://marketplace.visualstudio.com/items?itemName=DanielScherzer.GLSL)
* [VS clang-format extension](https://marketplace.visualstudio.com/items?itemName=xaver.clang-format)
## Build and Run
master (stable)
develop (latest)
The build **require** an internet connection (download of dependencies if missing).
* Unix systems
```sh
# See the --help message
# Generate the cmake project
$> ./tools/generate.sh
# Build the target
$> ./tools/build.sh
# Run the executable
$> ./tools/launch.sh
```
* Visual Studio
See [the documentation](https://docs.microsoft.com/en-us/cpp/build/cmake-projects-in-visual-studio?view=msvc-160) for further details.
1. Open the project folder with Visual Studio
1. Project > Generate Cache for GameProject
1. Build > Build All
1. Select Startup Item > engine_main
### Package Manager
[Conan](https://conan.io/) is used for this project, see [the documentation](https://docs.conan.io/en/1.31/)
The dependencies used :
## Debugging
When implementing a new feature (or just by curiousity), you might want to see what is happening behind the scene.
With a debug build you have access to extra information such as the hitbox, a console (with cheat codes), opengl rendering options ...
## Testing
[](https://codecov.io/gh/Mathieu-Lala/game_project)
* [CI](https://en.wikipedia.org/wiki/Continuous_integration)
1. [Github](https://github.com/Mathieu-Lala/game_project/actions)
1. [Travis](https://travis-ci.com)
* [Unit tests](https://en.wikipedia.org/wiki/Unit_testing)
* [Golden tests](https://en.wikipedia.org/wiki/Software_testing#Output_comparison_testing)
* [Formatting](https://en.wikipedia.org/wiki/Programming_style)
## Acknowledgement
* Jason Turner's [Weekly Game Project](https://github.com/lefticus/cpp_weekly_game_project)
* [learnopengl.com](http://learnopengl.com)
## Initial Authors
* Mathieu LALA - [github](https://github.com/Mathieu-Lala)
* Benjamin PRAUD - [github](https://github.com/BenjaminPraud)
* Yanis FOUREL - [github](https://github.com/Yanis-F)
* Adil RAJABALY - [github](https://github.com/ADeal24)
* Pierre-Genest ESTRADE - [github](https://github.com/Pierre-Genest)
## License
This software is licensed under the ISC license see [LICENSE](/LICENSE) for further details.