Road Fighter

Freek De Sagher
s0171876                 Travis CI:

---

Regels

Het doel van het spel is om zo snel mogelijk de finish te bereiken. Op de weg daarheen racen er 5 andere racewagens met je mee. Omdat er geracet wordt op de gewone weg, zijn er ook wagens die vanuit de andere richting komen. Deze racen niet mee, maar worden best ontweken om te vermijden dat het uw voertuig crasht.
In Road Fighter is het ook mogelijk om te schieten. Indien een voorbijrijdende auto geraakt wordt, dan zal deze crashen, is een race auto het slachtoffer, dan zal deze trager rijden.

Punten worden verdient door gewoon te rijden of door kogels raak te schieten. Op het einde worden bij de score van op de baan nog de punten van het 'klassement' geteld. Iemand die op de eerste plaats finisht zal meer punten extra krijgen dan iemand die laatst finisht. De scores van de vijf beste spelers worden bijgehouden op een scorebord.

Controls

Player movement:

Action	Key
accelerate	SPACE
move up	ARROW UP
move down	ARROW DOWN
move left	ARROW LEFT
move right	ARROW RIGHT
shoot	X

Player controls zijn gemakkelijk aanpasbaar in deze source file met behulp van de functie

void initializeKeymap();

General controls:

Action	Key
exit game at any time	ESC
proceed when game finished	ENTER

Project Structure

Dit project is verdeeld in meerdere subfolders:

1. De map cmake:
   • Modules
     • FindSFML.cmake: bestand gebruikt om te zoeken naar SFML op het systeem.
2. De map gll (= Game Logic Library) bevat de logica voor de game en is onderverdeeld als volgt:
   • De include map:
     • GLL: bevat alle headers gebruikt voor de game logic.
     • lib: bevat de headers van de gebruikte externe libraries.
       Voor dit project is de mINI library gebruikt. Dit is een parser voor .ini bestanden. Een .ini bestand wordt gebruikt om de scores in op te slaan.
   • De src map: deze bevat alle gebruikte source files voor de Game Logic.
   • CMakeListst.txt om de Game Logic te builden.
3. De map SFMLgame bevat de sources voor een uitvoerbare versie van de game en is onderverdeeld als volgt:
   • De include map bevat alle headers die nodig zijn voor de SFML implementatie.
   • De res map bevat alle resources (afbeeldingen, score file) van de game.
   • De src map bevat alle source files die nodig zijn voor de SFML implementatie.
   • CMakeLists.txt om de executable te builden.
   • main.cpp de main file van de executable.
4. De map tests bevat alle tests die gebaseerd zijn op het Googletest Framework
   • De include map bevat alle headers voor de tests.
   • De src map bevat alle source files van de tests.
   • CMakeLists.txt om de tests te builden.
   • CMakeLists.txt.in wordt in CMakeLists.txt gebruikt om googletest te linken aan het project.
   • main.cpp de main voor de tests.
5. Overige bestanden:
   • .gitignore
   • .travis.yml
   • CMakeLists.txt de root CMakeLists van dit project.
   • Readme.md: deze readme file.

Documentatie

De volledige documentatie bevindt zich hier en is gegenereerd aan de hand van Doxygen.

De bestanden van deze documentatie zijn terug te vinden in de aparte branch gh-pages

Extensies

Het programma kan gerund worden met enkele programma argumenten:

• -windowed: het spel start niet fullscreen, maar in een venster
• -reset-scores: deze optie reset de high scores naar de oorspronkelijke waarden.
• -debug: run het spel in debug modus. In debug modus zullen de colliders zichtbaar worden en zal het minder lang duren om de finish te bereiken.