Support Unity Package Manager (#2343)

* Add files to support Unity Package Manager - Agones assembly definition - Package information - Meta files required for the engine * Update version number * Update author name * Add update step * Add step to Update SDK Package Versions section * Updated client SDK documentation Co-authored-by: Robert Bailey <robertbailey@google.com> Co-authored-by: Mark Mandel <markmandel@google.com>
googleforgames · Nov 16, 2021 · 2be5e3b · 2be5e3b
1 parent fdd3e95
commit 2be5e3b
Show file tree

Hide file tree

Showing 16 changed files with 153 additions and 0 deletions.
diff --git a/docs/governance/templates/release_issue.md b/docs/governance/templates/release_issue.md
@@ -38,6 +38,7 @@ and copy it into a release issue. Fill in relevant values, found inside {}
 - [ ] Update SDK Package Versions
     - [ ] Update the package version in [`sdks/nodejs/package.json`][package.json] and [`sdks/nodejs/package-lock.json`][package-lock.json] by running `npm version {version}` if a full release or `npm version {version}-rc` if release candidate
     - [ ] Ensure the [`sdks/csharp/sdk/AgonesSDK.nuspec` and `sdks/csharp/sdk/csharp-sdk.csproj`][csharp] versions are correct (should be {version} if a full release, {version}-rc if release candidate)
+    - [ ] Update the package version in the [`sdks/unity/package.json`][unity] package file's `Version` field to {version} if a full release, {version}-rc if release candidate
 - [ ] Run `make gen-install`
 - [ ] Run `make test-examples-on-gcr` to ensure all example images exist on gcr.io/agones-images-
 - [ ] Create a *draft* release with the [release template][release-template]
@@ -80,6 +81,7 @@ and copy it into a release issue. Fill in relevant values, found inside {}
 - [ ] If full release move the [helm `Chart` version values][chart] is to {version}+1-dev
 - [ ] If full release, change to the `sdks/nodejs` directory and run the command `npm version {version}+1-dev` to update the package version
 - [ ] If full release move the [`sdks/csharp/sdk/AgonesSDK.nuspec` and `sdks/csharp/sdk/csharp-sdk.csproj`][csharp] to {version}+1-dev
+- [ ] If full release update the [`sdks/unity/package.json`][unity] package file's `Version` field to {version}+1-dev
 - [ ] If full release, remove `feature-freeze-do-not-merge` labels from all pull requests
 - [ ] Run `make gen-install gen-api-docs`
 - [ ] Create PR with these changes, and merge them with approval

diff --git a/sdks/unity/Agones.asmdef b/sdks/unity/Agones.asmdef
@@ -0,0 +1,3 @@
+{
+    "name": "Agones"
+}
diff --git a/sdks/unity/Agones.asmdef.meta b/sdks/unity/Agones.asmdef.meta
diff --git a/sdks/unity/AgonesSdk.cs.meta b/sdks/unity/AgonesSdk.cs.meta
diff --git a/sdks/unity/model.meta b/sdks/unity/model.meta
diff --git a/sdks/unity/model/GameServer.cs.meta b/sdks/unity/model/GameServer.cs.meta
diff --git a/sdks/unity/model/GameServerObjectMeta.cs.meta b/sdks/unity/model/GameServerObjectMeta.cs.meta
diff --git a/sdks/unity/model/GameServerSpec.cs.meta b/sdks/unity/model/GameServerSpec.cs.meta
diff --git a/sdks/unity/model/GameServerStatus.cs.meta b/sdks/unity/model/GameServerStatus.cs.meta
diff --git a/sdks/unity/model/SpecHealth.cs.meta b/sdks/unity/model/SpecHealth.cs.meta
diff --git a/sdks/unity/model/StatusPort.cs.meta b/sdks/unity/model/StatusPort.cs.meta
diff --git a/sdks/unity/package.json b/sdks/unity/package.json
@@ -0,0 +1,11 @@
+{
+    "name": "com.googleforgames.agones",
+    "version": "1.18.1",
+    "displayName": "Agones Unity SDK",
+    "description": "The Unity Gameserver SDK for Agones",
+    "unity": "2019.1",
+    "author": {
+      "name": "Google LLC",
+      "url": "https://github.com/googleforgames/agones"
+    }
+  }
diff --git a/sdks/unity/package.json.meta b/sdks/unity/package.json.meta
diff --git a/sdks/unity/third_party.meta b/sdks/unity/third_party.meta
diff --git a/sdks/unity/third_party/MiniJSON.cs.meta b/sdks/unity/third_party/MiniJSON.cs.meta
diff --git a/site/content/en/docs/Guides/Client SDKs/unity.md b/site/content/en/docs/Guides/Client SDKs/unity.md
@@ -33,6 +33,25 @@ Additional methods have been added for ease of use:
 
 - Connect
 
+{{% feature publishVersion="1.19.0" %}}
+## Installation
+
+The client SDK code can be manually downloaded and added to your project hierarchy.
+
+It can also be imported into your project via the Unity Package Manager (UPM). To do that, open your project's `manifest.json` file, and add the following line to the dependencies section:
+
+```
+{
+  "dependencies": {
+        "com.googleforgames.agones": "https://github.com/googleforgames/agones.git?path=/sdks/unity",
+...
+```
+
+If you want a specific release, the dependency can be pinned to that version. For example: 
+
+`"com.googleforgames.agones": "https://github.com/googleforgames/agones.git?path=/sdks/unity#1.19.0",`
+{{% feature publishVersion="1.19.0" %}}
+
 ## Download
 
 Download the source {{< ghlink href="sdks/unity" >}}directly from GitHub{{< /ghlink >}}.