===================================
Welcome to PyUnity's documentation!
===================================

Version 0.6.0 (in development)
------------------------------
PyUnity is a Python implementation of the
Unity Engine, written in C++. This is just
a fun project and many features have been
taken out to make it as easy as possible
to create a scene and run it.

Installing
----------
To install PyUnity for Linux distributions
based on Ubuntu or Debian, use::

    > pip3 install pyunity

To install PyUnity for other operating systems,
use pip::

    > pip install pyunity

Alternatively, you can clone the repository
`here <https://github.com/rayzchen/pyunity>`_
to build the package from source. Then use
``setup.py`` to build. Note that it will install
Cython to compile.

    > python setup.py install

Its only dependencies are PyOpenGL, PySDL2,
GLFW, Pillow and PyGLM.

For more information check out :doc:`the API Documentation <api>` 

.. toctree::
   :maxdepth: 1
   :caption: Contents:

   releases
   tutorials
   links
   license
   api


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`