Skip to content

Allow configuration of WebSocket server bind address #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
great-majority merged 2 commits into from
Jul 21, 2025
Merged

Allow configuration of WebSocket server bind address #7

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
23f4f05
✨️ Allow configuration of WebSocket server bind address
great-majority Jul 21, 2025
52cc43c
🔧 Changed plugin's GUID
great-majority Jul 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions src/KKStudioSocket.Core/KKStudioSocketPlugin.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,17 +20,19 @@ namespace KKStudioSocket
[BepInPlugin(GUID, Name, Version)]
public class KKStudioSocketPlugin : BaseUnityPlugin
{
public const string GUID = "com.github.kk.kkstudiosocket";
public const string GUID = "KKStudioSocket";
public const string Name = "KKStudioSocket";
public const string Version = "1.0.0";

private const int DefaultPort = 8765;
private const string DefaultPath = "/ws";
private const string DefaultBindAddress = "127.0.0.1";

internal static new ManualLogSource Logger;
private static readonly Queue<Action> _actionQueue = new Queue<Action>();

private ConfigEntry<int> _serverPort;
private ConfigEntry<string> _serverBindAddress;
private ConfigEntry<bool> _enableServer;
private WebSocketServer _webSocketServer;
private Studio.Studio _studio = null;
Expand All @@ -50,6 +52,7 @@ private void Update()
this._studio = Studio.Studio.instance;
Logger.LogInfo("Studio instance seems to be initialized. Starting WebSocket Server.");

_serverBindAddress = Config.Bind("Server", "BindAddress", DefaultBindAddress, "IP address for the WebSocket server to bind to");
_serverPort = Config.Bind("Server", "Port", DefaultPort, "WebSocket server port number");
_enableServer = Config.Bind("Server", "Enable", true, "Enable WebSocket server");

Expand All @@ -71,10 +74,10 @@ private void StartWebSocketServer()
{
try
{
_webSocketServer = new WebSocketServer(System.Net.IPAddress.Loopback, _serverPort.Value);
_webSocketServer = new WebSocketServer($"ws://{_serverBindAddress.Value}:{_serverPort.Value}");
_webSocketServer.AddWebSocketService<StudioWsBehavior>(DefaultPath);
_webSocketServer.Start();
Logger.LogInfo($"WebSocket server started → ws://127.0.0.1:{_serverPort.Value}{DefaultPath}");
Logger.LogInfo($"WebSocket server started → ws://{_serverBindAddress.Value}:{_serverPort.Value}{DefaultPath}");
}
catch (Exception e)
{
Expand Down