Difference between revisions of "server config"

From Onset Developer Wiki
 
(2 intermediate revisions by the same user not shown)
Line 42: Line 42:
 
|packages
 
|packages
 
|Array of packages you want to load.
 
|Array of packages you want to load.
|-
 
|client_cache_id
 
|The cache id used by the server. Useful for those who run multiple servers with the same gamemode and assets.
 
 
|-
 
|-
 
|voice
 
|voice
Line 51: Line 48:
 
|voice_sample_rate
 
|voice_sample_rate
 
|VoIP sample rate, higher rates have better quality but also require more bandwidth. Valid rates are: 8000, 12000, 16000, 24000 and 48000.
 
|VoIP sample rate, higher rates have better quality but also require more bandwidth. Valid rates are: 8000, 12000, 16000, 24000 and 48000.
|-
 
|voice_distance
 
|Distance where you can hear other players talking.
 
 
|-
 
|-
 
|voice_spatialization
 
|voice_spatialization
 
|Makes the VoIP sound 3D including spatialization and falloff.
 
|Makes the VoIP sound 3D including spatialization and falloff.
 +
|-
 +
|pools - distance
 +
|Each entity pool has a steaming range in which players can see the relevant entities. A pool is just a collection of a specific entity type. For a full 300 players a distance of 12000.0 is a good value. You can increase this value if your gamemode requires it. As the distance and the number of entities in a pool increase, the more likely it is to experience degraded server and client performance.
 +
A too low value can also be bad for the server performance.
 +
|-
 +
|pools - update_rate
 +
|The time that passes between the algorithm updates and potential streaming events are generated. This should be low for players but can be higher for less important entity types like text3d, doors etc. A number 0.05 means 50ms.
 
|}
 
|}
  
Line 62: Line 63:
 
<syntaxhighlight lang="json">
 
<syntaxhighlight lang="json">
 
{
 
{
        "servername": "[g]🌴 [c=#00ff00]Horizon[/c] [c=red]Prototype[/c] [c=yellow]Labs[/c] 🗽 [b]LIT AF[/b] 🚬🔥 [i]блять[/i] 🔫 + 💊 = 🚨 [u][b]NOICE[/b][/u] OK come on in 👀[/g]",
+
"servername": "[g]🌴 [c=#00ff00]Horizon[/c] [c=red]Prototype[/c] [c=yellow]Labs[/c] 🗽 [b]LIT AF[/b] 🚬🔥 [i]блять[/i] 🔫 + 💊 = 🚨 [u][b]NOICE[/b][/u] OK come on in 👀[/g]",
        "gamemode": "GET THE EXPERIENCE ⛺ 💊",
+
"gamemode": "GET THE EXPERIENCE ⛺ 💊",
        "website_url": "https://playonset.com",
+
"website_url": "https://playonset.com",
        "ipaddress": "0.0.0.0",
+
"ipaddress": "0.0.0.0",
        "port": 7777,
+
"port": 7777,
        "maxplayers": 25,
+
"maxplayers": 25,
        "password": "",
+
"password": "",
        "timeout": 15000,
+
"timeout": 15000,
        "iplimit": 5,
+
"iplimit": 5,
        "masterlist": true,
+
"masterlist": true,
        "plugins": [
+
"plugins": [
                "mariadb"
+
"mariadb"
        ],
+
],
        "packages": [
+
"packages": [
                "horizon"
+
"horizon"
        ],
+
],
        "stream_distance": 12000.0,
+
"voice": true,
        "stream_update_rate": 0.05,
+
"voice_sample_rate": 24000,
        "voice": true,
+
"voice_spatialization": true,
        "voice_sample_rate": 24000,
+
"pools": {
        "voice_distance": 4000.0,
+
"player": {
        "voice_spatialization": true
+
"distance": 12000.0,
 +
"update_rate": 0.05
 +
},
 +
"voice": {
 +
"distance": 5000.0,
 +
"update_rate": 0.8
 +
},
 +
"vehicle": {
 +
"distance": 12000.0,
 +
"update_rate": 0.1
 +
},
 +
"object": {
 +
"distance": 12000.0,
 +
"update_rate": 0.1
 +
},
 +
"npc": {
 +
"distance": 12000.0,
 +
"update_rate": 0.1
 +
},
 +
"pickup": {
 +
"distance": 12000.0,
 +
"update_rate": 0.1
 +
},
 +
"door": {
 +
"distance": 12000.0,
 +
"update_rate": 0.1
 +
},
 +
"text3d": {
 +
"distance": 12000.0,
 +
"update_rate": 0.1
 +
}
 +
}
 
}
 
}
  
 
</syntaxhighlight>
 
</syntaxhighlight>

Latest revision as of 18:35, 23 May 2020

You can find the game and server limitations here: Limitations.

server_config.json
Config Description
servername The hostname of your server (220 max. chars including markup). Markup for colors and UTF8 icons require a subscription.
servername_short The short version of the hostname (128 max. chars). Used for Discord/Steam Rich Presence. (Should not contain markup but can contain UTF8 icons)
gamemode A description what you can do on your server.
website_url A link to your servers homepage.
ipaddress Address to bind your server on. Use "localhost" to make it accessible from your computer only. Use "0.0.0.0" to bind on any address.
port Main network port to connect to your server (UDP). Query port (UDP) is this port - 1. File port (TCP) is this port - 2.
password Leave empty to disable.
timeout Time in milliseconds after which an unresponsive player will be dropped. This should be between 10000 and 20000 milliseconds.
iplimit Limit the amount of connections per IP. New connections exceeding that number are being dropped immediately.
masterlist true to have your server made public in the server list. false otherwise. This only works if your server is reachable on the internet.
plugins Array of plugins you want to load. These must be in the plugins folder.
packages Array of packages you want to load.
voice Enable VoIP system.
voice_sample_rate VoIP sample rate, higher rates have better quality but also require more bandwidth. Valid rates are: 8000, 12000, 16000, 24000 and 48000.
voice_spatialization Makes the VoIP sound 3D including spatialization and falloff.
pools - distance Each entity pool has a steaming range in which players can see the relevant entities. A pool is just a collection of a specific entity type. For a full 300 players a distance of 12000.0 is a good value. You can increase this value if your gamemode requires it. As the distance and the number of entities in a pool increase, the more likely it is to experience degraded server and client performance.

A too low value can also be bad for the server performance.

pools - update_rate The time that passes between the algorithm updates and potential streaming events are generated. This should be low for players but can be higher for less important entity types like text3d, doors etc. A number 0.05 means 50ms.

Example server_config.json

{
	"servername": "[g]🌴 [c=#00ff00]Horizon[/c] [c=red]Prototype[/c] [c=yellow]Labs[/c] 🗽 [b]LIT AF[/b] 🚬🔥 [i]блять[/i] 🔫 + 💊 = 🚨 [u][b]NOICE[/b][/u] OK come on in 👀[/g]",
	"gamemode": "GET THE EXPERIENCE ⛺ 💊",
	"website_url": "https://playonset.com",
	"ipaddress": "0.0.0.0",
	"port": 7777,
	"maxplayers": 25,
	"password": "",
	"timeout": 15000,
	"iplimit": 5,
	"masterlist": true,
	"plugins": [
			"mariadb"
	],
	"packages": [
			"horizon"
	],
	"voice": true,
	"voice_sample_rate": 24000,
	"voice_spatialization": true,
	"pools": {
		"player": {
			"distance": 12000.0,
			"update_rate": 0.05
		},
		"voice": {
			"distance": 5000.0,
			"update_rate": 0.8
		},
		"vehicle": {
			"distance": 12000.0,
			"update_rate": 0.1
		},
		"object": {
			"distance": 12000.0,
			"update_rate": 0.1
		},
		"npc": {
			"distance": 12000.0,
			"update_rate": 0.1
		},
		"pickup": {
			"distance": 12000.0,
			"update_rate": 0.1
		},
		"door": {
			"distance": 12000.0,
			"update_rate": 0.1
		},
		"text3d": {
			"distance": 12000.0,
			"update_rate": 0.1
		}
	}
}