You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Assets/DEV_README.md
+7-8Lines changed: 7 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,11 +4,10 @@ This plugin is now designed to be imported as a UPM Package.
4
4
Our approach is to point [OpenUPM at a Git Repo](https://openupm.com/packages/com.inklestudios.ink-unity-integration/) with the assets in the Packages folder.
5
5
Demos are packaged up as separate .unitypackage files.
6
6
7
-
## To update the UPM
8
-
- (optional) Increase the version number in InkLibrary.cs
9
-
- Commit any changes and push to Master.
10
-
- Draft a new release. (You may also want to add a .unitypackage to the release)
11
-
12
-
### Exporting a .unitypackage
13
-
- Run Publishing > Create .unitypackage
14
-
This moves all the files from Packages into Assets, creates a package (also including the Demos folder), and then moves the files back to Packages.
7
+
## To update create a new release
8
+
- Increase the version number in InkLibrary.cs
9
+
- Run 'Publishing > Prepare for publishing'
10
+
- Commit any changes and push to Master, tagging with the version in the format (x.x.x)
11
+
- This causes an Action to trigger, which will create a UPM branch automatically. [Check it succeeded on OpenUPM](https://openupm.com/packages/com.inkle.ink-unity-integration/?subPage=pipelines)
12
+
- Draft a new release on GitHub, attaching the .unitypackage that the publish menu item will have output to the repo root.
13
+
- The Create .unitypackage step of the publish menu item moves all the files from Packages into Assets, creates a package (also including the Demos folder), and then moves the files back to Packages.
* Navigate to [OpenUPM](https://openupm.com/packages/com.inkle.ink-unity-integration/) and follow their instructions
34
34
* The project will have installed at Packages > Ink Unity Integration.
@@ -40,7 +40,8 @@ Installing via a package allows you to easily update via Unity's Package Manager
40
40
* Install by moving the folder Packages/Ink to anywhere in your Unity project's Assets folder
41
41
42
42
### Via the Asset Store
43
-
For convinience a .UnityPackage is hosted at the [Unity Asset Store](https://assetstore.unity.com/packages/tools/integration/ink-unity-integration-60055).
43
+
44
+
onvinience a .UnityPackage is hosted at the [Unity Asset Store](https://assetstore.unity.com/packages/tools/integration/ink-unity-integration-60055).
44
45
**This version is updated rarely, and so is not recommended.**
45
46
This will import the source into your Assets folder. This is a good option if you intend to edit the source for your own needs.
46
47
@@ -55,11 +56,14 @@ To run a demo, double-click the scene file at the root of the demo folder to ope
55
56
56
57
## :page_facing_up: C# API
57
58
The C# API provides all you need to control ink stories in code; advancing your story, making choices, diverting to knots, saving and loading, and much more.
58
-
[It is documented in the main ink repo](https://github.com/inkle/ink/blob/master/Documentation/RunningYourInk.md#getting-started-with-the-runtime-api)
59
+
60
+
[It is documented in the main ink repo](https://github.com/inkle/ink/blob/master/Documentation/RunningYourInk.md#getting-started-with-the-runtime-api).
61
+
59
62
For convenience, the package also creates an (**Help > Ink > API Documentation**) menu option.
60
63
61
64
## :pencil2: Writing ink
62
65
For more information on writing with **ink**, see [the documentation in the main ink repo](https://github.com/inkle/ink).
66
+
63
67
For convenience, the package also creates an (**Help > Ink > Writing Tutorial**) menu option.
0 commit comments