https://github.com/matthewshirley/fishyutp
Unity Transport Package (UTP) for Fish-Networking.
https://github.com/matthewshirley/fishyutp
fish-net unity unity3d
Last synced: 25 days ago
JSON representation
Unity Transport Package (UTP) for Fish-Networking.
- Host: GitHub
- URL: https://github.com/matthewshirley/fishyutp
- Owner: matthewshirley
- License: mit
- Created: 2022-11-07T02:47:41.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-11-15T03:56:08.000Z (over 2 years ago)
- Last Synced: 2025-03-27T02:39:24.130Z (about 1 month ago)
- Topics: fish-net, unity, unity3d
- Language: C#
- Homepage:
- Size: 49.8 KB
- Stars: 9
- Watchers: 2
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# FishyUTP
A Unity Transport (UTP) implementation for Fish-Net, a feature-rich Unity networking solution aimed towards reliability, ease of use, efficiency, and flexibility.
## Need Help?
This transport does not have first-party support and is a community maintained project.
- Raise an [Issue](https://github.com/matthewshirley/FishyUTP/issues) or start a [Discussion](https://github.com/matthewshirley/FishyUTP/discussions) for questions or bugs regarding FishyUTP.
- Create a [Pull Request](https://github.com/matthewshirley/FishyUTP/pulls) to propose a change or fix a bug.
- Chat in the [Fish-Net Discord](https://discord.gg/fishnetworking) if you have questions about the Fish-Net library.
## Compatibility
This transport library is in early development and should not be used for a production project.
Feature Compatibility
The following is the anticipated features this library will support in the future. Propose new features via GitHub Issues or Pull Request.
| Feature | Supported |
|-----------------| --------- |
| Transport | 🔨 |
| Jobified | ❌ |
| Relay | 🔨 |
- ✅ -- Implemented
- 🔨 -- Partially implemented
- ❌ -- Not implemented
## Install
### Install Dependencies
Ensure you have installed the required dependencies using the Unity Package Manager:
* [Fish-Net: Networking Evolved](https://assetstore.unity.com/packages/tools/network/fish-net-networking-evolved-207815)
* [com.unity.transport](https://docs-multiplayer.unity3d.com/transport/current/install)
* [com.unity.services.relay](https://docs.unity.com/relay/get-started.html)
### Install Transport
#### via git
* Open the Unity Package Manager by navigating to Window > Package Manager
* Click Add in the status bar.
* Select "Add package via Git URL"
* Input "https://github.com/matthewshirley/FishyUTP.git?path=/FishNet/Plugins/FishyUTP"
* Click "Add"
#### Manual
Move the `FishNet` folder from this repository to the `Assets` folder in your Unity project.
#### Transport Component
Add the "FishyUTP" transport component to the "NetworkManager" game object.
### Configure Relay
FishyUTP supports creating and joining Unity Relay allocations to simplify and secure network connectivity. This is an optional feature that can be disable on FishyUTP transport ("Use Relay").
* Add the "FishyUTP Relay Manager" component to the game object that contains the "FishyUTP" and "NetworkManager" component.
* On the "FishyUTP" component:
* Enable "Use Relay"
* Enable "Login To Unity Services" if you are not already doing so elsewhere in your application
The "Join Code" on the "FishyUTP Relay Manager" represents either the join code generated for the host allocation or the join allocation the client will attempt to connect to.