PEAKNetworkingLibrary

PEAKNetworkingLibrary -> Update

--

 

A library mod for networking specifically with Steam with other platform compatibility.

   PEAKNetworkingLibrary has its own NuGet package, you can find it here.

Update Info  •  FAQ  •  Features  •  Examples  •  Install  •  Security  •  Efficiency Guidance  •  Support

 

Update

Contains information related to the current update.

Details → (click to expand)

 

• Implemented support for tables in the messages.
• Patched issues with RPC not being sent or received.

 

FAQ

Contains commonly asked questions.

FAQ → (click to expand)

 

• Q: Do I need to create or initialize the networking service?

No. The library auto-instantiates and initializes the correct service (Steam or Offline) on load and auto-creates a poller. Mod authors should access the service via Net.Service and do not call Initialize() or PollReceive() themselves.

 

Features

Contains information related to features that do function.

Feature list [DOES NOT INCLUDE EVERYTHING] → (click to expand)

 

AS OF VERSION 1.0.1:

• Automatic initialization & poller. Library auto-creates service and runs receive poller; mod authors only consume Net.Service.
• ModId helpers. ModId.FromGuid(string).
• Wire-efficient keys. API accepts human-friendly strings but sends small 32-bit keys on the wire (local map + fallback).
• All old functions are still usable and can be used, though it is recommended to swap over to new system.
• Backend

INetworkingService provides one surface mods use. Swap Steam vs Offline without code changes.

• Lobby key sync (host -> clients)

Host sets small authoritative strings via SetLobbyData. Clients read with GetLobbyData and LobbyDataChanged event.

• RPC discovery & invocation

Discover methods marked [CustomRPC] with RegisterNetworkObject and call RPC, RPCTarget, or RPCToHost.

• Message serialization

Message class supports: byte, int, uint, long, ulong, float, bool, string, byte, Vector3, Quaternion, CSteamID.

• Reliable vs Unreliable

ReliableType enum supports Reliable, Unreliable, UnreliableNoDelay semantics.

• Security (optional)

Optional HMAC signing, per-mod signer hooks, sequence numbers, replay protection.

• Framing & priority

Per-message flags, msg-id, sequence, fragment metadata, priority queues.

• Offline shim for CI

Full in-process simulator to run tests without Steam.

• Incoming validation hook

IncomingValidator lets consumers drop or accept messages before handler invocation.

• Poll-based receive loop

PollReceive() is required for Steam adapter; Offline shim is immediate.

API References [DOES NOT INCLUDE EVERYTHING] → (click to expand)

| Key | Type | Meaning |

|-------------------------|----------|-------------------------------------------------------------------------|

| NetworkingPhotonExtensions | Method | Dictionary MapPhotonActorsToSteam |

| ModId | Method | FromGuid(string guid) |

| NetworkingServiceFactory| Method | CreateDefaultService() – auto-chosen by runtime |

| INetworkingService | Info | Service is created & initialized automatically by the library. Mods should access via Net.Service and must not call Initialize() except for test harnesses. |

| | Method | bool IsHost() |

| | Method | ulong GetLocalSteam64() |

| | Method | ulong GetLobbyMemberSteamIds() |

| | Method | Initialize() |

| | Method | Shutdown() |

| | Method | CreateLobby(maxPlayers) |

| | Method | JoinLobby(lobbySteamId64) |

| | Method | LeaveLobby() |

| | Method | RegisterLobbyDataKey(string key) |

| | Method | SetLobbyData(string key, object value) |

| | Method | T GetLobbyData(string key) |

| | Method | RegisterPlayerDataKey(string key) |

| | Method | SetPlayerData(string key, object value) |

| | Method | T GetPlayerData(ulong steam64, string key) |

| | Method | IDisposable RegisterNetworkObject(object instance, uint modId, int mask = 0) |

| | Method | void DeregisterNetworkObject(ob