Game Project - The PURGE

Keimyung University - Mobile Game Development - 2020 Fall Semester

This project is a video game for PC. See the Game Design Document for more details.

This repository contains the source code of the game and his engine.

Usage

$> ./tools/launch.sh -- --help
ThePURGE 0.3.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=data/    Path of the generated output.

Screenshots

Application version 0.2.12

Application version 0.1.9

Installing

Requirements

• Unix systems

  • g++>=10 || clang>=11
  • cmake>=3.13
  • python>=3.0

• Visual Studio Extension

  • Visual Studio 2019>=16.7
  • Linux CMake extension (see the documentation)
  • python>=3.0

The build require an internet connection (download of dependencies if missing).

You can use this command line.

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

# Cloning the repository
$> git clone git@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
  • cppcheck
  • clang-tidy

• Windows

  • VS cppcheck extension
  • VS conan extension
  • VS GLSL extension
  • VS clang-format extension

Build and Run

master (stable)
develop (latest)

• Unix systems

  # Generate the cmake project
  $> ./tools/generate.sh
  
  # Build all the target
  $> ./tools/build.sh
  
  # Run the executable
  $> ./tools/launch.sh

• Visual Studio

  See the Microsoft documentation for further details.

  1. Open the project folder with Visual Studio
  2. Project > Generate Cache for GameProject
  3. Build > Build All
  4. Select Startup Item > engine_main

Package Manager

conan - documentation

Testing

• CI

  1. Github
  2. Travis

• Unit tests

• Golden tests

• Formatting

Acknowledgement

• Jason Turner's Weekly Game Project

Initial Authors

• Mathieu LALA - github
• Benjamin PRAUD - github
• Yanis FOUREL - github
• Adil RAJABALY - github
• Pierre-Genest ESTRADE - github

License

This software is licensed under the ISC license see LICENSE for further details.