Added Dedicated Game Server Sample (experimental)

.yamato/_triggers.yml

@@ -0,0 +1,43 @@
+{% metadata_file .yamato/project.metafile %}
+---
+
+# Run all relevant tasks when a pull request targets the develop / main or a sample branch
+pull_request_trigger:
+  name: Pull Request Trigger (main, develop, & sample branches)
+  dependencies:
+{% for project in projects -%}
+{% for editor in project.test_editors -%}
+{% for platform in test_platforms -%}
+    - .yamato/build.yml#build_{{ project.name }}_{{ editor }}_{{ platform.name }}
+{% if project.run_editor_tests or project.run_playmode_tests -%} # Only run tests for projects where relevant
+    - .yamato/tests.yml#test_{{ project.name }}_{{ editor }}_{{ platform.name }}
+{% endif -%}
+{% endfor -%}
+{% endfor -%}
+{% endfor -%}
+  triggers:
+    cancel_old_ci: true
+    pull_requests:
+    - targets:
+        only:
+          - "main"
+          - "develop"
+          - "/^sample\//"
+
+# Run all tasks on the bitesize sample develop branch (head) when there is a push to the Netcode for GameObjects develop branch
+external_ngo_develop_pull_request_trigger:
+  name: Netcode for GameObjects (External) Develop Branch Triggers
+  dependencies:
+{% for project in projects -%}
+{% for editor in project.test_editors -%}
+{% for platform in test_platforms -%}
+    - .yamato/build.yml#build_{{ project.name }}_{{ editor }}_{{ platform.name }}
+{% endfor -%}
+{% endfor -%}
+{% endfor -%}
+  triggers:
+    external:
+      source: git@github.com/Unity-Technologies/com.unity.netcode.gameobjects.git
+      expression: push.branch eq "develop"
+      refs_on_this_repository:
+        - develop

.yamato/build.yml

@@ -2,9 +2,8 @@
 ---
 
 {% for project in projects -%}
-{% for editor in test_editors -%}
+{% for editor in project.test_editors -%}
 {% for platform in test_platforms -%}
-
 build_{{ project.name }}_{{ editor }}_{{ platform.name }}:
   name: Build Project {{ project.name }} - Package {{ package.name }} - {{ editor }} on {{ platform.name }}
   variables:
@@ -15,59 +14,34 @@ build_{{ project.name }}_{{ editor }}_{{ platform.name }}:
     flavor: {{ platform.flavor}}
   commands:
     - pip install unity-downloader-cli --index-url https://artifactory.prd.it.unity3d.com/artifactory/api/pypi/pypi/simple --upgrade
+{% if project.name == "dedicatedgameserver" -%} #dedicatedgameserver sample builds via custom editor script. This script generates client and server builds on the Mac, Windows, and Linux platforms
+    - unity-downloader-cli -u {{ editor }} -c editor -c macOS -c Windows -c Linux -c macOSDedicatedServerBuildSupport -c LinuxDedicatedServerBuildSupport -c WindowsDedicatedServerBuildSupport --wait --published --fast
+{% if platform.name == "win" -%} #windows
+    - .Editor\Unity.exe -batchmode -nographics -logfile build.log -executeMethod Unity.DedicatedGameServerSample.Editor.BuildHelpers.BuildEverything -projectPath {{ project.path }} -quit
+{% else -%}
+    - .Editor/Unity.app/Contents/MacOS/Unity -batchmode -nographics -logfile build.log -executeMethod Unity.DedicatedGameServerSample.Editor.BuildHelpers.BuildEverything -projectPath {{ project.path }} -quit
+{% endif -%}
+{% else -%}
     - unity-downloader-cli -u {{ editor }} -c editor --wait --published --fast
-
 {% if platform.name == "win" -%} #windows
     - .Editor\Unity.exe -projectpath {{ project.path }} -batchmode -quit -logfile build.log -buildWindowsPlayer build\players\test.exe
 {% else -%}
     - .Editor/Unity.app/Contents/MacOS/Unity -projectpath {{ project.path }} -batchmode -quit -logfile build.log -buildOSXUniversalPlayer ./build/players/test
