PyUnity
Version 0.7.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 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.
Importing
To start using pyunity, you must import it. A standard way to import is like so:
>>> from pyunity import *
Debug information is turned on by default. If you want to turn it off, set the PYUNITY_DEBUG_MODE environment variable to "0". This is the output with debugging:
Loaded config
Trying GLFW as a window provider
GLFW doesn't work, trying PySDL2
Using window provider PySDL2
Loaded PyUnity version 0.7.0
If debugging is off, there is no output:
>>> import os
>>> os.environ["PYUNITY_DEBUG_MODE"] = "0"
>>> from pyunity import *
>>> # No output
Scenes
All PyUnity projects start with a scene. To add a scene, do this:
>>> scene = SceneManager.AddScene("Scene 1")
Then, let's move the camera backwards 10 units.
>>> scene.mainCamera.transform.position = Vector3(0, 0, -10)
Finally, add a cube at the origin:
>>> cube = GameObject("Cube")
>>> renderer = cube.AddComponent(MeshRenderer)
>>> renderer.mesh = Mesh.cube(2)
>>> renderer.mat = Material(Color(255, 0, 0))
>>> scene.Add(cube)
To see what you have added to the scene, call scene.List():
>>> scene.List()
/Main Camera
/Light
/Cube
Finally, to run the scene, call scene.Run(). The window that is created is one of FreeGLUT, GLFW or PySDL2. The window is selected on module initialization (see Windows subheading).
Behaviours
To create your own PyUnity script, create a class that inherits from Behaviour. Usually in Unity, you would put the class in its own file, but Python can't do something like that, so put all of your scripts in one file. Then, to add a script, just use AddComponent(). Do not put anything in the __init__ function, instead put it in Start(). The Update() function receives one parameter, dt, which is the same as Time.deltaTime.
Windows
The window is provided by one of three providers: GLFW, PySDL2 and FreeGLUT. When you first import PyUnity, it checks to see if any of the three providers work. The testing order is as above, so FreeGLUT is tested last.
To create your own provider, create a class that has the following methods:
__init__: initiate your window and check to see if it works.start: start the main loop in your window. The first parameter isupdate_func, which is called when you want to do the OpenGL calls.
Check the source code of any of the window providers for an example. If you have a window provider, then please create a new pull request.
Examples
To run an example, import it like so:
>>> from pyunity.examples.example1 import main
Loaded config
Trying FreeGLUT as a window provider
FreeGLUT doesn't work, trying GLFW
GLFW doesn't work, trying PySDL2
Using window provider PySDL2
Loaded PyUnity version 0.7.0
>>> main()
Or from the command line:
> python -m pyunity 1
The 1 just means to load example 1, and there are 9 examples. To load all examples one by one, do not specify a number. If you want to contribute an example, then please create a new pull request.
![[OBSERVATION] Cool idea, but the name will likely get C&D'd....](https://avatars.githubusercontent.com/u/123560?v=4)
21 Oct 6, 2022
35 Jan 3, 2023
2 Mar 1, 2022
1.6k Jan 5, 2023
11.2k Jan 9, 2023
235 Jan 8, 2023
3 Oct 25, 2022
8 Dec 10, 2022
1 Jan 18, 2022
3 Jun 1, 2022
1 Feb 11, 2022
11 Sep 18, 2022
1.5k Dec 31, 2022
5 Feb 18, 2022
0 Feb 11, 2022
1 Jan 3, 2022
0 Aug 2, 2022
1 Feb 2, 2022