satoshirobatofujimoto / unity-python

Unity3D Python support plugin

UnityPython

UnityPython is a plugin for Unity3D that provides support for running Python code in Unity.

Special thanks to the developers of IronPython who developed the open-source integration of Python and .NET, which this plugin uses.

Thanks to Steve Theodore of the Tech Art Survival Guide who provided many instructions and examples.

Setup

Place the source of this project within a "Plugins" folder. For convenience, you can use the latest .unitypackage release from the releases page to do this.

Then, go to Edit > Project Settings > Player > Optimization and select the .NET 2.0 option for Api Compatability Level. If you do not take this step, you will end up with the following warning message that will eventually result in an error: warning CS1685: The predefined type 'System.Runtime.CompilerServices.ExtensionAttribute' is ambiguous.

If you would like to use this project only in the Editor, changing the Api Compatability Level is unnecessary. Instead, place the project inside an "Editor" folder.

Usage

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"));
	}
}