Urbanotopus / urbanotopus

Game sources and documentation for Urbanotopus (University Assignment).

Urbanotopus Game and Docs

Game sources and documentation for Urbanotopus.

Note: this project requires Unity 2018.2.14f1 for Windows | MacOS | Others.

Download links

You will find the latest download link here (for Windows, Linux, Mac, Android and iOS). And a browser demo (WebGL) here.

Other links

• Our specs sheets;
• Our task dashboard.

Documentation

• Le jeu
  • Le fonctionnement
  • Le déroulement d’une partie
• Conventions du projet
  • La répartition des tâches
• Guides de contribution
  • EditorConfig
  • Style de codage
  • Convention de nommage
  • Contribuer au code
  • Documenter le code source
  • Documenter le projet et fonctionnalités
• Guides de développement
  • Scènes de Visual Novel
  • Gestion des décisions
  • Charger des scènes
• Ressources

How to build the docs

Hand written documentation (sphinx)

Installation of the requirements

1. Install Python 3.7;
2. Create and activate a python virtual environment;
3. Install the requirements through pip install -r requirements.txt;
4. (Optional) Edit the files under the docs folder;

Building the sphinx documentation

1. Build or rebuild the docs by running make html in the root project directory;
2. Open your web-browser to build/html/index.html.

Source code documentation (doxygen)

Installation of the requirements

Install doxygen through this link or using your preferred Unix package manager.

Generating the doxygen documentation

1. Build or rebuild by running doxygen in the root project directory.
2. Open your web-browser to html/index.html.

Resources

• How to document a project using Sphinx;
• How to use the venv Python module to create and manage virtual environments.
• Appveyor CI documentation to build the project on Windows;
• Travis CI documentation to build the project on Linux and Mac OS.