Repository files navigation

PyUnity is a pure Python 3D Game Engine thatwas inspired by the structure of the UnityGame Engine. It aims to be as close as possibleto Unity itself. This does not mean that PyUnityare bindings for the UnityEngine. However,this project has been made to facilitateany programmer, beginner or advanced, noviceor veteran.

As we have said above, this is not a set ofbindings for the UnityEngine, but a purePython library to aid in making 3D games inPython.

To install PyUnity for Linux distributionsbased on Ubuntu or Debian, use:

> pip3 install pyunity

To install PyUnity for other operating systems,use:

> pip install pyunity

Alternatively, you can clone the repositoryto build the package from source. The lateststable version is on the master branch andyou can build as follows:

> git clone https://github.com/pyunity/pyunity> git checkout master> pip install .

The latest unstable version is on thedevelopbranch which is the default branch. These builds aresometimes broken, so use at your own risk.

> git clone https://github.com/pyunity/pyunity> pip install .

Its only dependencies are PyOpenGL, PySDL2,Pillow and PyGLM. Microsoft VisualC++ Build Tools are required on Windowsfor building yourself, but it can be disabled bysetting thecython environment variable to0, at the cost of being less optimized.GLFW can be optionally installed if you wouldlike to use the GLFW window provider.

For more information check outthe API documentation.There we offer some tutorials on the basics ofPyUnity, as well as all modules and utility functionsthat come with it. Examples are located at subfolders inpyunity/examplesso do be sure to check them out as a starting point.

If you would like to contribute, pleasefirst see thecontributing guidelines,check out the latestissuesand then make apull request.