From 6497049736c0aa3add80830d9a991d9220616c5f Mon Sep 17 00:00:00 2001 From: RobProductions Date: Wed, 15 Mar 2023 23:36:14 -0400 Subject: [PATCH 1/5] Update version rules in Readme --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4cda590..217787f 100644 --- a/README.md +++ b/README.md @@ -31,13 +31,15 @@ You can use OpenEOS in either or both of the following ways: Since this package is both a port of the EOS SDK and an extension, there is the unique challenge of versioning since the package code builds on top of the included EOS SDK version. Since users likely care about which version of the SDK they are integrating and are compatible with, the Release Number will be laid out like this: -*X.X-Y.Y.Y* where X.X is the package code version and Y.Y.Y is the Epic Online Services SDK version. Example: 1.3-1.15.2 means package version 1.3 targeting EOS SDK version 1.15.2. +*X.X.X-Y.Y.Y* where X.X.X is the package code version and Y.Y.Y is the Epic Online Services SDK version. Example: 1.3.0-1.15.2 means package version 1.3.0 targeting EOS SDK version 1.15.2. + +Unfortunately, since Unity [enforces the SemVer system in the package.json](https://docs.unity3d.com/Manual/upm-semver.html), the scheme laid out above will only be viewable from Github itself, so use the release tags as a reference for what code version maps to which SDK version. Within the package manager itself, you will only see X.X.X, so it's up to you to know how that corresponds to the EOS SDK version. **Current EOS SDK Target:** 1.15.5 ### Disclaimer -Updates to the EOS SDK may happen out of sync with the project code, and vice versa. It's unlikely that the package would ever travel backwards in target EOS version, so expect that package updates will only ever update the SDK forwards. *Example: If you're looking for package version 1.3 targeting SDK 1.14 but version 1.3 already targeted 1.15.2, you're out of luck unless a specific branch or release is created.* +Updates to the EOS SDK itself will constitute a new package code version so that the package.json can reflect a different version for the change. However, it's unlikely that the package would ever travel backwards in target EOS version, so expect that package updates will only ever update the SDK forwards. *Example: If you're looking for package version 1.3.0 targeting SDK 1.14 but version 1.2.0 already targeted 1.15.2, you're out of luck unless a specific branch or release is created.* An exception can be made in the future if there is demand for it. ## Usage From 5ee40bbeb43355b4fcd400a6596b633018a48067 Mon Sep 17 00:00:00 2001 From: RobProductions Date: Wed, 15 Mar 2023 23:37:33 -0400 Subject: [PATCH 2/5] Update package.json --- package.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index dab35df..63c11ab 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "com.robproductions.openeos", - "version": "1.0-1.15.5", + "version": "1.0.1", "displayName": "OpenEOS", "description": "A lightweight & open-source port of the Epic Online Services (EOS) SDK in Unity Package format, with minor enhancements to provide a smoother integration between Unity and EOS.", "unity": "2020.3", @@ -18,4 +18,4 @@ "name": "RobProductions", "url": "https://github.com/RobProductions" }, -} \ No newline at end of file +} From b48c07c05ab0b06c52cdfedba7e13111880845e1 Mon Sep 17 00:00:00 2001 From: RobProductions Date: Wed, 15 Mar 2023 23:40:53 -0400 Subject: [PATCH 3/5] Remove template doc info --- Documentation~/OpenEOSDocumentation.md | 22 ++-------------------- 1 file changed, 2 insertions(+), 20 deletions(-) diff --git a/Documentation~/OpenEOSDocumentation.md b/Documentation~/OpenEOSDocumentation.md index 310ce46..20373af 100644 --- a/Documentation~/OpenEOSDocumentation.md +++ b/Documentation~/OpenEOSDocumentation.md @@ -1,24 +1,6 @@ # Overview -## OpenGraphGUI - -An open source custom Shader GUI for Unity. - -## Usage - -Most up to date info can be found in the README.md file. - -## Installation - -1. Open the Package Manager in Unity -2. Click the '+' icon and hit *"Add package from git URL"* -3. Add the GitHub URL of OpenGraphGUI: [https://github.com/RobProductions/OpenGraphGUI](https://github.com/RobProductions/OpenGraphGUI) -4. Wait for download to complete -5. Add the custom GUI class *RPOpenGraphGUI* to the *Custom Editor GUI* field in your ShaderGraph of choice - -If installation fails due to version requirements, you may be able force OpenGraphGUI to work by downloading the project as .zip and editing the "package.json" file to lower the Unity requirement. Deleting the .meta files may also be necessary and shouldn't break anything... I think. Then use the *"Add package from disk"* option to add your custom version instead. - -If you're looking to add a specific release of OpenGraphGUI, you can specify a release tag with the hashtag like so: "https://github.com/RobProductions/OpenGraphGUI#ReleaseNumber" +Most up to date usage info and installation instructions can be found in the README.md file in the package root. ## Contributors @@ -26,4 +8,4 @@ Created by [RobProductions](https://twitter.com/RobProductions). RobProductions' ## License -This package is licensed under the MIT License, Copyright (c) 2022 RobProductions. You are free to use, copy, and modify as described in the included LICENSE.md file. This License was selected because it is the closest to "Open Source" that I could find commonly used for software. The software is provided "as is", without warranty of any kind. \ No newline at end of file +The license information can be found in the README.md and the LICENSE.md file in the package root. From 642a2bc535fa1eca5602c541bffff3eed1d8d3a3 Mon Sep 17 00:00:00 2001 From: RobProductions Date: Wed, 15 Mar 2023 23:48:19 -0400 Subject: [PATCH 4/5] Fix rogue comma :( --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 63c11ab..babc6e6 100644 --- a/package.json +++ b/package.json @@ -17,5 +17,5 @@ "author": { "name": "RobProductions", "url": "https://github.com/RobProductions" - }, + } } From 56392133448242b4299201a758cad6aa3e93eca1 Mon Sep 17 00:00:00 2001 From: RobProductions Date: Wed, 15 Mar 2023 23:49:50 -0400 Subject: [PATCH 5/5] Update version :') --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index babc6e6..3d34291 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "com.robproductions.openeos", - "version": "1.0.1", + "version": "1.0.2", "displayName": "OpenEOS", "description": "A lightweight & open-source port of the Epic Online Services (EOS) SDK in Unity Package format, with minor enhancements to provide a smoother integration between Unity and EOS.", "unity": "2020.3",