Interface ISettings

Namespace: Void.Proxy.Api.Settings
Assembly: Void.Proxy.Api.dll

Exposes the runtime-readable configuration values that govern core proxy behavior, including network binding, protocol settings, and the backend server list.

public interface ISettings

Properties

Address

Gets the network address the proxy binds to when accepting incoming player connections. Defaults to , which listens on all available network interfaces.

IPAddress Address { get; }

Property Value

IPAddress

CompressionThreshold

Gets the minimum uncompressed packet payload size in bytes at which Zlib compression is applied. Packets whose payload is smaller than this threshold are forwarded without compression. Defaults to 256 bytes.

int CompressionThreshold { get; }

Property Value

int

KickTimeout

Gets the maximum time in milliseconds the proxy waits for plugins to finish graceful kick handling before force-disconnecting the player. Defaults to 10000 ms (10 seconds).

int KickTimeout { get; }

Property Value

int

LogLevel

Gets the minimum severity level for log messages emitted by the proxy. Defaults to .

LogLevel LogLevel { get; }

Property Value

LogLevel

Offline

Gets or sets a value indicating whether the proxy operates in offline mode. When true, Mojang authentication is bypassed and players can connect without a valid premium account.

bool Offline { get; set; }

Property Value

bool

Remarks

This flag can be overridden at startup via the VOID_OFFLINE environment variable or a command-line option.

Port

Gets the TCP port the proxy listens on for incoming player connections. Defaults to 25565, the standard Minecraft Java Edition port.

int Port { get; }

Property Value

int

Servers

Gets the collection of backend Minecraft servers the proxy is configured to route players to.

IEnumerable<IServer> Servers { get; }

Property Value

IEnumerable<IServer>