Merge branch 'main' into feat/0078-spawn-teleporters---teleporter-prefab

.gitattributes

@@ -0,0 +1,6 @@
+# Auto detect text files and perform LF normalization
+*.cs       text diff=csharp eol=lf
+*.cshtml   text diff=html   eol=lf
+*.csx      text diff=csharp eol=lf
+*.sln      text             eol=lf
+*.csproj   text             eol=lf

.gitignore

@@ -69,4 +69,7 @@ aplib.net-demo/[Aa]ssets/[Aa]ddressable[Aa]ssets[Dd]ata/*/*.bin*
 
 # Temporary auto-generated Android Assets
 aplib.net-demo/[Aa]ssets/[Ss]treamingAssets/aa.meta
-aplib.net-demo/[Aa]ssets/[Ss]treamingAssets/aa/*
+aplib.net-demo/[Aa]ssets/[Ss]treamingAssets/aa/*
+
+# Ignore rider files
+**/.idea/

.husky/pre-commit

@@ -1,7 +1,27 @@
 #!/bin/sh
+
+# Boilerplate husky
 . "$(dirname "$0")/_/husky.sh"
 
-dotnet format -v diag aplib.net-demo/aplib.net-demo.sln
+# Find all c# related staged files still existing on the disk, before doing anything
+FILES_TO_BE_FORMATTED=$(git diff --staged --name-only --diff-filter=du | grep -E '\.(cs|csproj|sln)$' || echo '')
+
+if [ -z "$FILES_TO_BE_FORMATTED" ]; then
+	echo "No .NET files to format, skipping dotnet format..."
+	exit 0
+fi
+
+echo "Files to be formatted:"
+for file in $FILES_TO_BE_FORMATTED; do
+    echo " - $file"
+done
+echo "" # new-line for clarity
+
+# Format c# related staged files only
+echo $FILES_TO_BE_FORMATTED | xargs dotnet format -v diag aplib.net-demo/aplib.net-demo.sln --include 
+
+# Add all formatted files again, to add changed files
+echo $FILES_TO_BE_FORMATTED | xargs git add
+
+echo -e "\nDone formatting files!\nCheck the log to find out if files have changed.\n"
 
-# Add files changed by husky to git
-git add .

README.md

@@ -1,2 +1,37 @@
-# aplib.net-demo
-A demo game for the APLib.NET library.
+# Aplib.Net Demo Game
+[![GitHub Release](https://img.shields.io/github/v/release/team-zomsa/aplib.net-demo?label=GitHub%20Release)
+](https://github.com/team-zomsa/aplib.net-demo/releases)
+[![GitHub Issues or Pull Requests](https://img.shields.io/github/issues/team-zomsa/aplib.net-demo)](https://github.com/team-zomsa/aplib.net-demo/issues)
+[![GitHub Issues or Pull Requests](https://img.shields.io/github/issues-pr/team-zomsa/aplib.net-demo)](https://github.com/team-zomsa/aplib.net-demo/pulls)
+
+
+## Overview
+A demo game that demonstrates the capabilities of the [Aplib.Net library](https://github.com/team-zomsa/aplib.net), more information can be found on its repository.
+
+The project makes use of Unity version 2022.3.19f1, meaning this is the version you will have to have installed to run the tests or build the game locally.
+Unity can be downloaded using the [Unity Hub](https://unity.com/unity-hub).
+
+
+## Testing
+The Unity Testing Framework, used for running tests in Unity, knows two types of tests:
+1. Edit mode tests, these run without running the entire game, and are defined as unit tests.
+2. Play mode tests, these run the game and test the game's functionality as a whole, this is where the Aplib.Net library comes into play.
+
+The tests, of which most importantly the play mode tests, that are used to demonstrate Aplib.Net, of the game are/can be run in two ways:
+1. In the GitHub Actions pipeline, where testing is done, the Unity Testing Framework is used to run playmode tests. Aplib.Net tests are defined to be used in the UTF, and results are uploaded as an artifact. To view this, take a look at the [Actions tab](https://github.com/team-zomsa/aplib.net-demo/actions), and select a pipeline run where testing is performed, then press `Test Results`.
+2. Locally, by opening the project in Unity and running the tests. This can be done by opening the Unity project, and navigating to the `Window` tab, then `General` and finally `Test Runner`. In the Test Runner, you can run all tests, or select specific tests to run. You will need to clone the repository to run the tests locally. Make sure to have the correct Unity version installed, as mentioned in the [Overview](#overview) section.
+
+
+## Running the game
+A build of the game can also be ran in multiple ways:
+1. A WebGL build gets generated and uploaded to GitHub pages automatically, and can be visited here: [Aplib.Net Demo Game](https://team-zomsa.github.io/aplib.net-demo/).
+2. The game can also be ran locally. Builds get generated automatically for Windows-64bit, Linux-64bit and OSX, these can be found in the [GitHub Release](https://github.com/team-zomsa/aplib.net-demo/releases).
+3. The game can be built locally, by cloning the repository and opening the project in Unity, making sure to have the correct Unity version installed, as mentioned in the [Overview](#overview) section. Then go to the build settings, select the platform you want to build for, and press `Build`. The build settings menu can be opened by pressing `Ctrl + Shift + B` or by navigating to the `File` tab, then `Build Settings`.
+
+
+## Contributing
+This game is purely for demonstration purposes and thus does not accept any contributions.
+
+
+## License
+The project is provided under the BSD 3 License, which can be found [here](https://github.com/team-zomsa/aplib.net-demo/blob/main/LICENSE).

aplib.net-demo/.editorconfig

@@ -12,7 +12,7 @@ indent_style = space
 tab_width = 4
 
 # New line preferences
-end_of_line = crlf
+end_of_line = lf
 insert_final_newline = true
 
 #### .NET Coding Conventions ####

aplib.net-demo/Assets/Materials/Colors/Green Mat.mat

@@ -0,0 +1,133 @@
+%YAML 1.1
+%TAG !u! tag:unity3d.com,2011:
+--- !u!114 &-4835959066232878665
+MonoBehaviour:
+  m_ObjectHideFlags: 11
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  m_GameObject: {fileID: 0}
+  m_Enabled: 1
+  m_EditorHideFlags: 0
+  m_Script: {fileID: 11500000, guid: d0353a89b1f911e48b9e16bdc9f2e058, type: 3}
+  m_Name: 
+  m_EditorClassIdentifier: 
+  version: 7
+--- !u!21 &2100000
+Material:
+  serializedVersion: 8
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  m_Name: Green Mat
+  m_Shader: {fileID: 4800000, guid: 933532a4fcc9baf4fa0491de14d08ed7, type: 3}
+  m_Parent: {fileID: 0}
+  m_ModifiedSerializedProperties: 0
+  m_ValidKeywords: []
+  m_InvalidKeywords: []
+  m_LightmapFlags: 4
+  m_EnableInstancingVariants: 0
+  m_DoubleSidedGI: 0
+  m_CustomRenderQueue: -1
+  stringTagMap:
+    RenderType: Opaque
+  disabledShaderPasses: []
+  m_LockedProperties: 
+  m_SavedProperties:
+    serializedVersion: 3
+    m_TexEnvs:
+    - _BaseMap:
+        m_Texture: {fileID: 0}
+        m_Scale: {x: 1, y: 1}
+        m_Offset: {x: 0, y: 0}
+    - _BumpMap:
+        m_Texture: {fileID: 0}
+        m_Scale: {x: 1, y: 1}
+        m_Offset: {x: 0, y: 0}
+    - _DetailAlbedoMap:
+        m_Texture: {fileID: 0}
+        m_Scale: {x: 1, y: 1}
+        m_Offset: {x: 0, y: 0}
+    - _DetailMask:
+        m_Texture: {fileID: 0}
+        m_Scale: {x: 1, y: 1}
+        m_Offset: {x: 0, y: 0}
+    - _DetailNormalMap:
+        m_Texture: {fileID: 0}
+        m_Scale: {x: 1, y: 1}
+        m_Offset: {x: 0, y: 0}
+    - _EmissionMap:
+        m_Texture: {fileID: 0}
+        m_Scale: {x: 1, y: 1}
+        m_Offset: {x: 0, y: 0}
+    - _MainTex:
+        m_Texture: {fileID: 0}
+        m_Scale: {x: 1, y: 1}
+        m_Offset: {x: 0, y: 0}
+    - _MetallicGlossMap:
+        m_Texture: {fileID: 0}
+        m_Scale: {x: 1, y: 1}
+        m_Offset: {x: 0, y: 0}
+    - _OcclusionMap:
+        m_Texture: {fileID: 0}
+        m_Scale: {x: 1, y: 1}
+        m_Offset: {x: 0, y: 0}
+    - _ParallaxMap:
+        m_Texture: {fileID: 0}
+        m_Scale: {x: 1, y: 1}
+        m_Offset: {x: 0, y: 0}
+    - _SpecGlossMap:
+        m_Texture: {fileID: 0}
+        m_Scale: {x: 1, y: 1}
+        m_Offset: {x: 0, y: 0}
+    - unity_Lightmaps:
+        m_Texture: {fileID: 0}
+        m_Scale: {x: 1, y: 1}
+        m_Offset: {x: 0, y: 0}
+    - unity_LightmapsInd:
+        m_Texture: {fileID: 0}
+        m_Scale: {x: 1, y: 1}
+        m_Offset: {x: 0, y: 0}
+    - unity_ShadowMasks:
+        m_Texture: {fileID: 0}
+        m_Scale: {x: 1, y: 1}
+        m_Offset: {x: 0, y: 0}
+    m_Ints: []
+    m_Floats:
+    - _AlphaClip: 0
+    - _AlphaToMask: 0
+    - _Blend: 0
+    - _BlendModePreserveSpecular: 1
+    - _BumpScale: 1
+    - _ClearCoatMask: 0
+    - _ClearCoatSmoothness: 0
+    - _Cull: 2
+    - _Cutoff: 0.5
+    - _DetailAlbedoMapScale: 1
+    - _DetailNormalMapScale: 1
+    - _DstBlend: 0
+    - _DstBlendAlpha: 0
+    - _EnvironmentReflections: 1
+    - _GlossMapScale: 0
+    - _Glossiness: 0
+    - _GlossyReflections: 0
+    - _Metallic: 0
+    - _OcclusionStrength: 1
+    - _Parallax: 0.005
+    - _QueueOffset: 0
+    - _ReceiveShadows: 1
+    - _Smoothness: 0.5
+    - _SmoothnessTextureChannel: 0
+    - _SpecularHighlights: 1
+    - _SrcBlend: 1
+    - _SrcBlendAlpha: 1
+    - _Surface: 0
+    - _WorkflowMode: 1
+    - _ZWrite: 1
+    m_Colors:
+    - _BaseColor: {r: 0.20202932, g: 0.5773585, b: 0.18192236, a: 1}
+    - _Color: {r: 0.20202929, g: 0.5773585, b: 0.18192232, a: 1}
+    - _EmissionColor: {r: 0, g: 0, b: 0, a: 1}
+    - _SpecColor: {r: 0.19999996, g: 0.19999996, b: 0.19999996, a: 1}
+  m_BuildTextureStacks: []

aplib.net-demo/Assets/Materials/Player.mat → aplib.net-demo/Assets/Materials/Colors/Red Mat.mat

@@ -20,7 +20,7 @@ Material:
   m_CorrespondingSourceObject: {fileID: 0}
   m_PrefabInstance: {fileID: 0}
   m_PrefabAsset: {fileID: 0}
-  m_Name: Player
+  m_Name: Red Mat
   m_Shader: {fileID: 4800000, guid: 933532a4fcc9baf4fa0491de14d08ed7, type: 3}
   m_Parent: {fileID: 0}
   m_ModifiedSerializedProperties: 0

aplib.net-demo/Assets/Materials/Green Mat.mat

@@ -0,0 +1,133 @@
+%YAML 1.1
+%TAG !u! tag:unity3d.com,2011:
+--- !u!114 &-4835959066232878665
+MonoBehaviour:
+  m_ObjectHideFlags: 11
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  m_GameObject: {fileID: 0}
+  m_Enabled: 1
+  m_EditorHideFlags: 0
+  m_Script: {fileID: 11500000, guid: d0353a89b1f911e48b9e16bdc9f2e058, type: 3}
+  m_Name: 
+  m_EditorClassIdentifier: 
+  version: 7
+--- !u!21 &2100000
+Material:
+  serializedVersion: 8
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  m_Name: Green Mat
+  m_Shader: {fileID: 4800000, guid: 933532a4fcc9baf4fa0491de14d08ed7, type: 3}
+  m_Parent: {fileID: 0}
+  m_ModifiedSerializedProperties: 0
+  m_ValidKeywords: []
+  m_InvalidKeywords: []
+  m_LightmapFlags: 4
+  m_EnableInstancingVariants: 0
+  m_DoubleSidedGI: 0
+  m_CustomRenderQueue: -1
+  stringTagMap:
+    RenderType: Opaque
+  disabledShaderPasses: []
+  m_LockedProperties: 
+  m_SavedProperties:
+    serializedVersion: 3
+    m_TexEnvs:
+    - _BaseMap:
+        m_Texture: {fileID: 0}
+        m_Scale: {x: 1, y: 1}
+        m_Offset: {x: 0, y: 0}
+    - _BumpMap:
+        m_Texture: {fileID: 0}
+        m_Scale: {x: 1, y: 1}
+        m_Offset: {x: 0, y: 0}
+    - _DetailAlbedoMap:
+        m_Texture: {fileID: 0}
+        m_Scale: {x: 1, y: 1}
+        m_Offset: {x: 0, y: 0}
+    - _DetailMask:
+        m_Texture: {fileID: 0}
+        m_Scale: {x: 1, y: 1}
+        m_Offset: {x: 0, y: 0}
+    - _DetailNormalMap:
+        m_Texture: {fileID: 0}
+        m_Scale: {x: 1, y: 1}
+        m_Offset: {x: 0, y: 0}
+    - _EmissionMap:
+        m_Texture: {fileID: 0}
+        m_Scale: {x: 1, y: 1}
+        m_Offset: {x: 0, y: 0}
+    - _MainTex:
+        m_Texture: {fileID: 0}
+        m_Scale: {x: 1, y: 1}
+        m_Offset: {x: 0, y: 0}
+    - _MetallicGlossMap:
+        m_Texture: {fileID: 0}
+        m_Scale: {x: 1, y: 1}
+        m_Offset: {x: 0, y: 0}
+    - _OcclusionMap:
+        m_Texture: {fileID: 0}
+        m_Scale: {x: 1, y: 1}
+        m_Offset: {x: 0, y: 0}
+    - _ParallaxMap:
+        m_Texture: {fileID: 0}
+        m_Scale: {x: 1, y: 1}
+        m_Offset: {x: 0, y: 0}
+    - _SpecGlossMap:
+        m_Texture: {fileID: 0}
+        m_Scale: {x: 1, y: 1}
+        m_Offset: {x: 0, y: 0}
+    - unity_Lightmaps:
+        m_Texture: {fileID: 0}
+        m_Scale: {x: 1, y: 1}
+        m_Offset: {x: 0, y: 0}
+    - unity_LightmapsInd:
+        m_Texture: {fileID: 0}
+        m_Scale: {x: 1, y: 1}
+        m_Offset: {x: 0, y: 0}
+    - unity_ShadowMasks:
+        m_Texture: {fileID: 0}
+        m_Scale: {x: 1, y: 1}
+        m_Offset: {x: 0, y: 0}
+    m_Ints: []
+    m_Floats:
+    - _AlphaClip: 0
+    - _AlphaToMask: 0
+    - _Blend: 0
+    - _BlendModePreserveSpecular: 1
+    - _BumpScale: 1
+    - _ClearCoatMask: 0
+    - _ClearCoatSmoothness: 0
+    - _Cull: 2
+    - _Cutoff: 0.5
+    - _DetailAlbedoMapScale: 1
+    - _DetailNormalMapScale: 1
+    - _DstBlend: 0
+    - _DstBlendAlpha: 0
+    - _EnvironmentReflections: 1
+    - _GlossMapScale: 0
+    - _Glossiness: 0
+    - _GlossyReflections: 0
+    - _Metallic: 0
+    - _OcclusionStrength: 1
+    - _Parallax: 0.005
+    - _QueueOffset: 0
+    - _ReceiveShadows: 1
+    - _Smoothness: 0.5
+    - _SmoothnessTextureChannel: 0
+    - _SpecularHighlights: 1
+    - _SrcBlend: 1
+    - _SrcBlendAlpha: 1
+    - _Surface: 0
+    - _WorkflowMode: 1
+    - _ZWrite: 1
+    m_Colors:
+    - _BaseColor: {r: 0.20202932, g: 0.5773585, b: 0.18192236, a: 1}
+    - _Color: {r: 0.20202929, g: 0.5773585, b: 0.18192232, a: 1}
+    - _EmissionColor: {r: 0, g: 0, b: 0, a: 1}
+    - _SpecColor: {r: 0.19999996, g: 0.19999996, b: 0.19999996, a: 1}
+  m_BuildTextureStacks: []