Table of Contents

Interface IServerSettings

Namespace
BSGameLib.Server
Assembly
BSGameLib.Server.dll

The settings a server runs with. ServerSettings is the default implementation.

public interface IServerSettings

Properties

ApplicationId

The application's name. The server uses it to name its development certificate, and it is written to the startup log.

string ApplicationId { get; set; }

Property Value

string

BindAddress

The IP address the server listens on, for its QUIC listener and its UDP socket. Null, the default, is every address: IPv6 and IPv4 together where the host has IPv6. An address such as "127.0.0.1" or "::1" listens on that one only, so the server is not reachable from other machines. Give an IP address, not a host name; anything else stops the server at startup.

string BindAddress { get; }

Property Value

string

CertificateStorePath

Directory the auto-generated self-signed dev certificate is persisted to and reloaded from on restart, so its identity stays stable across TOFU-pinned clients. When null, it defaults to a "certs" folder in DataFolder, and a relative path is resolved against that folder too. Ignored when QuicConfiguration is set.

string CertificateStorePath { get; set; }

Property Value

string

DataFolder

The folder the server keeps what it writes in, when the game keeps that apart from the program (so that an update can replace every file it installed). Null, the default, means the program's own folder.

string DataFolder { get; }

Property Value

string

ListenPort

The UDP port the server listens on. The game's unreliable traffic uses ListenPort + 2, and ListenPort + 1 is unused. A value of 0 gives the default, 55237.

int ListenPort { get; set; }

Property Value

int

QuicConfiguration

QUIC transport configuration. When null, a self-signed dev certificate is generated automatically. Set this in production to use a trusted certificate.

QuicTransportConfiguration QuicConfiguration { get; set; }

Property Value

QuicTransportConfiguration