Update to 1.1.3

tomkail · tomkail · commit fd55c0460c89 · 2022-10-26T09:36:34.000+01:00
diff --git a/Packages/Ink/Editor/Core/Ink Library/InkLibrary.cs b/Packages/Ink/Editor/Core/Ink Library/InkLibrary.cs
@@ -21,7 +21,7 @@ public class InkLibrary : ScriptableObject, IEnumerable<InkFile> {
     #endif
         // Ink version. This should really come from the core ink code.
 		public static System.Version inkVersionCurrent = new System.Version(1,1,1);
-		public static System.Version unityIntegrationVersionCurrent = new System.Version(1,1,2);
+		public static System.Version unityIntegrationVersionCurrent = new System.Version(1,1,3);
 
 		static string absoluteSavePath {
 			get {
diff --git a/Packages/Ink/README.md b/Packages/Ink/README.md
@@ -4,13 +4,13 @@ This Unity package allows you to integrate inkle's [ink narrative scripting lang
 
 # Overview
 
-- **Using ink in your game**: Allows running and controlling ink files in Unity via the [C# runtime API](https://github.com/inkle/ink/blob/master/Documentation/RunningYourInk.md).
-
-- **ink player**: Provides a powerful [Ink Player Window](https://github.com/inkle/ink-unity-integration/blob/master/Documentation/InkPlayerWindow.md) for playing and debugging stories.
-
-- **Auto compilation**: Instantly creates and updates a JSON story file when a `.ink` is updated.
-
-- **Inspector tools**: Provides an icon for ink files, and a custom inspector that provides information about a file.
+ - **Using ink in your game**: Allows running and controlling ink files in Unity via the [C# runtime API](https://github.com/inkle/ink/blob/master/Documentation/RunningYourInk.md).
+ 	
+ - **ink player**: Provides a powerful [Ink Player Window](https://github.com/inkle/ink-unity-integration/blob/master/Documentation/InkPlayerWindow.md) for playing and debugging stories.
+ 
+ - **Auto compilation**: Instantly creates and updates a JSON story file when a `.ink` is updated.
+ 	
+ - **Inspector tools**: Provides an icon for ink files, and a custom inspector that provides information about a file.
 
 # Getting started
 
@@ -22,22 +22,25 @@ This will import the source into your Assets folder. This is a good option if yo
 * [Download the latest .UnityPackage](https://github.com/inkle/ink-unity-integration/releases).
 * Open the downloaded file to import it into your Unity project.
 
-### From GitHub
-* You can clone/download/fork the project on [GitHub](https://github.com/inkle/ink-unity-integration).
-* The easiest way to download it is to click the green Code button and select Download ZIP
-* Install by moving the folder Packages/Ink to anywhere in your Unity project's Assets folder
-
 ### As a UPM Package
+Installing via a package allows you to easily update via Unity's Package Manager window. This is best if you don't need to edit the source.
+* When installed via UPM, demo projects can be imported from Packages > Ink Unity Integration > Demos
+
 #### Via Package Manager
-* Add the following line to Packages/manifest.json:
+* Add the following line to PROJECT ROOT/Packages/manifest.json:
 `"com.inkle.ink-unity-integration": "https://github.com/inkle/com.inkle.ink-unity-integration.git"`
 #### OpenUPM
-* Navigate to [OpenUPM](https://openupm.com/packages/com.inklestudios.ink-unity-integration/) and follow their instructions
+* Navigate to [OpenUPM](https://openupm.com/packages/com.inkle.ink-unity-integration/) and follow their instructions
 * The project will have installed at Packages > Ink Unity Integration.
-* Demo projects can be imported from Packages > Ink Unity Integration > Examples
+
+
+### From GitHub
+* You can clone/download/fork the project on [GitHub](https://github.com/inkle/ink-unity-integration).
+* The easiest way to download it is to click the green Code button and select Download ZIP
+* Install by moving the folder Packages/Ink to anywhere in your Unity project's Assets folder
 
 ### Via the Asset Store
-For convenience a .UnityPackage is hosted at the [Unity Asset Store](https://assetstore.unity.com/packages/tools/integration/ink-unity-integration-60055).
+For convinience a .UnityPackage is hosted at the [Unity Asset Store](https://assetstore.unity.com/packages/tools/integration/ink-unity-integration-60055).
 **This version is updated rarely, and so is not recommended.**
 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,7 +49,7 @@ This will import the source into your Assets folder. This is a good option if yo
 ## :video_game: Demos
 This project includes a demo scene, providing a simple example of how to control an ink story with C# code using Unity UI.
 
-(If you imported this package as a UPM (recommended), then you must first import the demos from Packages > Ink Unity Integration > Examples)
+(If you imported this package as a UPM, then you must first import the demos from Packages > Ink Unity Integration > Demos)
 
 To run a demo, double-click the scene file at the root of the demo folder to open it, and press the Play button at the top of the screen to start it.
 
@@ -56,7 +59,7 @@ The C# API provides all you need to control ink stories in code; advancing your
 For convenience, the package also creates an (**Help > Ink > API Documentation**) menu option.
 
 ## :pencil2: Writing ink
-For more information on writing with **ink**, see [the documentation in the main ink repo](https://github.com/inkle/ink).
+For more information on writing with **ink**, see [the documentation in the main ink repo](https://github.com/inkle/ink). 
 For convenience, the package also creates an (**Help > Ink > Writing Tutorial**) menu option.
 
 
@@ -69,13 +72,13 @@ To keep up to date with the latest news about ink [sign up for the mailing list]
 # Features
 
 ## Compilation
-
-Ink files must be compiled to JSON before they can be used in-game.
+	
+Ink files must be compiled to JSON before they can be used in-game. 
 **This package compiles all edited ink files automatically.**
 By default, compiled files are created next to their ink file.
 
 ### Editor Compilation
-This package provides tools to automate this process when a .ink file is edited.
+This package provides tools to automate this process when a .ink file is edited. 
 
 **Disabling auto-compilation**: You might want to have manual control over ink compilation. If this is the case, you can disable "Compile ink automatically" in the InkSettings file or delete the InkPostProcessor class.
 
@@ -94,7 +97,7 @@ The Ink Player Window (**Window > Ink Player**) allows you to play stories in an
 
 To play a story, click the "play" button shown on the inspector of a compiled ink file, or drag a compiled ink story TextAsset into the window.
 
-**Editor Attaching**: Attaching the InkStory instance used by your game to the Ink Player window allows you to view and edit your story as it runs in game.
+**Editor Attaching**: Attaching the InkStory instance used by your game to the Ink Player window allows you to view and edit your story as it runs in game. 
 
 See BasicInkExampleEditor.cs in the Examples folder for an example of how to:
 * Show an attach/detach button on an inspector
@@ -116,7 +119,7 @@ This package replaces the icon for ink files to make them easier to spot, and ad
 There is currently no support for Bolt, Unity's official visual scripting tool. If you're interested in building one, we'd love to see it!
 
 ## PlayMaker
-There's [unofficial support for PlayMaker here.](https://github.com/inkle/ink-unity-integration/issues/22)
+There's [unofficial support for PlayMaker here.](https://github.com/inkle/ink-unity-integration/issues/22) 
 
 
 We'd love to see this supported more if you'd like to assist the effort!
@@ -131,7 +134,7 @@ Adding or removing ink files will also make changes to the InkLibrary file, and
 
 # <a name="WebGLBestPractices"></a>WebGL best practices
 
-WebGL builds should be as small as possible. The ink compiler is included in builds, but is typically only used in the editor.
+WebGL builds should be as small as possible. The ink compiler is included in builds, but is typically only used in the editor. 
 If your game doesn't require compiling ink at runtime we recommend adding a .asmdef at Ink Unity Integration > InkLibs > InkCompiler that only functions in the editor.
 
 
@@ -143,14 +146,15 @@ If your game doesn't require compiling ink at runtime we recommend adding a .asm
 
 * What versions of Unity are supported?
 
-  We officially support 2018 LTS and above, but it should work going back to at least Unity 5.
+  We support 2020 LTS and above.
+  Until version 1.1.1 we supported 2018 LTS, which should also work going back to at least Unity 5.
 
 # Support us!:heart:
 
 Ink is free, forever; but we'd really appreciate your support!
-If you're able to give back, generous donations at our [Patreon](https://www.patreon.com/inkle) mean the world to us.
+If you're able to give back, generous donations at our [Patreon](https://www.patreon.com/inkle) mean the world to us. 
 
 # License
 
 **ink** and this package is released under the MIT license. Although we don't require attribution, we'd love to know if you decide to use **ink** a project! Let us know on [Twitter](http://www.twitter.com/inkleStudios) or [by email](mailto:info@inklestudios.com).
-Full licence [here](https://github.com/inkle/ink-unity-integration/blob/master/LICENCE.md) mean the world to us.
+View the full licence [Here](https://github.com/inkle/ink-unity-integration/blob/master/LICENCE.md)
diff --git a/Packages/Ink/package.json b/Packages/Ink/package.json
@@ -1,6 +1,6 @@
 {
   "name": "com.inkle.ink-unity-integration",
-  "version": "1.1.1",
+  "version": "1.1.3",
   "displayName": "Ink",
   "description": "Unity integration for the open source ink narrative scripting language.",
   "unity": "2018.4",
diff --git a/README.md b/README.md
@@ -30,7 +30,7 @@ Installing via a package allows you to easily update via Unity's Package Manager
 * Add the following line to PROJECT ROOT/Packages/manifest.json:
 `"com.inkle.ink-unity-integration": "https://github.com/inkle/com.inkle.ink-unity-integration.git"`
 #### OpenUPM
-* Navigate to [OpenUPM](https://openupm.com/packages/com.inklestudios.ink-unity-integration/) and follow their instructions
+* Navigate to [OpenUPM](https://openupm.com/packages/com.inkle.ink-unity-integration/) and follow their instructions
 * The project will have installed at Packages > Ink Unity Integration.
 
 

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "com.inkle.ink-unity-integration",`
`3`		`- "version": "1.1.1",`
	`3`	`+ "version": "1.1.3",`
`4`	`4`	`"displayName": "Ink",`
`5`	`5`	`"description": "Unity integration for the open source ink narrative scripting language.",`
`6`	`6`	`"unity": "2018.4",`