mirror of
https://github.com/MirrorNetworking/Mirror.git
synced 2024-11-18 19:10:32 +00:00
9fc28d9800
Fixed typo and added image.
21 lines
1.5 KiB
Markdown
21 lines
1.5 KiB
Markdown
# FizzySteam
|
|
|
|
Fizzy Steam is a Steam P2P transport for Mirror, it utilizes Steam's P2P service to directly connect or relay your connection to another player. Fizzy Steam is based of [Steamworks.Net](https://github.com/rlabrecque/Steamworks.NET) wrapper.
|
|
|
|
You can get the release **[Here](https://github.com/Raystorms/FizzySteamyMirror/releases)** with the latest version of Steamworks.Net included or you can clone the repo **[Here](https://github.com/Raystorms/FizzySteamyMirror)**.
|
|
|
|
## Features
|
|
|
|
* Multiple Customizable Channels : You can customize the channels in the transport, whether you want just 1 or 5 channels that are unrealiable or realiable (best to leave channel 0 as reliable).
|
|
* Steam Nat Punching & Relay : The transport will use Steam to do Nat Punching to your destination, and if that doesn't work, steam's relay Server will be used to ensure you can alway connect (latency may vary).
|
|
* No Code Changes Needed : If you Already use Mirror, you just need to slap this transport in (maybe add your steam App ID in your build), and everything should work the same like any other Mirror Transport. "It Just Works" -Todd Howard
|
|
|
|
![The Fizzy Transport component in the Inspector window](SteamTransport.PNG)
|
|
|
|
## Credits
|
|
* [Fizz Cube](https://github.com/FizzCube) : Original author for this Transport.
|
|
* [Raystorms](https://github.com/Raystorms) : The current maintainer for this Tranport.
|
|
* [rlabrecque](https://github.com/rlabrecque) : Creator of Steamworks.Net.
|
|
* [vis2k](https://github.com/vis2k) : Creator of Mirror.
|
|
* Valve : Steam
|