Skip to content

Commit bef6e4e

Browse files
committed
Add Unity package json
Also added a third party notices file as suggested in the official Unity package documentation (https://docs.unity3d.com/Manual/cus-legal.html) and updated the README to add the package manager installation instructions.
1 parent c8df43c commit bef6e4e

6 files changed

+55
-12
lines changed

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
66

77
## [Unreleased]
88

9+
### Added
10+
* Add a package.json file so this repository be imported in Unity using the
11+
package manager window.
12+
913

1014
## [0.5.0]
1115

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,12 @@
1-
UnityPython
2-
===========
1+
# UnityPython
32
UnityPython is a plugin for Unity3D that provides support for running Python
43
2.x code in Unity3D on any platform which supports `System.Reflection.Emit`.
54

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

98

10-
Requirements
11-
============
9+
## Requirements
1210
The build target must support `System.Reflection.Emit`. In the Unity3D docs, you
1311
can find an up-to-date detailed list of which platforms support `Emit` or not
1412
[here](https://docs.unity3d.com/Manual/ScriptingRestrictions.html).
@@ -25,7 +23,7 @@ As of Unity3D 2019.4 LTS, here is a chart of platform support for `Emit`:
2523
| Standalone (Mono) | Yes |
2624
| Switch (IL2CPP) | No |
2725
| Universal Windows Platform (IL2CPP) | No |
28-
| Universal Windows Platform (.NET) | Maybe* |
26+
| Universal Windows Platform (.NET) | Maybe\* |
2927
| WebGL (IL2CPP) | No |
3028
| WiiU (Mono) | Yes |
3129
| XBox One (IL2CPP) | No |
@@ -34,18 +32,20 @@ As of Unity3D 2019.4 LTS, here is a chart of platform support for `Emit`:
3432
libraries subset" but fails to state what libraries are included in that
3533
subset. If you know the answer to this question, please open a PR.
3634

37-
Setup
38-
=====
39-
Place the source of this project anywhere in the "Assets" folder. For
40-
convenience, you can use the latest `.unitypackage` release from the
41-
[releases][] page to do this.
35+
36+
## Setup
37+
There are three different ways to use this library in Unity:
38+
* Use the `Add package from git URL...` option in Unity's package manager and
39+
use the git URL of this repository.
40+
* Clone this repository into your Unity project. Or, if your Unity project is
41+
already a git repository, add this repository as a submodule.
42+
* Download and install the latest [`.unitypackage` release][releases]
4243

4344
Then, go to `Edit > Project Settings > Player > Other Settings > Configuration`
4445
and change `Api Compatability Level` to ".NET 4.x"
4546

4647

47-
Usage
48-
=====
48+
## Usage
4949
An example is provided below. More examples can be found in the
5050
`Examples/` folder.
5151

Third Party Notices.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
This package contains third-party software components governed by the license(s)
2+
indicated below:
3+
4+
Component Name: IronPython
5+
6+
License Type: "Apache 2.0"
7+
8+
[IronPython License](https://github.com/IronLanguages/ironpython2/blob/master/LICENSE)

Third Party Notices.md.meta

Lines changed: 7 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"name": "space.exodrifter.python",
3+
"version": "0.5.0",
4+
"displayName": "Python",
5+
"description": "IronPython wrapper library for Unity3D.",
6+
"unity": "2019.4",
7+
"unityRelease": "10f1",
8+
"keywords": [
9+
"python"
10+
],
11+
"author": {
12+
"name": "exodrifter",
13+
"email": "[email protected]",
14+
"url": "https://exodrifter.space"
15+
},
16+
"type": "library"
17+
}

package.json.meta

Lines changed: 7 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)