Class Constants.Configuration

Namespace

FishMMO.Shared

Assembly

FishMMO.Shared.dll

public static class Constants.Configuration

Inheritance

object

Constants.Configuration

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Fields

APIHost

Unified API Host URL. NGINX routes to the correct backend by path.

Set at build time via ApiHost, which CI substitutes from the FISHMMO_API_HOST environment variable. The committed source contains a sentinel placeholder — the build validator blocks release builds that still contain the sentinel.

For development/testing against different servers, use the GlobalSettings override mechanism (see ApiHostResolver) instead of modifying this constant.

public static readonly string APIHost

Field Value

string

Remarks

Configuration value baked at compile time; changing requires a rebuild.

BootstrapScenePath

Root path for bootstrap scene assets.

Kept as a separate constant alongside the otherwise-identical ScenePath for API clarity (bootstrap vs. gameplay scenes are conceptually distinct) and so that bootstrap scenes can be moved to a different root without breaking every reference. Currently both resolve to "Assets/Scenes/" by design — all scenes share one directory tree. If bootstrap scenes are ever relocated, update this value independently of ScenePath; all references (dashboard, build tool, editor shortcuts) will pick it up automatically.

public static readonly string BootstrapScenePath

Field Value

string

Remarks

Configuration value baked at compile time; changing requires a rebuild.

ClientBootstrapScenePath

Path for client-specific bootstrap scenes.

public static readonly string ClientBootstrapScenePath

Field Value

string

Remarks

Configuration value baked at compile time; changing requires a rebuild.

ClientExecutable

File name of the client executable. Platform-conditional: Windows uses ".exe" suffix; Linux and macOS omit it. static readonly required because of the #if conditional compilation.

public static readonly string ClientExecutable

Field Value

string

Remarks

Configuration value baked at compile time; changing requires a rebuild.

GameHost

Game server hostname. All clients (standalone + WebGL) connect via WebTransport (QUIC/HTTP3) to https://GameHost:{port}. NGINX forwards raw UDP to the correct backend game server on loopback.

Set at build time via GameHost, which CI substitutes from the FISHMMO_GAME_HOST environment variable.

For development/testing against different servers, use the GlobalSettings override mechanism (see ApiHostResolver) instead of modifying this constant.

public static readonly string GameHost

Field Value

string

Remarks

Configuration value baked at compile time; changing requires a rebuild.

LauncherHtmlUrl

Launcher HTML/news page URL.

Set at build time via LauncherHtmlUrl, which CI substitutes from the FISHMMO_ROOT_DOMAIN environment variable.

public static readonly string LauncherHtmlUrl

Field Value

string

Remarks

Configuration value baked at compile time; changing requires a rebuild.

LocalScenePath

Path for local development scene assets (not source-controlled).

public static readonly string LocalScenePath

Field Value

string

Remarks

Configuration value baked at compile time; changing requires a rebuild.

MaximumPlayerHotkeys

Maximum number of configurable player hotkeys.

public const int MaximumPlayerHotkeys = 12

Field Value

int

Remarks

Configuration value baked at compile time; changing requires a rebuild.

PatchesDirectoryName

Name of the directory (relative to the working directory) that patch archives are downloaded into and applied from.

This is a contract shared with the standalone Updater executable, which resolves AppDomain.CurrentDomain.BaseDirectory/Patches independently (it cannot reference this assembly). Changing this value requires the same change in FishMMO-Patcher/Updater/Program.cs.

public const string PatchesDirectoryName = "Patches"

Field Value

string

ProjectName

Display name of the game project, used in UI labels and window titles.

static readonly rather than const to allow the name to be overridden by a config file or branding patch without recompiling.

public static readonly string ProjectName

Field Value

string

Remarks

Configuration value baked at compile time; changing requires a rebuild.

ScenePath

Root path for Unity scene assets.

static readonly (not const) so that downstream references resolve at runtime and can be replaced for specialized layouts.

public static readonly string ScenePath

Field Value

string

Remarks

Configuration value baked at compile time; changing requires a rebuild.

ServerBootstrapScenePath

Path for server-specific bootstrap scenes.

public static readonly string ServerBootstrapScenePath

Field Value

string

Remarks

Configuration value baked at compile time; changing requires a rebuild.

SetupDirectory

Relative path to the FishMMO-Setup directory containing deployment config files.

static readonly rather than const to allow future runtime configuration (e.g. from a setup config file or environment variable).

public static readonly string SetupDirectory

Field Value

string

Remarks

Configuration value baked at compile time; changing requires a rebuild.

SmtpFromAddress

SMTP from address for verification/notification emails.

Set at build time via SmtpFromAddress, which CI substitutes from the FISHMMO_ROOT_DOMAIN environment variable.

public static readonly string SmtpFromAddress

Field Value

string

Remarks

Configuration value baked at compile time; changing requires a rebuild.

SmtpFromName

SMTP from display name for outgoing emails.

Set at build time via SmtpFromName.

public static readonly string SmtpFromName

Field Value

string

Remarks

Configuration value baked at compile time; changing requires a rebuild.

UpdaterExecutable

File name of the updater executable. Platform-conditional: Windows uses ".exe" suffix; Linux and macOS omit it. static readonly required because of the #if conditional compilation.

public static readonly string UpdaterExecutable

Field Value

string

Remarks

Configuration value baked at compile time; changing requires a rebuild.

WorldScenePath

Path template for world scene assets.

public static readonly string WorldScenePath

Field Value

string

Remarks

Configuration value baked at compile time; changing requires a rebuild.