UnityPython is a plugin for Unity3D that provides support for running Python
2.x code in Unity3D on any platform which supports System.Reflection.Emit.
Special thanks to the developers of IronPython who developed the open-source integration of Python and .NET, which this plugin uses.
The build target must support System.Reflection.Emit. In the Unity3D docs, you
can find an up-to-date detailed list of which platforms support Emit or not
here.
As of Unity3D 2019.4 LTS, here is a chart of platform support for Emit:
| Platform (scripting backend) | Is System.Reflection.Emit supported? |
|---|---|
| Android (IL2CPP) | No |
| Android (Mono) | Yes |
| iOS (IL2CPP) | No |
| PlayStation 4 (IL2CPP) | No |
| PlayStation Vita (IL2CPP) | No |
| Standalone (IL2CPP) | No |
| Standalone (Mono) | Yes |
| Switch (IL2CPP) | No |
| Universal Windows Platform (IL2CPP) | No |
| Universal Windows Platform (.NET) | Maybe* |
| WebGL (IL2CPP) | No |
| WiiU (Mono) | Yes |
| XBox One (IL2CPP) | No |
* Unconfirmed, as Unity states that UWP (.NET) uses a ".NET Core class libraries subset" but fails to state what libraries are included in that subset. If you know the answer to this question, please open a PR.
There are three different ways to use this library in Unity:
- Use the
Add package from git URL...option in Unity's package manager and use the git URL of this repository. - Clone this repository into your Unity project. Or, if your Unity project is already a git repository, add this repository as a submodule.
- Download and install the latest
.unitypackagerelease
Then, go to Edit > Project Settings > Player > Other Settings > Configuration
and change Api Compatability Level to ".NET 4.x"
An example is provided below. More examples can be found in the
Examples/ folder.
using UnityEngine;
using IronPython.Hosting;
public class HelloWorld : MonoBehaviour
{
void Start()
{
var engine = Python.CreateEngine();
var scope = engine.CreateScope();
string code = "str = 'Hello world!'";
var source = engine.CreateScriptSourceFromString(code);
source.Execute(scope);
Debug.Log(scope.GetVariable<string>("str"));
}
}