Skip to content

Commit

Permalink
Readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
jacksonrakena committed Dec 12, 2023
1 parent 99821eb commit 0975cbb
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 7 deletions.
24 changes: 21 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 0 additions & 4 deletions src/Promul.Runtime.Unity/Promul.Runtime.Unity.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,6 @@
</ItemGroup>
<ItemGroup>
<Content Include="com.fireworkeyes.netcode.transport.promul.asmdef"/>
<ProjectReference Include="..\Promul\Promul.csproj">
<Project>{009a3a68-30a0-44eb-9b42-8fcb6bd89195}</Project>
<Name>Promul.Common</Name>
</ProjectReference>
<ProjectReference Include="..\Promul.Relay.Protocol\Promul.Relay.Protocol.csproj" />
</ItemGroup>
<ItemGroup>
Expand Down

0 comments on commit 0975cbb

Please sign in to comment.