+{% endif -%}
 {% endif -%}
 
   artifacts:
     players:
         paths:
-          - "build/players/**"
+{% if project.name == "dedicatedgameserver" -%} #dedicatedgameserver sample builds via custom editor script into different location
+          - "{{ project.path }}/Builds/**"
+{% else -%}
+          - "{{ project.path }}/build/players/**"
+{% endif -%}
     logs:
         paths:
-          - "build/logs/**"
-
-{% endfor -%}
-{% endfor -%}
-{% endfor -%}
+          - "build.log"
 
-# Run all relevant tasks when a pull request targeting the develop / main
-develop_pull_request_trigger:
-  name: Develop Branch Triggers
-  dependencies:
-{% for project in projects -%}
-{% for editor in test_editors -%}
-{% for platform in test_platforms -%}
-    - .yamato/build.yml#build_{{ project.name }}_{{ editor }}_{{ platform.name }}
-{% endfor -%}
-{% endfor -%}
-{% endfor -%}
-  triggers:
-    cancel_old_ci: true
-    pull_requests:
-    - targets:
-        only:
-          - "main"
-          - "develop"
-
-# Run all tasks on the bitesize sample develop branch (head) when there is a push to the Netcode for GameObjects develop branch
-external_ngo_develop_pull_request_trigger:
-  name: Netcode for GameObjects (External) Develop Branch Triggers
-  dependencies:
-{% for project in projects -%}
-{% for editor in test_editors -%}
-{% for platform in test_platforms -%}
-    - .yamato/build.yml#build_{{ project.name }}_{{ editor }}_{{ platform.name }}
-{% endfor -%}
 {% endfor -%}
 {% endfor -%}
-  triggers:
-    external:
-      source: git@github.com/Unity-Technologies/com.unity.netcode.gameobjects.git
-      expression: push.branch eq "develop"
-      refs_on_this_repository:
-        - develop
+{% endfor -%}

.yamato/project.metafile

@@ -1,35 +1,59 @@
-# Editors where tests will happen. The first entry of this array is also used
-# for validation.
-#
-# Therefore, **do not** put an older V1-lifecycle ver. 
-#  like 2020.x or 2019.x on top of 'test_editors'
-test_editors:
-  - 2022.3
-
 # Platforms that will be tested. The first entry in this array will also
 # be used for validation
 test_platforms:
   - name: win
     type: Unity::VM
-    image: package-ci/win10:stable
+    image: package-ci/win10:v4.36.0
     platform: StandaloneWindows64
     flavor: b1.large
   - name: mac
     type: Unity::VM::osx
-    image: package-ci/mac:stable
+    image: package-ci/macos-13:v4
     platform: StandaloneOSX
     flavor: m1.mac
 
-# Projects within the repository that will be tested. Name will be used
-# for job ids, so it should not contain spaces/non-supported characters
+# Projects within the repository that will be tested. Name will be used for job ids, so it should not contain spaces/non-supported characters
+# The test-editors field is for editors where tests will happen. The first entry of this array is also used
+# for validation. Therefore, **do not** put an older V1-lifecycle ver. like 2020.x or 2019.x on top of 'test_editors'
 projects:
   - name: 2dspaceshooter
     path: Basic/2DSpaceShooter
+    test_editors:
+      - 2022.3
+    run_editor_tests: !!bool false
+    run_playmode_tests: !!bool false
+    test_filter: 
   - name: invaders
     path: Basic/Invaders
+    test_editors:
+      - 2022.3
+    run_editor_tests: !!bool false
+    run_playmode_tests: !!bool false
+    test_filter: 
   - name: clientdriven
     path: Basic/ClientDriven
+    test_editors:
+      - 2022.3
+    run_editor_tests: !!bool false
+    run_playmode_tests: !!bool false
+    test_filter: 
   - name: dynamicaddressablesnetworkprefabs
     path: Basic/DynamicAddressablesNetworkPrefabs
