Skip to content

Commit 5e70190

Browse files
docs: update architecture.md for transport picker removal (#651)
* updated the Architecture.md file to reflect the removal of TransportPicker * updated changelog
1 parent df9985d commit 5e70190

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

ARCHITECTURE.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The Boss Room network connection flow is owned by the `GameNetPortal`:
3232
Game data in Boss Room is defined in `ScriptableObjects`. The `ScriptableObjects` are organized by enum and made available in a singleton class: the `GameDataSource`, in particular `ActionDescription` and `CharacterData`. `Actions` represent discrete verbs (like swinging a weapon, or reviving someone), and are substantially data driven. Characters represent both the different player classes, and also monsters, and represent basic details like health, as well as what "Skill" Actions are available to each Character.
3333

3434
## Transports
35-
Currently three network transport mechanisms are supported:
35+
Currently two network transport mechanisms are supported:
3636
- IP based
3737
- Unity Relay Based
3838

@@ -42,9 +42,8 @@ For Unity Relay based multiplayer sessions, some setup is required. Please see o
4242

4343
Please see [Multiplayer over internet](README.md) section of our Readme for more information on using either one.
4444

45-
To allow for any of these options to be chosen at runtime we created `TransportPicker`. It allows one to choose between an IP-based and a Relay-based transport and will hook up the game UI to use those transports. The transport field in the `NetworkManager` will be ignored. Currently we support the following transports:
46-
- **UTP (IP):** Unity Transport Package is a network transport layer, packaged with network simulation tools which are useful for spotting networking issues early during development. This IP based protocol is the default IP transport for Boss Room. See the documentation on [Unity Transport Package](https://docs-multiplayer.unity3d.com/docs/transport-utp/about-transport-utp/#unity-transport-package-utp).
47-
- **Unity (Relay):** Unity Relay is a relay service provided by Unity services, supported by Unity Transport. Read more about [Unity Relay](https://docs-multiplayer.unity3d.com/docs/relay/relay).
45+
The transport is set in the transport field in the `NetworkManager`. We are using the following transport:
46+
- **Unity Transport Package (UTP):** Unity Transport Package is a network transport layer, packaged with network simulation tools which are useful for spotting networking issues early during development. This protocol is initialized to use direct IP to connect, but is configured at runtime to use Unity Relay if starting a game as a host using the Lobby Service, or joining a Lobby as a client. Unity Relay is a relay service provided by Unity services, supported by Unity Transport. See the documentation on [Unity Transport Package](https://docs-multiplayer.unity3d.com/docs/transport-utp/about-transport-utp/#unity-transport-package-utp) and on [Unity Relay](https://docs-multiplayer.unity3d.com/docs/relay/relay).
4847

4948
To add new transports in the project, parts of `GameNetPortal` and `ClientGameNetPortal` (transport switches) need to be extended.
5049

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ chore: bump boss room to 2021 [MTT-3022] (#620)
2222
fix: folders and assemblies refactor MTT-2623, MTT-2615 (#628)
2323

2424
### Removed
25+
chore: remove UNET [MTT-3435] (#638) --> removed deprecated UNET transport from Boss Room
2526

2627
### Fixed
2728

0 commit comments

Comments
 (0)