Setting up a dedicated server - Revision history

DarkAt26: /* Obtaining an ApiKey */

2025-01-03T11:37:30Z

Obtaining an ApiKey

Invicta nz: /* Operating System */ Added 24.04

2024-12-07T11:12:48Z

Operating System: Added 24.04

← Older revision		Revision as of 07:12, 7 December 2024
Line 29:		Line 29:
	* Ubuntu 20.04 x86_64		* Ubuntu 20.04 x86_64
	* Ubuntu 22.04 x86_64		* Ubuntu 22.04 x86_64
			* Ubuntu 24.04 x86_64
	* Rocky Linux 8		* Rocky Linux 8

MessiahPenguin: /* Setting up a dedicated server */ removed outdated stuff and updated server hosting info

2024-12-03T20:51:20Z

Setting up a dedicated server: removed outdated stuff and updated server hosting info

Show changes

MessiahPenguin: /* Obtaining an ApiKey */ added other API key pic

2024-12-03T20:26:50Z

Obtaining an ApiKey: added other API key pic

← Older revision		Revision as of 16:26, 3 December 2024
Line 81:		Line 81:
	'''<u>This is required for all servers as of the December 2024 Pavlov Update.</u>'''		'''<u>This is required for all servers as of the December 2024 Pavlov Update.</u>'''
	For your server to show up in the server list, there is now a requirement to have an ApiKey issued by Vankrupt. You will need to load up the game on your headset the navigate to the settings, in the general tab is there a button to Generate Server Code.		For your server to show up in the server list, there is now a requirement to have an ApiKey issued by Vankrupt. You will need to load up the game on your headset the navigate to the settings, in the general tab is there a button to Generate Server Code.
			[[File:Pavlov Settings API Key Button.jpg\|thumb\|API key generator button located in the settings menu]]
	* Your "pin" will only be valid for 15 minutes.		* Your "pin" will only be valid for 15 minutes.
	* If your server key is exposed you can create a new key by generating a new 6 digit code.		* If your server key is exposed you can create a new key by generating a new 6 digit code.
Line 91:		Line 92:
	Get the key by going here: https://api-key.vankrupt.net/		Get the key by going here: https://api-key.vankrupt.net/

	[[File:Generateserverkey.png\|thumb\|449x449px]]		[[File:Generateserverkey.png\|thumb\|449x449px\|Screenshot from vankrupt API website]]

	Once you submit you will get your unique Server API Key that needs to go into your Game.ini		Once you submit you will get your unique Server API Key that needs to go into your Game.ini

MessiahPenguin: /* Obtaining an ApiKey */ images added for API

2024-12-03T20:25:03Z

Obtaining an ApiKey: images added for API

← Older revision		Revision as of 16:25, 3 December 2024
Line 78:		Line 78:

	====Obtaining an ApiKey ====		====Obtaining an ApiKey ====
			[[File:Server API Key.jpg\|thumb\|Example code generated in settings menu]]
	'''<u>This is required for all servers as of the December 2024 Pavlov Update.</u>'''		'''<u>This is required for all servers as of the December 2024 Pavlov Update.</u>'''
	For your server to show up in the server list, there is now a requirement to have an ApiKey issued by Vankrupt. You will need to load up the game on your headset the navigate to the settings, in the general tab is there a button to Generate Server Code.		For your server to show up in the server list, there is now a requirement to have an ApiKey issued by Vankrupt. You will need to load up the game on your headset the navigate to the settings, in the general tab is there a button to Generate Server Code.

MessiahPenguin: /* Obtaining an ApiKey */ fixed picture in API section

2024-12-03T20:18:59Z

Obtaining an ApiKey: fixed picture in API section

← Older revision		Revision as of 16:18, 3 December 2024
Line 91:		Line 91:
	Get the key by going here: https://api-key.vankrupt.net/		Get the key by going here: https://api-key.vankrupt.net/

	[[File:Generateserverkey.png\|~~left~~\|~~thumb~~]]		[[File:Generateserverkey.png\|thumb\|449x449px]]





	Once you submit you will get your unique Server API Key that needs to go into your Game.ini		Once you submit you will get your unique Server API Key that needs to go into your Game.ini

MessiahPenguin: /* Obtaining an ApiKey */ Api key section cleaned up a bit

2024-12-03T20:17:14Z

Obtaining an ApiKey: Api key section cleaned up a bit

← Older revision		Revision as of 16:17, 3 December 2024
Line 79:		Line 79:
	====Obtaining an ApiKey ====		====Obtaining an ApiKey ====

			'''<u>This is required for all servers as of the December 2024 Pavlov Update.</u>'''
	For your server to show up in the server list, there is now a requirement to have an ApiKey issued by Vankrupt. ~~This is to prevent DOS attacks against the master server or abuse.~~		For your server to show up in the server list, there is now a requirement to have an ApiKey issued by Vankrupt. You will need to load up the game on your headset the navigate to the settings, in the general tab is there a button to Generate Server Code.



	~~'''~~You will need to load up the game on your headset~~'''~~ the navigate to the settings, in the general tab is there a button to Generate Server Code.

	* Your "pin" will only be valid for 15 minutes.		* Your "pin" will only be valid for 15 minutes.
	* If your server key is exposed you can create a new key by generating a new 6 digit code.		* If your server key is exposed you can create a new key by generating a new 6 digit code.
Line 91:		Line 86:
	* A server key can be used by multiple servers.		* A server key can be used by multiple servers.
	* A user may only have one server key, requesting a new one will invalidate the old one.		* A user may only have one server key, requesting a new one will invalidate the old one.



	This will give you a 6 character code you need to combine with your player ID to generate a server key.		This will give you a 6 character code you need to combine with your player ID to generate a server key.
Line 99:		Line 92:

	[[File:Generateserverkey.png\|left\|thumb]]		[[File:Generateserverkey.png\|left\|thumb]]




Line 107:		Line 98:

	Once you submit you will get your unique Server API Key that needs to go into your Game.ini		Once you submit you will get your unique Server API Key that needs to go into your Game.ini



	'''Warnings:'''		'''Warnings:'''
	* '''Abusing a Server key may result in a ban to the attached user.'''		* '''Abusing a Server key may result in a ban to the attached user.'''
	* '''Do NOT share your server key, it should be used by you alone.'''		* '''<u>Do NOT share your server key</u>, it should be used by you alone.'''
	* '''Store your server key in a safe place, such as a password or secret manager.'''		* '''Store your server key in a safe place, such as a password or secret manager.'''



	Save this key for later, so that you can ut this key in your Game.ini as follows:		Save this key for later, so that you can ut this key in your Game.ini as follows:
	ApiKey="ABC123FALSEKEYDONTUSEME"		ApiKey="ABC123FALSEKEYDONTUSEME"
Line 123:		Line 109:

	This key can be re-used for a reasonable number of servers (a limit of 10 has been mentioned). Contact the Devs if you need more servers per key.		This key can be re-used for a reasonable number of servers (a limit of 10 has been mentioned). Contact the Devs if you need more servers per key.


	====System setup and software installation====		====System setup and software installation====
	In this step we will:		In this step we will:
Line 135:		Line 119:

	These steps only need to be done the first time you set up the server. We'll then look at some post-installation steps.		These steps only need to be done the first time you set up the server. We'll then look at some post-installation steps.


	===== Step 1: Check the operating system is compatible =====		===== Step 1: Check the operating system is compatible =====
	Confirm Linux version, run the command:		Confirm Linux version, run the command:

Junt at 16:28, 3 December 2024

2024-12-03T16:28:21Z

← Older revision		Revision as of 12:28, 3 December 2024
Line 97:		Line 97:

	Get the key by going here: https://api-key.vankrupt.net/		Get the key by going here: https://api-key.vankrupt.net/

	[[File:Generateserverkey.png\|left\|thumb]]		[[File:Generateserverkey.png\|left\|thumb]]

Junt at 16:26, 3 December 2024

2024-12-03T16:26:55Z

@@ Line 78: / Line 78: @@
 ====Obtaining an ApiKey ====
-Get the key by going here: https://pavlov-ms.vankrupt.com/servers/v1/key and using your mobile number to get a SMS
+For your server to show up in the server list, there is now a requirement to have an ApiKey issued by Vankrupt. This is to prevent DOS attacks against the master server or abuse.
 Save this key for later, so that you can ut this key in your Game.ini as follows:
@@ Line 92: / Line 122: @@
 This key can be re-used for a reasonable number of servers (a limit of 10 has been mentioned). Contact the Devs if you need more servers per key.
 ====System setup and software installation====
 In this step we will:
@@ Line 102: / Line 134: @@
 These steps only need to be done the first time you set up the server. We'll then look at some post-installation steps.
 ===== Step 1: Check the operating system is compatible =====

Lag: /* Configuring Game.ini */

2024-12-02T20:20:46Z

Configuring Game.ini

← Older revision		Revision as of 16:20, 2 December 2024
Line 263:		Line 263:
	* '''BalanceTableURL''' - Points to a custom balance table from github. See https://github.com/vankruptgames/BalancingTable for instructions. This line isn't needed if you don't have one.		* '''BalanceTableURL''' - Points to a custom balance table from github. See https://github.com/vankruptgames/BalancingTable for instructions. This line isn't needed if you don't have one.
	* '''MapRotation''' - you can add multiple of these. The map system has switched from the steam workshop to modio which means that the server rotation will need to be redone with modio UGCs. <nowiki>https://mod.io/g/pavlov</nowiki>. This is done by taking the resource ID from the modio page, adding “UGC” in front of it and then adding that to the rotation. For example the map gravity <nowiki>https://mod.io/g/pavlov/m/gravity1</nowiki> has a resource ID of 2773760 so the map ID to add to the server would be “UGC2773760”. When a match ends, the server will load the next map in the rotation.		* '''MapRotation''' - you can add multiple of these. The map system has switched from the steam workshop to modio which means that the server rotation will need to be redone with modio UGCs. <nowiki>https://mod.io/g/pavlov</nowiki>. This is done by taking the resource ID from the modio page, adding “UGC” in front of it and then adding that to the rotation. For example the map gravity <nowiki>https://mod.io/g/pavlov/m/gravity1</nowiki> has a resource ID of 2773760 so the map ID to add to the server would be “UGC2773760”. When a match ends, the server will load the next map in the rotation.
	* AdditionalMods - you can add multiple of these. Find the mod(s) you want add on modio and take its resource ID, adding 'UGC' to the front of it.		* '''AdditionalMods''' - you can add multiple of these. Find the mod(s) you want add on modio and take its resource ID, adding 'UGC' to the front of it.
	* '''AFKTimeLimit''' There is now a feature to kick players who are idle in the game. Integers are measured in seconds and 0 disables AFK kicking completely.		* '''AFKTimeLimit''' There is now a feature to kick players who are idle in the game. Integers are measured in seconds and 0 disables AFK kicking completely.

← Older revision		Revision as of 07:37, 3 January 2025
Line 75:		Line 75:
	=== Starting Server Install ===		=== Starting Server Install ===

	====Obtaining an ~~ApiKey~~ ====		====Obtaining an ServerKey ====
	[[File:Server API Key.jpg\|thumb\|Example code generated in settings menu]]		[[File:Server API Key.jpg\|thumb\|Example code generated in settings menu]]
	'''<u>This is required for all servers as of the December 2024 Pavlov Update.</u>'''		'''<u>This is required for all servers as of the December 2024 Pavlov Update.</u>'''
Line 99:		Line 99:
	* '''Store your server key in a safe place, such as a password or secret manager.'''		* '''Store your server key in a safe place, such as a password or secret manager.'''
	Save this key for later, so that you can ut this key in your Game.ini as follows:		Save this key for later, so that you can ut this key in your Game.ini as follows:
	~~ApiKey~~="ABC123FALSEKEYDONTUSEME"		ServerKey="ABC123FALSEKEYDONTUSEME"
	or if you would like (personally untested..I would use Game.ini) you can call it at server runtime with flag as follows:		or if you would like (personally untested..I would use Game.ini) you can call it at server runtime with flag as follows:
	-KEY="ABC123FALSEKEYDONTUSEME"		-KEY="ABC123FALSEKEYDONTUSEME"

	This key can be re-used for a reasonable number of servers (a limit of 10 has been mentioned). Contact the Devs if you need more servers per key.		This key can be re-used for a reasonable number of servers (a limit of 10 has been mentioned). Contact the Devs if you need more servers per key.

	====System setup and software installation====		====System setup and software installation====
	In this step we will:		In this step we will: