Skip to content

Commit 1fabdf9

Browse files
committed
Update build instructions, raise version to 1.1.5 to trigger UPM
1 parent 120afd0 commit 1fabdf9

File tree

5 files changed

+16
-13
lines changed

5 files changed

+16
-13
lines changed

Assets/DEV_README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,10 @@ This plugin is now designed to be imported as a UPM Package.
44
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.
55
Demos are packaged up as separate .unitypackage files.
66

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.
-13 Bytes
Binary file not shown.

Packages/Ink/Editor/Core/Ink Library/InkLibrary.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ public class InkLibrary : ScriptableObject, IEnumerable<InkFile> {
2121
#endif
2222
// Ink version. This should really come from the core ink code.
2323
public static System.Version inkVersionCurrent = new System.Version(1,1,1);
24-
public static System.Version unityIntegrationVersionCurrent = new System.Version(1,1,4);
24+
public static System.Version unityIntegrationVersionCurrent = new System.Version(1,1,5);
2525

2626
static string absoluteSavePath {
2727
get {

Packages/Ink/README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Installing via a package allows you to easily update via Unity's Package Manager
2828

2929
#### Via Package Manager
3030
* Add the following line to PROJECT ROOT/Packages/manifest.json:
31-
`"com.inkle.ink-unity-integration": "https://github.com/inkle/com.inkle.ink-unity-integration.git"`
31+
`"com.inkle.ink-unity-integration": "https://github.com/inkle/ink-unity-integration.git#upm"`
3232
#### OpenUPM
3333
* Navigate to [OpenUPM](https://openupm.com/packages/com.inkle.ink-unity-integration/) and follow their instructions
3434
* 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
4040
* Install by moving the folder Packages/Ink to anywhere in your Unity project's Assets folder
4141

4242
### 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).
4445
**This version is updated rarely, and so is not recommended.**
4546
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.
4647

@@ -55,11 +56,14 @@ To run a demo, double-click the scene file at the root of the demo folder to ope
5556

5657
## :page_facing_up: C# API
5758
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+
5962
For convenience, the package also creates an (**Help > Ink > API Documentation**) menu option.
6063

6164
## :pencil2: Writing ink
6265
For more information on writing with **ink**, see [the documentation in the main ink repo](https://github.com/inkle/ink).
66+
6367
For convenience, the package also creates an (**Help > Ink > Writing Tutorial**) menu option.
6468

6569

Packages/Ink/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "com.inkle.ink-unity-integration",
3-
"version": "1.1.3",
3+
"version": "1.1.5",
44
"displayName": "Ink",
55
"description": "Unity integration for the open source ink narrative scripting language.",
66
"unity": "2018.4",

0 commit comments

Comments
 (0)