Skip to main content
Version: latest - a1.7.0 βš–οΈ

Server Configuration

All you need to know to Configure your server!

Server Configuration File​

tip

nanos world Config files use TOML (Tom’s Obvious, Minimal Language), please refer to https://github.com/toml-lang/toml for more information and syntax.

The server Configuration file Config.toml is generated automatically when the server is launched for the first time. This file will always be overridden with the proper pattern after the server is loaded.

Config.toml
loading...

Settings Detailed​

SettingDescription
nameName of the Server
descriptionDescription of the Server
logoImage URL to be displayed in the Server List
max_playersMax amount of players allowed to join
passwordPassword to be able to connect
ipServer IP. We recommend leaving it blank
portServer main Port and HTTP Port (UDP/TCP)
query_portServer query Port (UDP)
announceWhether to announce or not in the Server List
tick_rateServer Tick in ms. We recommend leaving it 33
log_levelWhich Log level to output
game_modegame-mode package to load - you can only load one game-mode at once.
loading_screenloading-screen package to load - you can only load one loading-screen at once.
packagesscript packages to load
assetsAdditional assets to force to load
mapWhich map to load
tokenServer Token used for authorize downloads through CLI
banned_ipsList of banned IPs

Map & Level​

The Map (or Level) is defined in the Server’s config file, this level will be loaded when the player joins the server and the Path is supposed for be or a built-in asset or an asset which is located at Assets/ folder.

nanos world counts on (for now) 4 built-in maps: nanos-world::BlankMap, nanos-world::EmptyMap, nanos-world::OceanMap and nanos-world::TestingMap which can be used in your server without needing to download any Asset Pack.

Server Console​

Built-in Commands​

CommandDescription
chat [message]Sends a chat message
map [map_path]Changes the Map, reloads all Packages and reconnect all Players
stopStops the server
package run [package_name] [lua_code]Runs a code in a package
package reload [package_name]Reloads a package
package reload allReloads all packages
package unload [package_name]Unloads a package
package load [package_name]Loads a package

Custom Commands​

All (non built-in) commands will be sent into an event to the scripting/server-side:

Server/Index.lua
Server.Subscribe("Console", function(my_input)
Package.Log("Console command received: " .. my_input)
end)

Command Line Parameters​

It is possible to override the Server Configuration with Command Line Parameters. Note: this will not write to the Config file.

ParameterValue TypeDescription
--namestringServer name
--descriptionstringServer description
--logostringServer Logo
--passwordstringServer password
--ipstringServer IP
--mapstringMap to load
--portnumberServer port
--query_portnumberServer Query port
--announce0 or 1If announce in master list
--game_modestringServer game-mode
--loading_screenstringServer loading-screen
--packagesstring listServer packages
--assetsstring listServer assets
--tokenstringServer authorization token
--max_playersnumberMax allowed players
--save0 or 1If to save the parameters in Config.toml
--profiling0 or 1Enables Performance Profiling Logs for debugging
--auto_download0 or 1Automatically downloads Packages and Assets from Vault if needed

One-liner Server Configuration​

With Command Line Parameters and Command Line Interface (CLI), it is also possible to automate the full server installation, here's an example:

Shell/Linux
# Installs/Updates the server through SteamCMD
steamcmd +force_install_dir /home/nanos-world-server +login anonymous +app_update "1936830 -beta bleeding-edge" validate +quit

# Installs all needed Packages (this will install needed Assets as well)
./NanosWorldServer.sh --cli install package sandbox battlefield-kill-ui ts-fireworks-tools

# Starts the server with all configs set
./NanosWorldServer.sh --name "nanos world Amazing Sandbox" --description "Awesome Sandbox Server" --map "nanos-world::TestingMap" --gamemode "sandbox" --packages "battlefield-kill-ui,ts-fireworks-tools" --port 7777 --query_port 7778 --max_players 32 --logo "https://i.imgur.com/U1rZp5v.png"

Another shorter example:

Shell/Linux
# Starts the server with all configs set and auto downloads the packages and assets if needed
./NanosWorldServer.sh --name "nanos world Amazing Sandbox" --description "Awesome Sandbox Server" --map "nanos-world::TestingMap" --gamemode "sandbox" --packages "battlefield-kill-ui,ts-fireworks-tools" --port 7777 --query_port 7778 --max_players 32 --auto_download 1 --logo "https://i.imgur.com/U1rZp5v.png"

Common Console Messages and Errors​

Server Tick too/extreme high! Verify the server performance! Server got stuck for Xms...​

It means the server got stuck for X milliseconds. The warning (yellow) is not something to worry about, but too many messages in red) could mean your server infrastructure is not that good or your scripting code is not that optimized.

Usually the server runs at 33 ticks per second (or the value configured at Config.toml), the server runs in an infinite loop in that frequency, and inside that loop all server operations are executed, such as receiving and sending network packets, triggering lua events, executing functions or callbacks, and so on.

If a single tick takes more than 33 milliseconds, this warning will appear up.

tip

In some shared VPS, this warning may appear up more frequently due how the VPS handles the scaling of it's machines, sometimes the provider may think your VPS is "idle" (due nanos world server using extremely low CPU) and may decrease your processing power, causing this warning show up as well.

Assertion Failed: [...] problem (5002) We don't have cert, and self-signed certs not allowed...​

This is an internal problem from Steam Library when you attempt to connect to a server too fast (when it has just started). The server automatically fixes it by retrying the connection, there is nothing to worry about.

Lua Stack Error: Should be X, is Y...​

This is an internal error and should not supposed to happen. Those are guards set around our Lua Scripting implementation to prevent bad things from happening. If this error appears it means a implementation bug happened. Please communicate immediately with the devs, and if possible how to reproduce that!