Skip to content

Configuration

The server reads two kinds of settings.

  • server.toml is a file read at start. It holds the settings that change how the process runs: folders, database, ports, and secrets. Change it, then restart.
  • Server Options are key=value lines kept in the database. Staff edit them in the RC tool and changes apply at once. They hold the settings of the game.

deploy/server.example.toml documents every key. A relative path is resolved against the folder of the file.

Key Default Meaning
server.data_dir ./data Root folder of levels, images, scripts, and the script file sandbox
database.url none PostgreSQL connection URL. BORNE_DATABASE_URL overrides it. One of the two is required
database.pool_size 8 Database connections, from 1 to 1000
network.port 14900 TCP port of the game (/game) and RC (/rc) endpoints
network.tls_cert, network.tls_key none TLS certificate chain and private key in PEM form. With neither, the server makes a self-signed certificate under <data_dir>/tls
network.allow_insecure_localhost false Allow plain ws:// from the same computer. Development only. --dev sets it too
network.file_rate 2097152 File download rate for each client, in bytes per second
network.max_game_per_ip 4 Game connections for each IP address (IPv6 counts per address)
network.max_rc_per_ip 2 RC connections for each IP address
network.handshake_timeout 10 Seconds from the TCP connection to the first message
network.login_timeout 30 Seconds from the first message to a finished login
security.signing_key none Path of the Ed25519 signing key (mode 0600)
security.cache_secret none Path of a file with at least 32 random bytes (mode 0600)
Environment variable Meaning
BORNE_DATABASE_URL Overrides database.url
BORNE_RC_SKIP_IP_CHECK 1 or true switches off the IP list of staff accounts: they may log in to RC from any address. Passwords, bans, and rights still apply. The server prints a warning at start. Use it only for a short time on a trusted network

Secrets are files, never values in server.toml. A key such as security.password is refused.

Staff edit the text in the RC tool (right: Change server options). One key=value per line.

Key Meaning Default
name Server name, shown to players and in servername Borne Server
staff Staff accounts. The engine keeps this line in step with the staff rights, so do not edit it by hand empty
staffguilds Guild tags that count as staff for scripts empty
startlevel, startx, starty Where a new account starts start.nw, 30, 30
unstickmelevel, unstickmex, unstickmey Where the unstick command sends a player empty
maxplayers Connection limit 500
allowregistration Players can create their own account on the login screen true
fixedtickrate Simulation rate, and the rate of onFixedUpdate 50
sendrate Rate of updates sent to clients 25
levelunloadtime Seconds without players before a level may unload 3600
logobjerrorsonrc Show in RC chat when a script calls a function on an object that does not exist, such as findplayer("offline").doSomething() for a player who is not online. The call returns empty either way. Other script errors are always shown false
movementcheck The server corrects players who move faster than walking or through walls, and disconnects them after many corrections. Leave it off if scripts move players through walls or fast (spells, dashes) false
socketbindports Ports that script sockets (TSocket) may bind, such as 8082,9000-9010. Empty means scripts cannot listen empty
socketbindpublic Script sockets bind on every network interface instead of only the loopback address false
rcwelcome The line each RC session gets at connect. {server}, {nick}, and {account} are replaced. Empty turns it off Welcome to {server}, {nick}.
httpallowlist Hosts that scripts may call over HTTP: exact names or *.domain empty
clienthttp Lets client scripts fetch web pages from the hosts of httpallowlist, through the server false
scriptfolders Folders that scripts may read databases,logs
scriptwritefolders Folders that scripts may write logs
compiler_strict, compiler_legacy_warnings Compiler modes for all scripts false
script_* Script limits (script_instruction_limit, script_loop_limit, and others) the defaults in the errors page
time_zone_offset Hours east of UTC for converttimetostring and formattimestring (-3, 5.5) 0 (UTC)

Other keys are free for your own game settings. A script reads any of them with serveroptions.key.

A script can call a web address only when its host is in httpallowlist. Write exact names (api.example.com) or a pattern (*.example.com, which matches a.example.com and a.b.example.com, but not example.com). Ports are ignored. A name that matches only through a pattern must resolve to public addresses: a pattern host that points to your own network is refused. A host or address listed exactly is trusted, so list 127.0.0.1 to let scripts call a service on the same computer.

Client scripts have no web access of their own. With clienthttp=true, requesturl in a client script asks the server to fetch the page for the player, under the same allow list and limits: GET only, no cookies or credentials, up to 512 KiB, 8 open requests and 4 new ones per second for each player. The default is false, so the server never fetches anything for a client until you allow it.

Scripts reach files only inside scriptfolders (read) and scriptwritefolders (write), relative to the data folder. Paths with .., absolute paths, and links that leave the folders are refused and reported as R-FILE-ACCESS. databases is readable by default, so scripts can read the raw SQLite files. Remove it from scriptfolders if that is not wanted.

Engine version 0.1.0. Built 2026-11-18.