Server Configuration
Reference for skills/dedicated-server/SKILL.md — command-line argument parsing for headless server (port, max-players, tick-rate, log-level), GDScript and C#.
← Back to SKILL.md
5. Server Configuration
Command Line Argument Parsing
GDScript
# server_config.gd — autoload named ServerConfig, parsed before any other autoload logic
extends Node
var port: int = 7777
var max_players: int = 8
var tick_rate: int = 60
var log_level: int = 1 # 0 = quiet, 1 = info, 2 = verbose
func _ready() -> void:
# Precedence: defaults < config file < environment < CLI — later steps win.
_load_config_file("user://server.cfg")
_apply_env_vars()
_parse_args()
if OS.has_feature("dedicated_server") or DisplayServer.get_name() == "headless":
print("[Config] port=%d max_players=%d tick_rate=%d" % [port, max_players, tick_rate])
func _parse_args() -> void:
var args := OS.get_cmdline_args()
var i := 0
while i < args.size():
match args[i]:
"--port":
if i + 1 < args.size():
port = int(args[i + 1])
i += 1
"--max-players":
if i + 1 < args.size():
max_players = int(args[i + 1])
i += 1
"--tick-rate":
if i + 1 < args.size():
tick_rate = int(args[i + 1])
i += 1
"--log-level":
if i + 1 < args.size():
log_level = int(args[i + 1])
i += 1
i += 1
func _load_config_file(path: String) -> void:
var cfg := ConfigFile.new()
var err := cfg.load(path)
if err != OK:
return # No config file — defaults remain in effect
port = cfg.get_value("server", "port", port)
max_players = cfg.get_value("server", "max_players", max_players)
tick_rate = cfg.get_value("server", "tick_rate", tick_rate)
log_level = cfg.get_value("server", "log_level", log_level)
print("[Config] Loaded config from: %s" % path)
func _apply_env_vars() -> void:
# Environment variables override the config file but are overridden by CLI args.
var env_port := OS.get_environment("SERVER_PORT")
if env_port != "":
port = int(env_port)
var env_max := OS.get_environment("SERVER_MAX_PLAYERS")
if env_max != "":
max_players = int(env_max)
var env_tick := OS.get_environment("SERVER_TICK_RATE")
if env_tick != "":
tick_rate = int(env_tick)Example config file (server.cfg):
[server]
port=7777
max_players=16
tick_rate=60
log_level=1Example launch:
./my_game_server.x86_64 --headless --port 7778 --max-players 4 --tick-rate 30C#
// ServerConfig.cs — autoload named ServerConfig
using Godot;
public partial class ServerConfig : Node
{
public int Port { get; private set; } = 7777;
public int MaxPlayers { get; private set; } = 8;
public int TickRate { get; private set; } = 60;
public int LogLevel { get; private set; } = 1;
public override void _Ready()
{
// Precedence: defaults < config file < environment < CLI — later steps win.
LoadConfigFile("user://server.cfg");
ApplyEnvVars();
ParseArgs();
if (OS.HasFeature("dedicated_server") || DisplayServer.GetName() == "headless")
GD.Print($"[Config] port={Port} max_players={MaxPlayers} tick_rate={TickRate}");
}
private void ParseArgs()
{
var args = OS.GetCmdlineArgs();
for (int i = 0; i < args.Length; i++)
{
switch (args[i])
{
case "--port" when i + 1 < args.Length: Port = int.Parse(args[++i]); break;
case "--max-players" when i + 1 < args.Length: MaxPlayers = int.Parse(args[++i]); break;
case "--tick-rate" when i + 1 < args.Length: TickRate = int.Parse(args[++i]); break;
case "--log-level" when i + 1 < args.Length: LogLevel = int.Parse(args[++i]); break;
}
}
}
private void LoadConfigFile(string path)
{
var cfg = new ConfigFile();
if (cfg.Load(path) != Error.Ok) return;
Port = (int)cfg.GetValue("server", "port", Port);
MaxPlayers = (int)cfg.GetValue("server", "max_players", MaxPlayers);
TickRate = (int)cfg.GetValue("server", "tick_rate", TickRate);
LogLevel = (int)cfg.GetValue("server", "log_level", LogLevel);
GD.Print($"[Config] Loaded config from: {path}");
}
private void ApplyEnvVars()
{
var envPort = OS.GetEnvironment("SERVER_PORT");
if (envPort != string.Empty) Port = int.Parse(envPort);
var envMax = OS.GetEnvironment("SERVER_MAX_PLAYERS");
if (envMax != string.Empty) MaxPlayers = int.Parse(envMax);
var envTick = OS.GetEnvironment("SERVER_TICK_RATE");
if (envTick != string.Empty) TickRate = int.Parse(envTick);
}
}