From 0975cbb9e26e9f747789c611fe3f75d1f26da413 Mon Sep 17 00:00:00 2001 From: Jackson Date: Tue, 12 Dec 2023 16:07:49 +1300 Subject: [PATCH] Readme update --- README.md | 24 ++++++++++++++++--- .../Promul.Runtime.Unity.csproj | 4 ---- 2 files changed, 21 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 6c6d0be..7b4e0a6 100644 --- a/README.md +++ b/README.md @@ -27,13 +27,31 @@ You should now be ready to use Promul as a relay server for your Unity project. ## Engineering ```mermaid flowchart TD + subgraph Unity + Code[Your Unity code] -->|Unity Netcode| Runtime[Promul.Runtime.Unity] + end + + subgraph Unreal Engine + UECode[Your UE code] --> RuntimeUE["Promul.Runtime.Unreal\n(planned)"] + end + subgraph "Protocol layer" - A[Your Unity code] -->|Unity Netcode| B[Promul.Runtime.Unity] + Protocol[Promul.Relay.Protocol] end + Protocol-->Core + Runtime-->Protocol + RuntimeUE-->Protocol + + subgraph Relay server + API[Promul.Server.API\nFront-facing]-->Server[Promul.Server] + Server-->Protocol + end + subgraph Transit layer - B --> C[Promul.Common\nKey networking capabilities] + Core[Promul\nKey networking capabilities] + Core-->Native[Native sockets] + Core-->Managed[Managed sockets] end - D[Promul.Server] -->|Relay server| C ``` ### Transit layer diff --git a/src/Promul.Runtime.Unity/Promul.Runtime.Unity.csproj b/src/Promul.Runtime.Unity/Promul.Runtime.Unity.csproj index 0bf4317..489aae3 100644 --- a/src/Promul.Runtime.Unity/Promul.Runtime.Unity.csproj +++ b/src/Promul.Runtime.Unity/Promul.Runtime.Unity.csproj @@ -20,10 +20,6 @@ - - {009a3a68-30a0-44eb-9b42-8fcb6bd89195} - Promul.Common -