Skip to content

Urbanotopus/urbanotopus

Repository files navigation

logo

Build Status Build Status Documentation Status

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

Documentation

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