+    test_editors:
+      - 2022.3
+    run_editor_tests: !!bool false
+    run_playmode_tests: !!bool false
+    test_filter: 
+  - name: dedicatedgameserver
+    path: Experimental/DedicatedGameServer
+    test_editors:
+      - 2023.3.0a17
+    run_editor_tests: !!bool false
+    run_playmode_tests: !!bool true
+    test_filter: Unity.DedicatedGameServerSample.Tests
   - name: multiplayerusecases
-    path: Experimental/MultiplayerUsecases
+    path: Experimental/MultiplayerUseCases
+    test_editors:
+      - 2022.3
+    run_editor_tests: !!bool true
+    run_playmode_tests: !!bool false

.yamato/tests.yml

@@ -0,0 +1,43 @@
+{% metadata_file .yamato/project.metafile %}
+---
+
+{% for project in projects -%}
+{% for editor in project.test_editors -%}
+{% for platform in test_platforms -%}
+test_{{ project.name }}_{{ editor }}_{{ platform.name }}:
+  name: {{ project.name }} project tests - {{ editor }} on {{ platform.name }}
+  variables:
+    UTR_VERSION: current
+  agent:
+    type: {{ platform.type }}
+    image: {{ platform.image }}
+    flavor: {{ platform.flavor}}
+  commands:
+    - pip install unity-downloader-cli --index-url https://artifactory.prd.it.unity3d.com/artifactory/api/pypi/pypi/simple
+    - unity-downloader-cli -u {{ editor }} -c editor -w --fast
+{% if platform.name == "win" -%} #windows
+    - curl -s https://artifactory.prd.it.unity3d.com/artifactory/unity-tools-local/utr-standalone/utr.bat --output utr.bat
+{% if project.run_editor_tests -%} # Only run editor tests for projects where relevant
+    - utr --suite=editor --editor-location=.Editor --testproject={{ project.path }} --testfilter={{ project.test_filter }} --artifacts-path=testlogs
+{% endif -%}
+{% if project.run_playmode_tests -%} # Only run playmode tests for projects where relevant
+    - utr --suite=playmode --editor-location=.Editor --testproject={{ project.path }} --testfilter={{ project.test_filter }} --artifacts-path=testlogs
+{% endif -%}
+{% else -%}
+    - curl -s https://artifactory.prd.it.unity3d.com/artifactory/unity-tools-local/utr-standalone/utr --output utr
+    - chmod +x utr
+{% if project.run_editor_tests -%} # Only run editor tests for projects where relevant
+    - ./utr --suite=editor --editor-location=.Editor --testproject={{ project.path }} --testfilter={{ project.test_filter }} --artifacts-path=testlogs
+{% endif -%}
+{% if project.run_playmode_tests -%} # Only run playmode tests for projects where relevant
+    - ./utr --suite=playmode --editor-location=.Editor --testproject={{ project.path }} --testfilter={{ project.test_filter }} --artifacts-path=testlogs
+{% endif -%}
+{% endif -%}
+  artifacts:
+    logs:
+      paths:
+        - "testlogs/**"
+
+{% endfor -%}
+{% endfor -%}
+{% endfor -%}

CHANGELOG.md

@@ -74,6 +74,13 @@
 - Upgraded to Netcode for GameObjects v1.6.0 (#134)
 - Upgraded sample to 2022.3.9f1 LTS (#134)
 
+## [Unreleased]
+
+### Dedicated Game Server
+todo: the changelog entry for this sample will be updated with subsequent PRs before being merged when ready
+
+- New Dedicated Game Server sample. (#1) This sample's goal is to demonstrate how to use the different tools and packages available to create a game using the dedicated server approach. It requires editor version 2023.3.
+
 ## [1.3.0] - 2023-07-07
 
 ### Dynamic Addressables Network Prefabs

Experimental/DedicatedGameServer/AdditionalBuildFiles/Client/startupConfiguration.json

@@ -0,0 +1,5 @@
+{ 
+   "MinPlayers" : "2", 
+   "MaxPlayers" : "8", 
+   "AutoConnect" : "false"
+}

Experimental/DedicatedGameServer/AdditionalBuildFiles/Server/startupConfiguration.json

@@ -0,0 +1,5 @@
+{ 
+   "MinPlayers" : "2", 
+   "MaxPlayers" : "8", 
+   "AutoConnect" : "false"
+}