Skip to content

Commit bb595d4

Browse files
authored
Update README.md
Add platform requirements for this library and explicitly state which Python version it supports, which are both frequent questions in issues opened for this respository.
1 parent 6d9a590 commit bb595d4

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

README.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,36 @@
11
UnityPython
22
===========
33
UnityPython is a plugin for Unity3D that provides support for running Python
4-
code in Unity.
4+
2.x code in Unity3D on any platform which supports `System.Reflection.Emit`.
55

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

99

10+
Requirements
11+
============
12+
The build target must support `System.Reflection.Emit`. In the Unity3D docs, you
13+
can find an up-to-date detailed list of which platforms support `Emit` or not
14+
[here](https://docs.unity3d.com/Manual/ScriptingRestrictions.html).
15+
16+
As of Unity3D 2019.4 LTS, here is a chart of platforms support for `Emit`:
17+
| Platform (scripting backend) | Is `System.Reflection.Emit` supported? |
18+
|-------------------------------------|----------------------------------------|
19+
| Android (IL2CPP) | No |
20+
| Android (Mono) | Yes |
21+
| iOS (IL2CPP) | No |
22+
| PlayStation 4 (IL2CPP) | No |
23+
| PlayStation Vita (IL2CPP) | No |
24+
| Standalone (IL2CPP) | No |
25+
| Standalone (Mono) | Yes |
26+
| Switch (IL2CPP) | No |
27+
| Universal Windows Platform (IL2CPP) | No |
28+
| Universal Windows Platform (.NET) | Yes* |
29+
| WebGL (IL2CPP) | No |
30+
| WiiU (Mono) | Yes |
31+
| XBox One (IL2CPP) | No |
32+
33+
1034
Setup
1135
=====
1236
Place the source of this project anywhere in the "Assets" folder. For

0 commit comments

Comments
 (0)