Setting up a dedicated server - Revision history

Junt: added API key instructions

2026-11-02T21:34:01Z

added API key instructions

← Older revision		Revision as of 16:34, 2 November 2026
Line 16:		Line 16:

	'''If you don't want to go through the hassle yourself and want to pay for a hosting service: [https://www.arctic-vr.com/ Arctic VR (For both PC and Shack)] and Horde (Shack) provide a server hosting services and are trusted in the community.'''		'''If you don't want to go through the hassle yourself and want to pay for a hosting service: [https://www.arctic-vr.com/ Arctic VR (For both PC and Shack)] and Horde (Shack) provide a server hosting services and are trusted in the community.'''
			----

			== Getting your API Key ==
			Pavlov now requires you to generate an API key based on your Pavlov Game Account


			'''If a third-party host such as "Arctic VR" runs your server, their admins will set up the key for you. You don't need to do anything.'''


			If your custom server no longer shows up in the server browser, it doesn't have a server key linked to your account yet. Here's how to set one up:

			1. Generate a PIN. In game, go to Settings → General → Server Key Generator to get a 6-digit PIN.

			2. Get your server key. Go to [https://api-key.vankrupt.net/ api-key.vankrupt.net] and enter:

			a. Meta Quest: your current username, spelled exactly as it appears in game, and your 6-digit PIN.

			b. Steam: your Steam ID and your 6-digit PIN.

			3. Add the key to your server. Open your server's Game.ini and add this line

			'''ServerKey=<your server key>'''

			4. Then restart your server.
	----		----

Smalldarkie: Removed all mentions of a server api key at invicta's request.

2026-08-18T12:16:29Z

Removed all mentions of a server api key at invicta's request.

@@ Line 74: / Line 74: @@
 === Starting Server Install ===
 ====System setup and software installation====
@@ Line 227: / Line 197: @@
 If starting the server did not create a default Game.ini, create a new Game.ini file using following command to open an editor and copy/paste the following block into it then save it.
-Note not all of these options are required. For instance remove or comment out the Password=0000 line to make a public server with no pin.
+Note not all of these options are required. For instance remove or comment out the Password=0000 line to make a public server with no pin.  <pre>
 nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini
 </pre>
@@ Line 239: / Line 206: @@
 ServerName="My_private_idaho"
 MaxPlayers=10     #its recommended for the best experience to keep shack servers at or below 10 players pcvr and psvr are both capped at 24 too.
 bSecured=true
 bCustomServer=true

MessiahPenguin: /* Configuring Game.ini */ bEnableBots in INI added

2026-08-12T20:38:04Z

Configuring Game.ini: bEnableBots in INI added

← Older revision		Revision as of 15:38, 12 August 2026
Line 243:		Line 243:
	bCustomServer=true		bCustomServer=true
	bVerboseLogging=false		bVerboseLogging=false
			bEnableBots=false
	bCompetitive=false #This only works for SND		bCompetitive=false #This only works for SND
	bWhitelist=false		bWhitelist=false
Line 266:		Line 267:
	* '''bCompetitive''' - sets the server to competitive mode for SND. If removed the server will default to false		* '''bCompetitive''' - sets the server to competitive mode for SND. If removed the server will default to false
	* '''bVerboseLogging''' - enables verbose logging, mostly detailed statistics. Be prepared for significant increase in logging.		* '''bVerboseLogging''' - enables verbose logging, mostly detailed statistics. Be prepared for significant increase in logging.
			* '''bEnableBots''' - enables bots on the server. The bots will fill the server to the max players limit.
	* '''bWhitelist''' - Only allow users in whitelist.txt to join		* '''bWhitelist''' - Only allow users in whitelist.txt to join
	* '''RefreshListTime''' - sets how often the running server checks for updates in ban/whitelist/mod files		* '''RefreshListTime''' - sets how often the running server checks for updates in ban/whitelist/mod files

GrannyWuzzle: updated the public server listing url and version

2026-06-08T15:50:32Z

updated the public server listing url and version

← Older revision		Revision as of 10:50, 8 June 2026
Line 522:		Line 522:
	If you're also handy with cURL, you can query the vankrupt game server listing directly, for Oculus/Shack servers, and PC servers:		If you're also handy with cURL, you can query the vankrupt game server listing directly, for Oculus/Shack servers, and PC servers:

	* <nowiki>https://~~prod~~-shack-pavlov-ms.vankrupt.net/servers/v2/list/1.0.17/oculus_app_id/0/0/0/all</nowiki>		* <nowiki>https://prod2-shack-pavlov-ms.vankrupt.net/servers/v2/list/1.0.27/oculus_app_id/0/0/0/all</nowiki>
	* <nowiki>https://~~prod~~-shack-pavlov-ms.vankrupt.net/servers/v2/list/1.0.17/oculus/0/0/0/all</nowiki>		* <nowiki>https://prod2-shack-pavlov-ms.vankrupt.net/servers/v2/list/1.0.27/oculus/0/0/0/all</nowiki>
	* <nowiki>https://~~prod~~-crossplay-pavlov-ms.vankrupt.net/servers/v2/list/1.0.17/steam/0/0/0/all</nowiki>		* <nowiki>https://prod2-crossplay-pavlov-ms.vankrupt.net/servers/v2/list/1.0.27/steam/0/0/0/all</nowiki>

	where 1.0.17 is the version of the game. You can check the current version of the game your server is running by checking your log file (/home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log) and checking for the "version" line early in the startup of the log file.		where 1.0.27 is the version of the game. You can check the current version of the game your server is running by checking your log file (/home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log) and checking for the "version" line early in the startup of the log file.

	The endpoint also supports filtering - changing the '''/0/0/0''' in the URL will have the following effects:		The endpoint also supports filtering - changing the '''/0/0/0''' in the URL will have the following effects:

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 06: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 15: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 15: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 15: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

← Older revision		Revision as of 06: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: