zyxterus-Self_Hosted_Photon icon

Self Hosted Photon

Allows you to connect to a self-hosted Photon server via an IP address or a hostname.

Last updated 3 days ago
Total downloads 40
Total rating 1 
Categories Mods Tools Client-side Server-side
Dependency string zyxterus-Self_Hosted_Photon-0.1.0
Dependants 0 other packages depend on this package

This mod requires the following mods to function

BepInEx-BepInExPack-5.4.2304 icon
BepInEx-BepInExPack

BepInEx pack for Mono Unity games. Preconfigured and ready to use.

Preferred version: 5.4.2304

README

Self Hosted Photon

With this mod you can easily join to a self-hosted version of Photon via an IP address or a hostname.

DISCLAIMER

This mod is not yet finished, so you may experience some issues. If you do do not hesitate to create a new issue on the project GitHub.

Setup

For Server Hosts

To use this mod you will need a Photon Server first of all. There is a nice GitHub project that allows you to run your own Photon server via Docker.

After you have set up the server you need to share the server address and port with your clients.

From this point you can just follow the client setup.

For Clients

First of all will need to enable the mod and set the server address and port in the configs, after you can just join a game (the lobby host and the server host does not have to be the same person).

Config

Example config

## Settings file was created by plugin Self_Hosted_Photon v0.0.0
## Plugin GUID: Self_Hosted_Photon

[General]

## Enable or disable the plugin.
# Setting type: Boolean
# Default value: true
Enabled = true

[Server]

## The IP address or hostname of the Photon server.
# Setting type: String
# Default value: 127.0.0.1
Address = 127.0.0.1

## The port number of the Photon server.
# Setting type: String
# Default value: 5055
Port = 5055

To save yourself some trouble you can use the REPOConfig mod that allows you to change your settings in-game.

Credit

Credit to REPOLib for the GitHub CI/CD pipeline.