Server Hosting - Revision history

Nerf cardboard: simplify configuration section, refer to new page 'Server Configuration

2023-06-10T10:57:25Z

simplify configuration section, refer to new page 'Server Configuration

@@ Line 1: / Line 1: @@
 A dedicated server can be hosted on linux x86_64 systems - not on windows currently (running on WSL appears to be working [citation needed]).
@@ Line 58: / Line 60: @@
 === Init.d ===
 === Multiple Servers on the same machine ===
@@ Line 71: / Line 75: @@
 == 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.
@@ Line 93: / Line 87: @@
 * 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
+For more details regarding configuration see [[Server Configuration]].
 == Usage ==

Nerf cardboard: document locations of all configuration files

2023-06-10T10:35:10Z

document locations of all configuration files

← Older revision		Revision as of 10:35, 10 June 2023
Line 71:		Line 71:

	== Configuration ==		== Configuration ==

			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 the [[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>autoconfig.ini</code> ===

	_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.
Line 86:		Line 96:
	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

	=== 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

Nerf cardboard: link to ansible deployment

2023-02-14T15:20:12Z

link to ansible deployment

← Older revision		Revision as of 15:20, 14 February 2023
Line 16:		Line 16:

	The following guide was originally written by Maz on [https://steamcommunity.com/sharedfiles/filedetails/?id=2793260281 steam] for a Ubuntu 20.04 system.		The following guide was originally written by Maz on [https://steamcommunity.com/sharedfiles/filedetails/?id=2793260281 steam] for a Ubuntu 20.04 system.

			If you are familiar with Ansible, the easiest setup could be to use [https://codeberg.org/norwin/soldat2-ansible this playbook] instead.

	=== Preamble ===		=== Preamble ===

Nerf cardboard at 14:04, 19 January 2023

2023-01-19T14:04:57Z

← Older revision		Revision as of 14:04, 19 January 2023
Line 50:		Line 50:
	<pre>		<pre>
	cd soldat2-linuxserver-release		cd soldat2-linuxserver-release
	./~~soldat~~		./soldat2
	</pre>		</pre>

	Once the server has started, you may stop the server again (CTRL+C), so you should modify the newly-generated config file (see blow).		Once the server has started, you may stop the server again (CTRL+C), so you should modify the newly-generated config file (see blow).

			=== Init.d ===

			=== Multiple Servers on the same machine ===

			You can technically start multiple servers, each with their own configuraion

	=== Common issues ===		=== Common issues ===
Line 64:		Line 70:
	== Configuration ==		== 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.		_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.

	Open the config file with your preferred text editor:		Open the config file with your preferred text editor:
Line 119:		Line 125:
	* Open the console by pressing Alt+~. There you can enter commands (use Tab to see available commands. syntax is not case sensitive).		* Open the console by pressing Alt+~. There you can enter commands (use Tab to see available commands. syntax is not case sensitive).

	* Gain admin rights: If you entered a AdminPlayfabID in autoconfig.ini, you should have a red [Admin] tag on the scoreboard. Other players can also gain admin privileges by running the command <code>rcon ~~<~~password~~>~~</code> in the console.		* Gain admin rights: If you entered a AdminPlayfabID in autoconfig.ini, you should have a red [Admin] tag on the scoreboard. Other players can also gain admin privileges by running the command <code>rcon [password]</code> in the console.

	* To apply a command to the server, prefix them with <code>rcon</code>. Apparently, the commands are not case sensitive.		* To apply a command to the server, prefix them with <code>rcon</code>. Apparently, the commands are not case sensitive.
Line 170:		Line 176:
	* kick all players with a reason: <code>rcon kickall "restarting the server to fix disconnect issues. will be back in a minute"</code>		* kick all players with a reason: <code>rcon kickall "restarting the server to fix disconnect issues. will be back in a minute"</code>

	* manually balance teams: <code>rcon listplayers</code>, <code>rcon setteam ~~<~~playerid~~> <~~0\|1~~>~~</code>		* manually balance teams: <code>rcon listplayers</code>, <code>rcon setteam [playerid] [0\|1]</code>

Nerf cardboard: Created page with "A dedicated server can be hosted on linux x86_64 systems - not on windows currently (running on WSL appears to be working [citation needed]). The most recent version can be downloaded from [https://soldat2.com/downloads.html soldat2.com/downloads]. == System requirements == For up to 8 players the following resources are enough: * some Linux distro with glibc * 1 vCPU (x86_64) * 512MB RAM With more players, occasional lags start happening, you should provide more CP..."

2023-01-19T13:55:46Z

Created page with "A dedicated server can be hosted on linux x86_64 systems - not on windows currently (running on WSL appears to be working [citation needed]). The most recent version can be downloaded from [https://soldat2.com/downloads.html soldat2.com/downloads]. == System requirements == For up to 8 players the following resources are enough: * some Linux distro with glibc * 1 vCPU (x86_64) * 512MB RAM With more players, occasional lags start happening, you should provide more CP..."

New page

A dedicated server can be hosted on linux x86_64 systems - not on windows currently (running on WSL appears to be working [citation needed]).

The most recent version can be downloaded from [https://soldat2.com/downloads.html soldat2.com/downloads].

== System requirements ==

For up to 8 players the following resources are enough:

* some Linux distro with glibc
* 1 vCPU (x86_64)
* 512MB RAM

With more players, occasional lags start happening, you should provide more CPU in that case.

== Setup ==

The following guide was originally written by Maz on [https://steamcommunity.com/sharedfiles/filedetails/?id=2793260281 steam] for a Ubuntu 20.04 system.

=== Preamble ===
For this guide, understanding of the Linux-based operating system you're using, specifically the command line, is highly advised.
This is not a noob-friendly guide, one may or may not be created by the community. This is a simplified, barebones guide to serve as a guideline for Soldat 2 server hosting.
If you run into any major issues or errors, related to for example a specific OS or library support, please post below so it can be looked at. If you need personal (real-time) assistance, you're better off joining the official Discord instead of asking around in the #help channel: https://discord.gg/T8ejr5u

=== Port forwarding ===
The default port for Soldat 2 is 33073. If you are running the server behind a firewall (e.g. a server at home, rather than an external dedicated server or VPS) make sure to port-forward this port for TCP & UDP.
If you wish to use another port, you set this in the config later in the guide.

=== Installing the server ===
You should create a new user for Soldat 2 and NOT run the following commands as root. If you're root, this might work:
<pre>
useradd soldat2
sudo -i soldat2
</pre>

You can run a server on the release version or on the beta version. Choose one of the packages below.
<pre>
wget https://dl.thd.vg/soldat2-linuxserver-release.tar.gz
wget https://dl.thd.vg/soldat2-linuxserver-test.tar.gz
</pre>

The following commands assume you've downloaded the release version.
If you downloaded the test version, change the file naming accordingly.

Decompress the package:
<pre>
tar -zxf soldat2-linuxserver-release.tar.gz
</pre>

Navigate to the server folder, and run the server once to generate the configuration file <code>autoconfig.ini</code>:
<pre>
cd soldat2-linuxserver-release
./soldat
</pre>

Once the server has started, you may stop the server again (CTRL+C), so you should modify the newly-generated config file (see blow).

=== Common issues ===

==== SSL errors ====
<pre>
sudo apt install -y apt-transport-https ca-certificates curl software-properties-common
</pre>

== 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.

Open the config file with your preferred text editor:
<pre>
nano autoconfig.ini
</pre>

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>

== Usage ==

See also [[Command Line Arguments]].

=== Admin Commands ===

To wield admin power on your server:

* Set up admin access in configuration (see above)

* Join the server

* Open the console by pressing Alt+~. There you can enter commands (use Tab to see available commands. syntax is not case sensitive).

* Gain admin rights: If you entered a AdminPlayfabID in autoconfig.ini, you should have a red [Admin] tag on the scoreboard. Other players can also gain admin privileges by running the command <code>rcon <password></code> in the console.

* To apply a command to the server, prefix them with <code>rcon</code>. Apparently, the commands are not case sensitive.

==== Available commands ====

copied from faq.txt in the 0.8.60 server tarball:
<pre>
Vote
Info
AddBot
RemBot
Restart
NextMap
LoadMap [mapname] [gamemode]
AddModifier [modifier] (Restart or LoadMap to apply)
RemoveModifier [modifier]
Ban [id] - bans for a couple days
Kick [id]
Kick [id] "reason" (use parenthesis eg. kick 13 "for being mean")
KickAll
KickAll "reason"
SetTeam [id] [team] (will disable autobalance for the duration of the match)
ListPlayers
ListMaps
Say [optional-id] "" (use parenthesis eg. say "hello world")
LoadCycle [Cycles/filename.json]
Rcon [command]
Rcon [password] (first, if not admin)
Reload (recompiles scripts)
Info (useful info)
Vote (starts map vote)
RestartServer (reloads the map cycle and restarts)
Version (prints game version)

Set [variable] [value]
- use proper casing
- works for config vars (autoconfig.json) eg. "Set ServerPassword bla"
- rules components (eg. Rules/CaptureTheFlag.json) eg. "Set Match.MinimumPlayers 4"
- client settings (client.json) eg. "Set GameSettings.SoundsVolume 0.75"
Get [variable]
</pre>

==== Examples ====

* dynamically change the amount of bots on the server to 5 - numPlayers: <code>rcon set fillbotscount 5</code>

* restart the match with a modifier added: <code>rcon addmodifier Amputation</code>, then <code>rcon restart</code>

* kick all players with a reason: <code>rcon kickall "restarting the server to fix disconnect issues. will be back in a minute"</code>

* manually balance teams: <code>rcon listplayers</code>, <code>rcon setteam <playerid> <0|1></code>