Skip to content
This repository was archived by the owner on Dec 19, 2022. It is now read-only.
Olaf Szmidt edited this page Dec 21, 2017 · 8 revisions

Last Update: 21/12/2017

For a general description of the game, instructions on how to setup the repository and a general overview of the file structure, please refer to the README.

Overview

This wiki holds information about the general ideas behind this project, which are hard to explain through the comments in the files.

Terminology

Throughout the code base, the following terms are often used:

  • Map feature: For now we have obstacles, health points, score points and pickups. They can only be created or deleted.
  • Player / avatar: The only objects that move, representing each user. They can also be updated.
  • Controller: A script that is attached to a game object to make it move.
  • Manager: A manager is responsible to interact with the scene by instantiating and removing game objects.
  • Generator: A generator is a mirror of a manager in the level builder.

To contributors

Do you want to help us develop this repository? We suggest checking our issues page to see what things need to be worked on. We recommend connecting this repo to ZenHub. Use the milestone filter to check what the newest sprint of the repository is and all the issues that are being worked on are there.

Feel free to contact one of the write access contributors as we will be all very happy to help.

After modifying major parts in the logic, you should document them in this wiki. If a specific feature is not yet merged please specify the branch and pull request inside the wiki page and reference the wiki page in the pull request.

Thank you for your work!

Clone this wiki locally