search

FirstGearGames / FishySteamworks

A Steamworks implementation for Fish-Net.
Other
80 stars 18 forks source link

readme

FishySteamworks

A Steamworks implementation for Fish-Networking.

Thank you Heathen Engineering for your support.

Dependencies

Fish-Networking https://github.com/FirstGearGames/FishNet

.Net 4.5x

These projects need to be installed and working before you can use this transport.

  1. SteamWorks.NET FishySteamworks relies on Steamworks.NET to communicate with the Steamworks API(https://partner.steamgames.com/doc/sdk). Installation guide by Heathen Engineering: https://kb.heathenengineering.com/assets/steamworks/installation

Installation

  1. Download the latest release from the releases page.
  2. Open and import FishySteamworks.unitypackage into your project.
  3. Set up your project as described below.

Setting Up

  1. Add FishySteamworks component to your NetworkManager object. Either remove other transports or add TransportManager and specify which transport to use.

  2. Choose Peer to Peer to connect using the Steam relay.

  3. Set your AppId. You may need to add SteamManager to your NetworkManager object; if you need a SteamManager to get started import FishNet\Plugins\FishySteamworks\SteamManager.unitypackage. Some frameworks such as Heathen Engineerings' use their own version of SteamManager. Please consult their discord here https://discord.gg/SGd4vkRdSe for more information on using their assets.

Host

You may host as server only, or client and server in a single executable.

Client

Clients connect to one-another by using the host's steamId64. You can get this information within your Steam application. To do so open Steam, go to the View menu, Settings, Interface. Ensure 'Display web address bars when available' is checked. Next view your profile within Steam. Your steamId64 is the large number at the end of your profile URL.

Connecting to a host is easy as putting the steamId64 in the 'Client Address' field of FishySteamworks and starting the client. You may instead start client by calling ClientManager.StartConnection(steamId64);

Testing Two Builds Locally

Steam has limitations which prevent you from connecting to yourself locally over two builds. To do so, you must have two steam Ids, on two separate devices. You however may run as server and client in a single executable. If you need to test using two builds(or editors) on a single device you will have to use the default transport.