Server Configuration - Revision history

Nerf cardboard at 17:46, 10 June 2023

2023-06-10T17:46:45Z

← Older revision		Revision as of 17:46, 10 June 2023
Line 26:		Line 26:

	== Scripts//.cs ==		== Scripts//.cs ==
	C# scripts that define custom behaviour. See [[:Category:~~Scripting~~]].		C# scripts that define custom behaviour. See [[:Category:Modding]].

	== Cycles//.json ==		== Cycles//.json ==

Nerf cardboard at 11:14, 10 June 2023

2023-06-10T11:14:26Z

← Older revision		Revision as of 11:14, 10 June 2023
Line 40:		Line 40:

	= How to... =		= How to... =

			== customize match duration, score limit ==

			Edit each file in <code>Rules/Standard/</code> and set:
			* <code>Match.MatchSecs</code>
			* <code>Match.ScoreLimit</code>

	== Manage bots ==		== Manage bots ==

			In autoconfig.ini, set:

	* FillBotsCount - the amount of bots added to an empty server. they will be replaced by human players.		* FillBotsCount - the amount of bots added to an empty server. they will be replaced by human players.
Line 47:		Line 55:

	== Set up admin commands ==		== Set up admin commands ==

			In autoconfig.ini, set:

	* AdminPlayfabID - your Playfab ID to be admin automatically (To find your Playfab ID, start the server and join with your client. Your Playfab ID will show up in the server logs as <code>1 YOUR_NAME joined the server [YOUR_PLAYFAB_ID]</code>)		* AdminPlayfabID - your Playfab ID to be admin automatically (To find your Playfab ID, start the server and join with your client. Your Playfab ID will show up in the server logs as <code>1 YOUR_NAME joined the server [YOUR_PLAYFAB_ID]</code>)
Line 52:		Line 62:

	== Play pre-selected maps & game modes only ==		== Play pre-selected maps & game modes only ==

			In autoconfig.ini, set:

	* UseLobby = False		* UseLobby = False

Nerf cardboard: restructure

2023-06-10T11:11:16Z

restructure

← Older revision		Revision as of 11:11, 10 June 2023
Line 1:		Line 1:
	~~Configuration is split across several locations:~~		= Config Files =
	* <code>autoconfig.ini</code> - basic settings like server name, password, player limit, bot count, lobby mode.
	* <code>Rules/</code> - each JSON file defines a game mode (eg CTF, DM, etc). In these files match duration, score limit, teams, default weapon selection, medkits, etcpp are defined.
	* <code>Levels/Custom/</code> - Contains custom maps. Get some maps from [https://tms2.jrgp.org/ TMS2]. See also: [[Mapping \| Mapping Guide]].
	* <code>Modifiers/</code> - Contains modifiers that customize some parameters of the game (and can be voted for by players in the lobby for each match). See [[Custom Modifiers]] for details.
	* <code>Scripts/</code> - C# scripts that define custom behaviour. See [[:Category:Scripting]].
	* <code>Cycles/</code> - Map rotations (for when lobby is disabled).
	* <code>greet.txt</code> - Server info message showing in the popup before each match. Supports [TODO custom formatting]

			== autoconfig.ini ==
			Contains basic settings like server name, password, player limit, bot count, lobby mode.

	~~= Example Configurations =~~		Most relevant options are fairly self-explanatory.
			You should change at least the following options:
			* <code>Name</code> - sets the server name
			* <code>MaxPlayers</code> - set the maximum of players on the server
			* <code>VisibleInGamesList</code> - set to false, if you host in LAN only, to not confuse external players with your server in the server listing

	~~Use~~ the ~~following public~~ server ~~configurations~~ as ~~examples, or a baseline for your own configuration:~~		'''''Note''''': only ever write changes to autoconfig.ini after the server has stopped - your changes will be lost as the file is rewritten when the server stops.

	* [https://~~codeberg~~.org/~~norwin~~/~~soldat2-custom~~/~~src/branch/server/nolobby @noerws Vote Fast server]~~ (~~among others~~)		All options in autoconfig.ini can be defined via CLI arguments (eg <code>./soldat2 ServerPassword=foobar</code>), as well as dynamically in-game via rcon commands (eg <code>rcon set ServerPassword foobar</code>).


			== Rules//.json ==
			Each JSON file defines a game mode (eg CTF, DM, etc).
			In these files match duration, score limit, teams, default weapon selection, medkits, etcpp are defined.

			== Levels//.json ==
			Contains custom maps. Get some maps from [https://tms2.jrgp.org/ TMS2]. See also [[Mapping \| Mapping Guide]].

			== Modifiers//.json ==
			Contains modifiers that customize some parameters of the game (and can be voted for by players in the lobby for each match). See [[Custom Modifiers]] for details.

	= ~~FAQ~~ =		== Scripts//.cs ==
			C# scripts that define custom behaviour. See [[:Category:Scripting]].

	== ~~autoconfig~~.~~ini~~ ==		== Cycles//.json ==
			Map rotations (for when lobby is disabled).

	~~'''''Note''''': only ever write changes to autoconfig~~.~~ini after~~ the ~~server has stopped - your changes will be lost as the file is rewritten when the server stops~~.		== greet.txt ==
			Server info message showing in the popup before each match. Supports [TODO custom formatting]

	~~Most relevant options are fairly self-explanatory.~~		= Examples =
	You ~~should change at least~~ the following options:		You can use the following public server configurations as examples, or a baseline for your own configuration:
	* Name - sets the server name
	* MaxPlayers - set the maximum of players on the server

	~~Also, fill greet~~.~~txt with your own content~~ - ~~it is displayed at the beginning of each match~~		* [https://codeberg.org/norwin/soldat2-custom/src/branch/server/nolobby @noerws Vote Fast server] (among others)

	~~All options in autoconfig~~.~~ini can be defined via CLI arguments (eg <code>~~.~~/soldat2 ServerPassword~~=~~foobar</code>), as well as dynamically in-game via rcon commands (eg <code>rcon set ServerPassword foobar</code>).~~		= How to... =

	=== Manage bots ===		== Manage bots ==

	* FillBotsCount - the amount of bots added to an empty server. they will be replaced by human players.		* FillBotsCount - the amount of bots added to an empty server. they will be replaced by human players.
	* FillBotsDifficulty - 0 is stupid, 3 is butcher		* FillBotsDifficulty - 0 is stupid, 3 is butcher

	=== Set up admin commands ===		== Set up admin commands ==

	* AdminPlayfabID - your Playfab ID to be admin automatically (To find your Playfab ID, start the server and join with your client. Your Playfab ID will show up in the server logs as <code>1 YOUR_NAME joined the server [YOUR_PLAYFAB_ID]</code>)		* AdminPlayfabID - your Playfab ID to be admin automatically (To find your Playfab ID, start the server and join with your client. Your Playfab ID will show up in the server logs as <code>1 YOUR_NAME joined the server [YOUR_PLAYFAB_ID]</code>)
	* RconPassword - if set, more than one player can send admin commands.		* RconPassword - if set, more than one player can send admin commands.

	=== Play pre-selected maps & game modes only ===		== Play pre-selected maps & game modes only ==

	* UseLobby = False		* UseLobby = False
Line 56:		Line 67:
	}]		}]
	</pre>		</pre>


	[[Category:Dedicated Server]]		[[Category:Dedicated Server]]

Nerf cardboard: layout

2023-06-10T11:02:36Z

layout

← Older revision		Revision as of 11:02, 10 June 2023
Line 1:		Line 1:
	~~[[Category:Dedicated Server]]~~

	Configuration is split across several locations:		Configuration is split across several locations:
	* <code>autoconfig.ini</code> - basic settings like server name, password, player limit, bot count, lobby mode.		* <code>autoconfig.ini</code> - basic settings like server name, password, player limit, bot count, lobby mode.
Line 9:		Line 7:
	* <code>Cycles/</code> - Map rotations (for when lobby is disabled).		* <code>Cycles/</code> - Map rotations (for when lobby is disabled).
	* <code>greet.txt</code> - Server info message showing in the popup before each match. Supports [TODO custom formatting]		* <code>greet.txt</code> - Server info message showing in the popup before each match. Supports [TODO custom formatting]


	= Example Configurations =		= Example Configurations =
Line 57:		Line 56:
	}]		}]
	</pre>		</pre>

			[[Category:Dedicated Server]]

Nerf cardboard at 11:02, 10 June 2023

2023-06-10T11:02:01Z

← Older revision		Revision as of 11:02, 10 June 2023
Line 10:		Line 10:
	* <code>greet.txt</code> - Server info message showing in the popup before each match. Supports [TODO custom formatting]		* <code>greet.txt</code> - Server info message showing in the popup before each match. Supports [TODO custom formatting]

			= Example Configurations =

	~~= Public example configurations =~~		Use the following public server configurations as examples, or a baseline for your own configuration:

	Use the following server configurations as examples, or a baseline for your own configuration:

	* [https://codeberg.org/norwin/soldat2-custom/src/branch/server/nolobby @noerws Vote Fast server] (among others)		* [https://codeberg.org/norwin/soldat2-custom/src/branch/server/nolobby @noerws Vote Fast server] (among others)
Line 22:		Line 21:

	'''''Note''''': only ever write changes to autoconfig.ini after the server has stopped - your changes will be lost as the file is rewritten when the server stops.		'''''Note''''': only ever write changes to autoconfig.ini after the server has stopped - your changes will be lost as the file is rewritten when the server stops.


	Most relevant options are fairly self-explanatory.		Most relevant options are fairly self-explanatory.
Line 30:		Line 28:

	Also, fill greet.txt with your own content - it is displayed at the beginning of each match		Also, fill greet.txt with your own content - it is displayed at the beginning of each match

			All options in autoconfig.ini can be defined via CLI arguments (eg <code>./soldat2 ServerPassword=foobar</code>), as well as dynamically in-game via rcon commands (eg <code>rcon set ServerPassword foobar</code>).

	=== Manage bots ===		=== Manage bots ===

Nerf cardboard: extract content from Server Hosting page

2023-06-10T10:52:01Z

extract content from Server Hosting page

New page

[[Category:Dedicated Server]]

Configuration is split across several locations:
* <code>autoconfig.ini</code> - basic settings like server name, password, player limit, bot count, lobby mode.
* <code>Rules/</code> - each JSON file defines a game mode (eg CTF, DM, etc). In these files match duration, score limit, teams, default weapon selection, medkits, etcpp are defined.
* <code>Levels/Custom/</code> - Contains custom maps. Get some maps from [https://tms2.jrgp.org/ TMS2]. See also: [[Mapping | Mapping Guide]].
* <code>Modifiers/</code> - Contains modifiers that customize some parameters of the game (and can be voted for by players in the lobby for each match). See [[Custom Modifiers]] for details.
* <code>Scripts/</code> - C# scripts that define custom behaviour. See [[:Category:Scripting]].
* <code>Cycles/</code> - Map rotations (for when lobby is disabled).
* <code>greet.txt</code> - Server info message showing in the popup before each match. Supports [TODO custom formatting]

= Public example configurations =

Use the following server configurations as examples, or a baseline for your own configuration:

* [https://codeberg.org/norwin/soldat2-custom/src/branch/server/nolobby @noerws Vote Fast server] (among others)

= FAQ =

== autoconfig.ini ==

'''''Note''''': only ever write changes to autoconfig.ini after the server has stopped - your changes will be lost as the file is rewritten when the server stops.

Most relevant options are fairly self-explanatory.
You should *change at least the following options*:
* Name - sets the server name
* MaxPlayers - set the maximum of players on the server

Also, fill greet.txt with your own content - it is displayed at the beginning of each match

=== Manage bots ===

* FillBotsCount - the amount of bots added to an empty server. they will be replaced by human players.
* FillBotsDifficulty - 0 is stupid, 3 is butcher

=== Set up admin commands ===

* AdminPlayfabID - your Playfab ID to be admin automatically (To find your Playfab ID, start the server and join with your client. Your Playfab ID will show up in the server logs as <code>1 YOUR_NAME joined the server [YOUR_PLAYFAB_ID]</code>)
* RconPassword - if set, more than one player can send admin commands.

=== Play pre-selected maps & game modes only ===

* UseLobby = False
* AllowVoting = False
* GamesCycleFile = Cycles/Custom/selected-maps.json

Having this, list the maps you want in your game cycle:
<pre>
nano Cycles/Custom/selected-maps.json
</pre>
<pre>
[{
"Rules": "Deathmatch",
"Level": "dm_epitaph"
}]
</pre>