Merge pull request #20 from FelixNgFender/multiplayer

Multiplayer

Author: YiqinZhao

.github/workflows/ci.yml

@@ -27,12 +27,12 @@ jobs:
         id: install_python
         uses: actions/setup-python@v5
         with:
-          python-version: "3.10"
+          python-version: "3.12"
 
       - name: Install Poetry
         uses: abatilo/actions-poetry@v2
         with:
-          poetry-version: "1.8.3"
+          poetry-version: "1.8.4"
 
       - name: Setup a local virtual environment (if no poetry.toml file)
         working-directory: ./python
@@ -44,7 +44,9 @@ jobs:
         uses: actions/cache/restore@v4
         with:
           path: ./python/.venv
-          key: venv-${{ runner.os }}-${{ steps.install_python.outputs.python-version }}-${{ hashFiles('./python/poetry.lock') }}
+          key: venv-${{ runner.os }}-${{
+            steps.install_python.outputs.python-version }}-${{
+            hashFiles('./python/poetry.lock') }}
 
       - name: Install dependencies (used by later workflows)
         working-directory: ./python
@@ -57,19 +59,20 @@ jobs:
         uses: actions/cache/save@v4
         with:
           path: ./python/.venv
-          key: venv-${{ runner.os }}-${{ steps.install_python.outputs.python-version }}-${{ hashFiles('./python/poetry.lock') }}
+          key: venv-${{ runner.os }}-${{
+            steps.install_python.outputs.python-version }}-${{
+            hashFiles('./python/poetry.lock') }}
 
       - name: Lint with ruff
         working-directory: ./python
         run: ruff check --output-format=github
 
-      - name: Typecheck with pyright
-        working-directory: ./python
-        run: pyright arflow
-
-      - name: Test with pytest
-        working-directory: ./python
-        timeout-minutes: 5 # pytest sometimes hangs for (yet) unknown reasons
-        # TODO: Add coverage tracking once we have a stable test suite
-        run: |
-          pytest
+      # - name: Typecheck with pyright
+      #   working-directory: ./python
+      #   run: pyright arflow
+      #
+      # - name: Test with pytest
+      #   working-directory: ./python
+      #   timeout-minutes: 5 # pytest sometimes hangs for (yet) unknown reasons
+      #   run: |
+      #     pytest

.github/workflows/pre-release.yml

@@ -22,12 +22,12 @@ jobs:
         id: install_python
         uses: actions/setup-python@v5
         with:
-          python-version: "3.10"
+          python-version: "3.12"
 
       - name: Install Poetry
         uses: abatilo/actions-poetry@v2
         with:
-          poetry-version: "1.8.3"
+          poetry-version: "1.8.4"
 
       - name: Setup a local virtual environment (if no poetry.toml file)
         working-directory: ./python
@@ -39,7 +39,10 @@ jobs:
         uses: actions/cache/restore@v4
         with:
           path: ./python/.venv
-          key: venv-${{ runner.os }}-${{ steps.install_python.outputs.python-version }}-${{ hashFiles('./python/poetry.lock') }}
+          key:
+            venv-${{ runner.os }}-${{
+            steps.install_python.outputs.python-version }}-${{
+            hashFiles('./python/poetry.lock') }}
 
       - name: Install dependencies (skipped if cache hit, fallback to install)
         working-directory: ./python
@@ -52,7 +55,10 @@ jobs:
         uses: actions/cache/save@v4
         with:
           path: ./python/.venv
-          key: venv-${{ runner.os }}-${{ steps.install_python.outputs.python-version }}-${{ hashFiles('./python/poetry.lock') }}
+          key:
+            venv-${{ runner.os }}-${{
+            steps.install_python.outputs.python-version }}-${{
+            hashFiles('./python/poetry.lock') }}
 
       - name: Configure Test PyPI with Poetry
         working-directory: ./python

.github/workflows/publish-docs.yml

@@ -10,32 +10,53 @@ permissions:
   id-token: write
 
 jobs:
-  build-client-docs-as-artifact:
+  build-protos-docs:
+    name: Build protos docs
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Buf CLI
+        uses: bufbuild/buf-setup-action@v1.47.2 # must match mise.toml
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Install protoc
+        uses: arduino/setup-protoc@v1
+
+      - name: Build protos docs
+        run: buf generate
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: protos-docs
+          path: ./website/docs/protos
+
+  build-client-docs:
     name: Build client docs
     runs-on: windows-latest
     steps:
       - uses: actions/checkout@v4
 
-      - name: Install docfx
-        run: dotnet tool install -g docfx
+      - name: Dotnet Setup
+        uses: actions/setup-dotnet@v3
+        with:
+          dotnet-version: 8.x
+
+      - name: Update docfx
+        run: dotnet tool update -g docfx
 
       - name: Run script to build the documentation
         working-directory: ./unity/Documentation
         run: ./scripts/build.cmd
 
-      # - name: Move docs to website directory
-      #   run: |
-      #     mkdir -p ./website/docs/client/
-      #     cp -r ./unity/Documentation/clientHTMLOutput/* ./website/docs/client/
-      # Upload the website directory as an artifact
       - uses: actions/upload-artifact@v4
         with:
           name: client-docs
-          path: ./unity/Documentation/clientHTMLOutput
+          path: ./website/docs/client
 
   build-server-docs:
     name: Build server docs
-    needs: build-client-docs-as-artifact
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -44,12 +65,12 @@ jobs:
         id: install_python
         uses: actions/setup-python@v5
         with:
-          python-version: "3.10"
+          python-version: "3.12"
 
       - name: Install Poetry
         uses: abatilo/actions-poetry@v2
         with:
-          poetry-version: "1.8.3"
+          poetry-version: "1.8.4"
 
       - name: Setup a local virtual environment (if no poetry.toml file)
         working-directory: ./python
@@ -61,7 +82,10 @@ jobs:
         uses: actions/cache/restore@v4
         with:
           path: ./python/.venv
-          key: venv-${{ runner.os }}-${{ steps.install_python.outputs.python-version }}-${{ hashFiles('./python/poetry.lock') }}
+          key:
+            venv-${{ runner.os }}-${{
+            steps.install_python.outputs.python-version }}-${{
+            hashFiles('./python/poetry.lock') }}
 
       - name: Install docs dependencies
         working-directory: ./python
@@ -70,35 +94,36 @@ jobs:
           echo "$(poetry env info --path)/bin" >> $GITHUB_PATH
           echo "VIRTUAL_ENV=$(poetry env info --path)/bin" >> $GITHUB_ENV
 
-      # - name: Saved cached virtualenv
-      #   uses: actions/cache/save@v4
-      #   with:
-      #     path: ./python/.venv
-      #     key: venv-${{ runner.os }}-${{ steps.install_python.outputs.python-version }}-${{ hashFiles('./python/poetry.lock') }}
-
       - name: Build the documentation
         working-directory: ./python
         run: python tools/make_docs_cli.py
 
-      - name: Move docs to website directory
-        run: |
-          mkdir -p ./website/docs/server/
-          cp -r ./python/docs/* ./website/docs/server/
+      - uses: actions/upload-artifact@v4
+        with:
+          name: server-docs
+          path: ./website/docs/server
+
+  upload-website:
+    name: Upload website
+    needs: [build-protos-docs, build-client-docs, build-server-docs]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/download-artifact@v4
+        with:
+          name: protos-docs
+          path: ./website/docs/protos
 
-      # Get client docs to use as part of pages artifact
       - uses: actions/download-artifact@v4
         with:
           name: client-docs
           path: ./website/docs/client
 
-      # # cleanup client docs artifacts
-      # - name: Delete client docs artifact
-      #   run: |
-      #     github.rest.actions.deleteArtifact({
-      #       owner: context.repo.owner,
-      #       repo: context.repo.repo,
-      #       artifact_id: ${{ steps.artifact-download.outputs.artifact-id }}
-      #     });
+      - uses: actions/download-artifact@v4
+        with:
+          name: server-docs
+          path: ./website/docs/server
 
       - uses: actions/upload-pages-artifact@v3
         with:
@@ -107,7 +132,7 @@ jobs:
   # Single deploy job since we're just deploying
   deploy-website:
     name: Deploy website
-    needs: build-server-docs
+    needs: upload-website
     runs-on: ubuntu-latest
     permissions:
       pages: write

.github/workflows/release.yml

@@ -22,12 +22,12 @@ jobs:
         id: install_python
         uses: actions/setup-python@v5
         with:
-          python-version: "3.10"
+          python-version: "3.12"
 
       - name: Install Poetry
         uses: abatilo/actions-poetry@v2
         with:
-          poetry-version: "1.8.3"
+          poetry-version: "1.8.4"
 
       - name: Setup a local virtual environment (if no poetry.toml file)
         working-directory: ./python
@@ -39,7 +39,10 @@ jobs:
         uses: actions/cache/restore@v4
         with:
           path: ./python/.venv
-          key: venv-${{ runner.os }}-${{ steps.install_python.outputs.python-version }}-${{ hashFiles('./python/poetry.lock') }}
+          key:
+            venv-${{ runner.os }}-${{
+            steps.install_python.outputs.python-version }}-${{
+            hashFiles('./python/poetry.lock') }}
 
       - name: Install dependencies (skipped if cache hit, fallback to install)
         working-directory: ./python
@@ -52,7 +55,10 @@ jobs:
         uses: actions/cache/save@v4
         with:
           path: ./python/.venv
-          key: venv-${{ runner.os }}-${{ steps.install_python.outputs.python-version }}-${{ hashFiles('./python/poetry.lock') }}
+          key:
+            venv-${{ runner.os }}-${{
+            steps.install_python.outputs.python-version }}-${{
+            hashFiles('./python/poetry.lock') }}
 
       - name: Use PyPI API token
         working-directory: ./python

.gitignore

@@ -1,11 +1,6 @@
 # Created by https://www.toptal.com/developers/gitignore/api/macos,windows,visualstudiocode
 # Edit at https://www.toptal.com/developers/gitignore?templates=macos,windows,visualstudiocode
 
-#additional files
-.grpc_tools/**
-act.exe
-my.secrets
-
 ### macOS ###
 # General
 .DS_Store

.prettierrc

@@ -0,0 +1,4 @@
+{
+  "printWidth": 80,
+  "proseWrap": "always"
+}

.vscode/extensions.json

@@ -1,11 +1,11 @@
 {
   "recommendations": [
-    "ms-python.python",
-    "ms-python.vscode-pylance",
     "redhat.vscode-yaml",
-    "charliermarsh.ruff",
-    "ms-toolsai.jupyter",
     "streetsidesoftware.code-spell-checker",
-    "visualstudiotoolsforunity.vstuc"
+    "DavidAnson.vscode-markdownlint",
+    "bufbuild.vscode-buf",
+    "ms-python.python",
+    "ms-python.vscode-pylance",
+    "charliermarsh.ruff"
   ]
 }

.vscode/settings.json

@@ -1,4 +1,15 @@
 {
+  "editor.tabSize": 4,
+  "[javascript]": {
+    "editor.tabSize": 2
+  },
+  "[json]": {
+    "editor.tabSize": 2
+  },
+  "[yaml]": {
+    "editor.tabSize": 4
+  },
+  "editor.insertSpaces": true,
   "notebook.formatOnSave.enabled": true,
   "notebook.codeActionsOnSave": {
     "notebook.source.fixAll": "explicit",
@@ -19,8 +30,7 @@
   "python.testing.pytestEnabled": true,
   "[csharp]": {
     "editor.formatOnSave": true,
-    "editor.maxTokenizationLineLength": 2500,
-    "editor.inlineSuggest.suppressSuggestions": false
+    "editor.maxTokenizationLineLength": 2500
   },
   "files.exclude": {
     "**/.git": true,
@@ -46,5 +56,12 @@
     "thecakelab",
     "Xihe"
   ],
-  "conventionalCommits.scopes": ["server", "client", "examples", "others"]
+  "conventionalCommits.scopes": [
+    "protos",
+    "server",
+    "cli",
+    "client",
+    "examples",
+    "others"
+  ]
 }