Soldat2 Wiki - User contributions [en]

Custom Modifiers

2023-06-10T17:48:56Z

Nerf cardboard:

Modifiers are snippets of configuration that partially override the default game config, which makes for some nice match variation in servers.

Check the default configuration file <code>Modifiers/_default.json</code> (contains anything not related to game modes: eg weapons, player movement, ...) as a reference of available parameters.
Follow the '''exact''' same structure as in this file - ie. all parameters are within the "Objects" key.

To customize game mode configuration, there is the special namespace "Objects.Rules". This also allows to load custom scripts, by adding an object key with the script class name.

Some more hints:
* You only need to specify the parameter you want to change. Due to some bugs, this does not work for some objects (eg MeleeWeapon) - there all parameters of the object need to be specified.
* Its possible to add or remove elements from lists, instead of replacing the whole default list. To do this, prefix the parameter name with <code>+</code> or <code>-</code> (eg <code>"-PrimaryWeapons": ["Minigun"]</code>). This improves composability of multiple Modifiers. On non-lists, a <code>-</code>-prefix removes the whole element.
* Changes are applied whenever the file is saved. This works for most parameters, but not all.
* The JSON parser understands JSON2, so trailing commas and comments are allowed.

= Example =
Example:

<pre>
{
"Objects": {
"Rules": {
// customizing game rules parameters
"StandardGameplay": {
"DamageModifier": 2
},
"-RandomDrops": {}
// loading a custom script
"MyCustomScript": {
"SomeScriptParameter": 1.0
}
},
"Gostek": {
"PhysicsObject": {
"Mass": 0.65, // faster movement by making players lighter
}
}
},
"Meta": {
"Description": "this text shows up as a tooltip in the lobby",
"Author": "",
"Version": "1.0",
"Game": "Soldat2",
"GameVersion": "0.8.67"
}
}
</pre>

[[Category:Modding]]

Server Configuration

2023-06-10T17:46:45Z

Nerf cardboard:

= Config Files =

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

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

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

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.

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

== Cycles/*/*.json ==
Map rotations (for when lobby is disabled).

== greet.txt ==
Server info message showing in the popup before each match. Supports [TODO custom formatting]

= Examples =
You can use the following public 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)

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

In autoconfig.ini, set:

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

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>)
* RconPassword - if set, more than one player can send admin commands.

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

In autoconfig.ini, set:

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

[[Category:Dedicated Server]]

Scripting Examples

2023-06-10T11:48:59Z

Nerf cardboard: move to Category:Modding

This page contains a selection of unofficial scripts to demonstrate the usage of various aspects of Soldat 2's scripting API.

== Team Balancer ==
<syntaxhighlight lang="C#">
// a basic team-balancing script to illustrate how to implement simple
// chat-commands using S2 scripting

// 'using' directives let you omit namespacing
// eg: Player rather than the full Teal.Player
using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using Teal;

[DisallowMultipleComponent]

// the class name as defined here is what you need to refer to in any json
// config files, NOT the name of this script file. Case sensitive.
public class Balance : MonoBehaviour
{
// called when the script is loaded
private void Awake()
{
// this registers a function (OnPlayerChat in this case) to be called
// whenever a player chat event occurs
// for other types of events, check in the modding channel on S2 discord
GameChat.instance.OnChat.AddListener(OnPlayerChat);
}

// called before the script is unloaded, probably when the server closes/restarts
private void OnDestroy()
{
// presumably important to prevent your script from continuing to respond
// to events after it gets removed/disabled
GameChat.instance.OnChat.RemoveListener(OnPlayerChat);
}

// user-defined function for handling chat events - the name can be any
// (valid) identifier, only the signature is important
void OnPlayerChat(Player p, string msg)
{
// we are only implementing a single command in this example, but if
// you want to have multiple commands a switch/case statement is probably
// more appropriate
if( msg == "!bal" || msg == "!balance" )
{
// first we grab a list of the players on each team
List<Player> t0 = MonoSingleton<Players>.Get.GetPlayersOfTeam(0);
List<Player> t1 = MonoSingleton<Players>.Get.GetPlayersOfTeam(1);

// integer division rounds down, so we will only do something if teams
// are unbalanced by more than one player
int hdiff = (t0.Count-t1.Count)/2;
if( hdiff > 0 )
{ // more players on team 0, move half the difference to team 1
for( int i=0; i<hdiff; i++ ) t0[i].props["team"] = 1;
return;
}
else if( hdiff < 0 )
{ // more players on team 1, move half the difference to team 0
for( int i=0; i<-hdiff; i++ ) t1[i].props["team"] = 0;
return;
}
}
}

}
</syntaxhighlight>

[[Category:Modding]]

Scripting Events

2023-06-10T11:48:44Z

Nerf cardboard: move to Category:Modding

The main method for reacting to gameplay events in Soldat 2 scripting is by registering ''listeners''. This is done by calling the <code>AddListener()</code> function, usually on the <code>Eventor</code> object.

[[Category:Modding]]

== Eventor Events ==
In the case of Eventor listeners, you will need to specify both the event type to listen for, as well as a function to be called when the event occurs. Callback functions should have the signature <code>void cb_func(IGameEvent)</code>.

The event types that are used with Eventor are defined by the <code>Events</code> enum, which currently contains:
* None
* New_Connection (GlobalPlayerConnectionEvent)
* Created
* Destroyed
* Died
* Add_Player
* Remove_Player
* Player_Joined (GlobalPlayerEvent has .Player)
* Player_Assigned
* Player_Left
* Player_Changed_Team
* Player_Unassigned
* Level_Loaded
* Rules_Loaded
* Impacted
* Weapon_Selected
* Trigger (GlobalTriggerEvent)
* Match_Waiting
* Match_Warmup
* Match_Started
* Match_Ended
* Hit (GlobalHitEvent)
* Camera_Target_Changed
* Camera_Created
* Powerup_Started
* Powerup_Ended
* Bullet_Created
* Bot_Assigned
* Flag_Captured
* Flag_Returned
* Flag_Grabbed
* Use_Weapon
* Construct_AddBody
* Construct_RemoveBody
* Properties_Changed
* Item_Dropped (GlobalItemEvent has .Item and .Holder)
* Item_Picked (GlobalItemEvent has .Item and .Holder)
* AssignedNetworkId
* Changed_Team
* Request_Spawn
* End_Condition
* Reserved

A full example of an AddListener call is <code>Eventor.AddListener(Events.Died, OnPlayerDied)</code>. These calls are usually placed within the <code>Awake()</code> function of the script, which is executed when the script is loaded. Note that each AddListener call should be paired with a RemoveListener call (usually in the <code>OnDestroy()</code> function) to ensure that the script does not continue to respond to events after it has been disabled. See the Unity manual entry for the [https://docs.unity3d.com/2020.1/Documentation/ScriptReference/MonoBehaviour.html MonoBehaviour] class for other special functions.

== Other Events ==
Not all necessary game events are currently accessible with just the Eventor object, methods for adding listeners to other useful events are listed below:
* Player chat events: <code>GameChat.instance.OnChat.AddListener()</code>, only takes a callback function as an argument, required signature for callback is <code>void cb_func(Player, string)</code>

If an event is not available for a specific gameplay element you are interested in responding to, it is also possible to use a polling approach to detect that event by using either the <code>Update()</code> or <code>FixedUpdate()</code> functions which are called periodically by the engine. For example, something equivalent to this is used in the official <code>Climb.cs</code> script to detect when any player gets within 1.5 range of a checkpoint:
<syntaxhighlight lang="C#">
void FixedUpdate() // runs 10 times per second
{
for (int i = checkpoints.Count - 1; i >= 0; i--)
{
foreach (Player player in Players.Get.GetAlive())
{
// for each (player,checkpoint) pair, check if the distance between them is less than 1.5
if ((player.controlled.transform.position - checkpoints[i].transform.position).magnitude < 1.5f)
{
checkpoints.RemoveAt(i);
lastCheckpointPlayer = player;
break;
}
}
}
}
</syntaxhighlight>

Category:Scripting

2023-06-10T11:48:27Z

Nerf cardboard: drop this nested category

Scripting Introduction

2023-06-10T11:47:41Z

Nerf cardboard: move to Category:Modding

Scripting in Soldat 2 is done in a Unity/C# environment. For a script to be usable in-game, the script file must be placed under <code>Soldat2/Scripts/</code> and there needs to be a ruleset that specifies that script in the GameScript object in its json - for example, see <code>Soldat2/Rules/Standard/Climb.json</code>. The script can be tested by starting a game that uses that ruleset.

[[Category:Modding]]

== Scripting Resources ==
The Soldat 2 engine uses Unity, so it may be useful to familiarise yourself with the [https://docs.unity3d.com/2020.1/Documentation/Manual/index.html Unity Manual].

There is some [https://soldat2.com/docs/ preliminary documentation] for the Soldat 2 engine, however it is currently rather limited.

Some examples of scripts can be found in your Soldat 2 game directory under the path <code>Soldat2/Scripts/Standard/</code>. Some unofficial examples are available at [[Scripting Examples]].

See [[:Category:Scripting]] for a list of all pages on this wiki related to scripting.

== Using Scripts ==

A script can be applied to a match via [[Modifiers]] or via a [[Game Mode]] ("Rules").

=== In a modifier ===
Example of a modifier <code>Modifiers/Custom/FlagIsPoison.json</code> applying the <code>Scripts/Custom/FlagIsPoison.cs</code> script:

<syntaxhighlight lang="JSON">
{
"Objects": {
"Rules": {
"FlagIsPoison": {
"FlagDamagePerSecond": 3.0
}
}
},
"Meta": {
"Description": "(applies the FlagIsPoison script)",
"Author": "noerw",
"Version": 1.0
}
}
</syntaxhighlight>

A script can be parametrized, where the parameters are defined in the modifier or rule definition. In the above example the <code>FlagDamagePerSecond</code> parameter is applied when the script class contains a <code>JsonProperty</code> with a default value:

<syntaxhighlight lang="C#">
[JsonProperty("FlagDamagePerSecond")] public float flagDPS = 5.0;
</syntaxhighlight>

=== In a rule / game mode ===

To add a script to all matches of a gamemode, edit <code>Rules/Custom/YourGameMode.json</code>.

Add a script by adding its class name as a key to the game mode definition (on the same level as <code>GameScript</code>). Inside that object, you can define parameters the script potentially exposes via <code>JSONProperty</code> tags:

<syntaxhighlight lang="JSON">
{
...
"GameScript": { ... },
"YourScriptName": {
"ExampleParameter": true,
}
...
}
</syntaxhighlight>

An alternative way, is to add the class name of your script to the <code>GameScript.Scripts</code> array:
<syntaxhighlight lang="JSON">
{
...
"GameScript": {
"Scripts": [
... potentially other scripts ...,
"YourScriptName"
]
}
...
}
</syntaxhighlight>

Custom Modifiers

2023-06-10T11:46:53Z

Nerf cardboard: add to Category:Modding

Modifiers are snippets of configuration that partially override the default game config, which makes for some nice match variation in servers.

Check the default configuration file <code>Modifiers/_default.json</code> (contains anything not related to game modes: eg weapons, player movement, ...) as a reference of available parameters.
Follow the '''exact''' same structure as in this file - ie. all parameters are within the "Objects" key.

To customize game mode configuration, there is the special namespace "Objects.Rules". This also allows to load custom scripts, by naming it.

Some more hints:
* You only need to specify the parameter you want to change. Due to some bugs, this does not work for some objects (eg MeleeWeapon).
* Its possible to add or remove elements from lists, instead of replacing the whole default list. To do this, prefix the parameter name with <code>+</code> or <code>-</code> (eg <code>"-PrimaryWeapons": ["Minigun"]</code>). This improves composability of multiple Modifiers. On non-lists, a <code>-</code>-prefix removes the whole element.
* Changes are applied whenever the file is saved. This works for most parameters, but not all.
* The JSON parser understands JSON2, so trailing commas and comments are allowed.

= Example =
Example:

<pre>
{
"Objects": {
"Rules": {
// customizing game rules parameters
"StandardGameplay": {
"DamageModifier": 2
},
"-RandomDrops": {}
// loading a custom script
"MyCustomScript": {
"SomeScriptParameter": 1.0
}
},
"Gostek": {
"PhysicsObject": {
"Mass": 0.65, // faster movement by making players lighter
}
}
},
"Meta": {
"Description": "this text shows up as a tooltip in the lobby",
"Author": "",
"Version": "1.0",
"Game": "Soldat2",
"GameVersion": "0.8.67"
}
}
</pre>

[[Category:Modding]]

Custom Modifiers

2023-06-10T11:43:46Z

Nerf cardboard:

Modifiers are snippets of configuration that partially override the default game config, which makes for some nice match variation in servers.

Check the default configuration file <code>Modifiers/_default.json</code> (contains anything not related to game modes: eg weapons, player movement, ...) as a reference of available parameters.
Follow the '''exact''' same structure as in this file - ie. all parameters are within the "Objects" key.

To customize game mode configuration, there is the special namespace "Objects.Rules". This also allows to load custom scripts, by naming it.

Some more hints:
* You only need to specify the parameter you want to change. Due to some bugs, this does not work for some objects (eg MeleeWeapon).
* Its possible to add or remove elements from lists, instead of replacing the whole default list. To do this, prefix the parameter name with <code>+</code> or <code>-</code> (eg <code>"-PrimaryWeapons": ["Minigun"]</code>). This improves composability of multiple Modifiers. On non-lists, a <code>-</code>-prefix removes the whole element.
* Changes are applied whenever the file is saved. This works for most parameters, but not all.
* The JSON parser understands JSON2, so trailing commas and comments are allowed.

= Example =
Example:

<pre>
{
"Objects": {
"Rules": {
// customizing game rules parameters
"StandardGameplay": {
"DamageModifier": 2
},
"-RandomDrops": {}
// loading a custom script
"MyCustomScript": {
"SomeScriptParameter": 1.0
}
},
"Gostek": {
"PhysicsObject": {
"Mass": 0.65, // faster movement by making players lighter
}
}
},
"Meta": {
"Description": "this text shows up as a tooltip in the lobby",
"Author": "",
"Version": "1.0",
"Game": "Soldat2",
"GameVersion": "0.8.67"
}
}
</pre>

Custom Modifiers

2023-06-10T11:43:05Z

Nerf cardboard: Created page with "Modifiers are snippets of configuration that partially override the default game config, which makes for some nice match variation in servers. Check the default configuration file <code>Modifiers/_default.json</code> (anything not related to game modes: weapons player movement) as a reference of available parameters. Follow the '''exact''' same structure as in this file - ie. all parameters are within the "Objects" key. To customize game mode configuration, there is th..."

Modifiers are snippets of configuration that partially override the default game config, which makes for some nice match variation in servers.

Check the default configuration file <code>Modifiers/_default.json</code> (anything not related to game modes: weapons player movement) as a reference of available parameters.
Follow the '''exact''' same structure as in this file - ie. all parameters are within the "Objects" key.

To customize game mode configuration, there is the special namespace "Objects.Rules". This also allows to load custom scripts, by naming it.

Some more hints:
* You only need to specify the parameter you want to change. Due to some bugs, this does not work for some objects (eg MeleeWeapon).
* Its possible to add or remove elements from lists, instead of replacing the whole default list. To do this, prefix the parameter name with <code>+</code> or <code>-</code> (eg <code>"-PrimaryWeapons": ["Minigun"]</code>). This improves composability of multiple Modifiers. On non-lists, a <code>-</code>-prefix removes the whole element.
* Changes are applied whenever the file is saved. This works for most parameters, but not all.
* The JSON parser understands JSON2, so trailing commas and comments are allowed.

= Example =
Example:

<pre>
{
"Objects": {
"Rules": {
// customizing game rules parameters
"StandardGameplay": {
"DamageModifier": 2
},
"-RandomDrops": {}
// loading a custom script
"MyCustomScript": {
"SomeScriptParameter": 1.0
}
},
"Gostek": {
"PhysicsObject": {
"Mass": 0.65, // faster movement by making players lighter
}
}
},
"Meta": {
"Description": "this text shows up as a tooltip in the lobby",
"Author": "",
"Version": "1.0",
"Game": "Soldat2",
"GameVersion": "0.8.67"
}
}
</pre>

Server Configuration

2023-06-10T11:14:26Z

Nerf cardboard:

= Config Files =

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

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

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

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.

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

== Cycles/*/*.json ==
Map rotations (for when lobby is disabled).

== greet.txt ==
Server info message showing in the popup before each match. Supports [TODO custom formatting]

= Examples =
You can use the following public 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)

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

In autoconfig.ini, set:

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

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>)
* RconPassword - if set, more than one player can send admin commands.

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

In autoconfig.ini, set:

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

[[Category:Dedicated Server]]

Server Configuration

2023-06-10T11:11:16Z

Nerf cardboard: restructure

= Config Files =

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

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

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

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.

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

== Cycles/*/*.json ==
Map rotations (for when lobby is disabled).

== greet.txt ==
Server info message showing in the popup before each match. Supports [TODO custom formatting]

= Examples =
You can use the following public 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)

= How to... =

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

[[Category:Dedicated Server]]

Server Configuration

2023-06-10T11:02:36Z

Nerf cardboard: layout

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]

= Example Configurations =

Use the following public 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

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

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

[[Category:Dedicated Server]]

Server Configuration

2023-06-10T11:02:01Z

Nerf cardboard:

[[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]

= Example Configurations =

Use the following public 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

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

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

Server Hosting

2023-06-10T10:57:25Z

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

[[Category:Dedicated Server]]

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.

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

=== 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
./soldat2
</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).

=== Init.d ===

TODO

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

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

=== 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
* VisibleInGamesList - set to false, if you host in LAN only, to not confuse external players with your server in the server listing

For more details regarding configuration see [[Server Configuration]].

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

Category:Dedicated Server

2023-06-10T10:52:28Z

Nerf cardboard: Created blank page

Server Configuration

2023-06-10T10:52:01Z

Nerf cardboard: extract content from Server Hosting 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>

Main Page

2023-06-10T10:38:16Z

Nerf cardboard:

Welcome to the Soldat 2 Wiki

== Contents ==

* [[Weapons]]
* [[Ranked]]
* [[Movement|Movement Guide]]
* [[Radio Commands]]
* [[:Category:Modding]]
** [[Mapping|Mapping Guide]]
** [[Custom Modifiers]]
** [[Scripting Introduction]]
** [[Scripting Events]]
** [[Scripting Examples]]
* [[:Category:Dedicated Server]]
** [[Server Hosting]]
** [[Server Configuration]]

== Important Links ==
* [https://store.steampowered.com/app/474220/Soldat_2/ Soldat 2 on STEAM]
* [https://oczki.pl/s2-players Active Player Dashboard]
* [https://stats.soldat2.com/ Ranked Ladder Statistics & Leaderboards]
* [https://tms2.jrgp.org/ The Soldat 2 Mapping Showcase]
* [https://kreis.uber.space/soldat2/mapview/ Map Search & Overview]

Server Hosting

2023-06-10T10:35:10Z

Nerf cardboard: document locations of all configuration files

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.

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

=== 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
./soldat2
</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).

=== Init.d ===

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

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

=== Common issues ===

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

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

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>

Scripting Introduction

2023-03-07T15:24:09Z

Nerf cardboard: document how to parametrize scripts in game modes

Scripting in Soldat 2 is done in a Unity/C# environment. For a script to be usable in-game, the script file must be placed under <code>Soldat2/Scripts/</code> and there needs to be a ruleset that specifies that script in the GameScript object in its json - for example, see <code>Soldat2/Rules/Standard/Climb.json</code>. The script can be tested by starting a game that uses that ruleset.

[[Category:Scripting]]

== Scripting Resources ==
The Soldat 2 engine uses Unity, so it may be useful to familiarise yourself with the [https://docs.unity3d.com/2020.1/Documentation/Manual/index.html Unity Manual].

There is some [https://soldat2.com/docs/ preliminary documentation] for the Soldat 2 engine, however it is currently rather limited.

Some examples of scripts can be found in your Soldat 2 game directory under the path <code>Soldat2/Scripts/Standard/</code>. Some unofficial examples are available at [[Scripting Examples]].

See [[:Category:Scripting]] for a list of all pages on this wiki related to scripting.

== Using Scripts ==

A script can be applied to a match via [[Modifiers]] or via a [[Game Mode]] ("Rules").

=== In a modifier ===
Example of a modifier <code>Modifiers/Custom/FlagIsPoison.json</code> applying the <code>Scripts/Custom/FlagIsPoison.cs</code> script:

<syntaxhighlight lang="JSON">
{
"Objects": {
"Rules": {
"FlagIsPoison": {
"FlagDamagePerSecond": 3.0
}
}
},
"Meta": {
"Description": "(applies the FlagIsPoison script)",
"Author": "noerw",
"Version": 1.0
}
}
</syntaxhighlight>

A script can be parametrized, where the parameters are defined in the modifier or rule definition. In the above example the <code>FlagDamagePerSecond</code> parameter is applied when the script class contains a <code>JsonProperty</code> with a default value:

<syntaxhighlight lang="C#">
[JsonProperty("FlagDamagePerSecond")] public float flagDPS = 5.0;
</syntaxhighlight>

=== In a rule / game mode ===

To add a script to all matches of a gamemode, edit <code>Rules/Custom/YourGameMode.json</code>.

Add a script by adding its class name as a key to the game mode definition (on the same level as <code>GameScript</code>). Inside that object, you can define parameters the script potentially exposes via <code>JSONProperty</code> tags:

<syntaxhighlight lang="JSON">
{
...
"GameScript": { ... },
"YourScriptName": {
"ExampleParameter": true,
}
...
}
</syntaxhighlight>

An alternative way, is to add the class name of your script to the <code>GameScript.Scripts</code> array:
<syntaxhighlight lang="JSON">
{
...
"GameScript": {
"Scripts": [
... potentially other scripts ...,
"YourScriptName"
]
}
...
}
</syntaxhighlight>

Scripting Events

2023-02-21T15:57:11Z

Nerf cardboard: add some event types

The main method for reacting to gameplay events in Soldat 2 scripting is by registering ''listeners''. This is done by calling the <code>AddListener()</code> function, usually on the <code>Eventor</code> object.

[[Category:Scripting]]

== Eventor Events ==
In the case of Eventor listeners, you will need to specify both the event type to listen for, as well as a function to be called when the event occurs. Callback functions should have the signature <code>void cb_func(IGameEvent)</code>.

The event types that are used with Eventor are defined by the <code>Events</code> enum, which currently contains:
* None
* New_Connection (GlobalPlayerConnectionEvent)
* Created
* Destroyed
* Died
* Add_Player
* Remove_Player
* Player_Joined (GlobalPlayerEvent has .Player)
* Player_Assigned
* Player_Left
* Player_Changed_Team
* Player_Unassigned
* Level_Loaded
* Rules_Loaded
* Impacted
* Weapon_Selected
* Trigger (GlobalTriggerEvent)
* Match_Waiting
* Match_Warmup
* Match_Started
* Match_Ended
* Hit (GlobalHitEvent)
* Camera_Target_Changed
* Camera_Created
* Powerup_Started
* Powerup_Ended
* Bullet_Created
* Bot_Assigned
* Flag_Captured
* Flag_Returned
* Flag_Grabbed
* Use_Weapon
* Construct_AddBody
* Construct_RemoveBody
* Properties_Changed
* Item_Dropped (GlobalItemEvent has .Item and .Holder)
* Item_Picked (GlobalItemEvent has .Item and .Holder)
* AssignedNetworkId
* Changed_Team
* Request_Spawn
* End_Condition
* Reserved

A full example of an AddListener call is <code>Eventor.AddListener(Events.Died, OnPlayerDied)</code>. These calls are usually placed within the <code>Awake()</code> function of the script, which is executed when the script is loaded. Note that each AddListener call should be paired with a RemoveListener call (usually in the <code>OnDestroy()</code> function) to ensure that the script does not continue to respond to events after it has been disabled. See the Unity manual entry for the [https://docs.unity3d.com/2020.1/Documentation/ScriptReference/MonoBehaviour.html MonoBehaviour] class for other special functions.

== Other Events ==
Not all necessary game events are currently accessible with just the Eventor object, methods for adding listeners to other useful events are listed below:
* Player chat events: <code>GameChat.instance.OnChat.AddListener()</code>, only takes a callback function as an argument, required signature for callback is <code>void cb_func(Player, string)</code>

If an event is not available for a specific gameplay element you are interested in responding to, it is also possible to use a polling approach to detect that event by using either the <code>Update()</code> or <code>FixedUpdate()</code> functions which are called periodically by the engine. For example, something equivalent to this is used in the official <code>Climb.cs</code> script to detect when any player gets within 1.5 range of a checkpoint:
<syntaxhighlight lang="C#">
void FixedUpdate() // runs 10 times per second
{
for (int i = checkpoints.Count - 1; i >= 0; i--)
{
foreach (Player player in Players.Get.GetAlive())
{
// for each (player,checkpoint) pair, check if the distance between them is less than 1.5
if ((player.controlled.transform.position - checkpoints[i].transform.position).magnitude < 1.5f)
{
checkpoints.RemoveAt(i);
lastCheckpointPlayer = player;
break;
}
}
}
}
</syntaxhighlight>

Server Hosting

2023-02-14T15:20:12Z

Nerf cardboard: link to ansible deployment

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.

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

=== 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
./soldat2
</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).

=== Init.d ===

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

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

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

Server Hosting

2023-01-19T14:04:57Z

Nerf cardboard:

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
./soldat2
</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).

=== Init.d ===

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

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

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

Server Hosting

2023-01-19T13:55:46Z

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

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>

Main Page

2023-01-19T11:57:23Z

Nerf cardboard:

Welcome to the Soldat 2 Wiki

== Contents ==

* [[Weapons]]
* [[Ranked]]
* [[Movement|Movement Guide]]
* [[:Category:Modding]]
** [[Mapping|Mapping Guide]]
** [[Scripting Introduction]]
** [[Scripting Events]]
* [[Server Hosting]]

== Important Links ==
* [https://store.steampowered.com/app/474220/Soldat_2/ Soldat 2 on STEAM]
* [https://oczki.pl/s2-players Active Player Dashboard]
* [https://stats.soldat2.com/ Ranked Ladder Statistics & Leaderboards]
* [https://tms2.jrgp.org/ The Soldat 2 Mapping Showcase]
* [https://kreis.uber.space/soldat2/mapview/ Map Search & Overview]

Mapping

2023-01-19T11:56:04Z

Nerf cardboard:

Creating custom maps & mods is explicitly welcomed - Soldat 2 ships with a built in map editor.

[[Category:Modding]]

== General Tips for Mapping ==

* Make your map ''readable''; follow functional conventions of map design. Steel beams and big bridges are almost always ''collisionmodel: players collide'', while small stairs and platforms are - guess what - ''collisionmodel: platform''. Sandbags and barrels are always ''collisionmodel: bullets collide''.

* Especially on CTF maps, make sure to place grenade kits, health packs, and sandbags / barrels, and choose their locations wisely.

* Check your map for bad spawn locations in DM - even if it's not a DM map. See section [[#Unwanted Spawn Locations]] for details.

* Put work in selecting good colors from the start (see below for a guide to what each color does). This will help a lot getting a good feel for the map.

* Always test your maps with the graphics setting ''detailed backgrounds'' set to off. Many people play with this setting (for various reasons), so the map must look okay with this. With this configuration...
** the <code>SkyColor1</code> and <code>SkyColor2</code> colors are not used for the map background. Instead <code>BackDimColor</code> is applied to the background. Make sure it looks OK.
** anything in the ''background'' layer is not drawn. Look for map-props that appear floating because they are placed on a ''background'' shape. To fix this, put these objects also in the ''background'' layer, or move them to a better position.

* Add depth to the map by placing objects deep into the foreground and background. ''dm_db_cuba'' is a good example of this.

* Most props are 3D - rotating them often gives them quite different appearance and use on the map. Make use of this property to reduce repetition, or to reinterpret what those props represent.

* Don't overdo decoration, it will distract too much during game play and in some cases eat FPS of your players. When in doubt, place decorative props on the background layer, so players can hide them via the ''disable detailed backgrounds'' setting.

* There are already a shitload of maps (check out [https://tms2.jrgp.org/ TMS]). If you want to create a map that gets played, make sure you do at least one thing differently. Or fill a niche that isn't populated yet. If you just want to create a piece of art that's great too of course

== Built-in Map Editor ==

The built-in editor is as of v0.8.46a still very much beta - its UI is quite rough around the edges.
Here are some tips for working with it.

=== General Concepts ===

Maps primarily consist of polygons (''protoshapes''), 3D-props, and spawn locations for various items, and a color scheme.
Props and protoshapes have attributes that affect their rendering.
Protoshapes also have a collision model (props don't - to make something collide with a prop, draw a protoshape with disabled rendering on top of it).
Maps are persisted to a JSON structure.

=== MapProp & Protoshape Properties ===

==== Rendering Layer ====

Each object on the map is placed a rendering layer, which affects (a) how it is colored, and (b) sets a default value for the depth / z parameter. Available values are:

* foreground: slightly desaturated, applies ''SunColor'' taint. default for solid protoshapes.
* none: don't draw this object.
* background: desaturates and darkens the object, and applies ''Fog*'' and ''BackDimColor'' taints to it. default for non-colliding protoshapes, which get a different texture applied.
* color: directly applies the color defined on the object 1:1. protoshapes with this also get a different texture.
* original: similar to ''color'', but not the same?
** TODO: whats the difference?

==== Collision Model ====

Applies to Protoshapes only, it's pretty self-explanatory.
Note that platform shapes will always draw a dashed outline, which is good, as it helps with map readability.

==== Material ====

Defines the sound effect when bullets hit this shape. Also applies different bullet ricochet visuals (but those are not actual bullet ricochets able to hit players).

=== Map Settings ===

There are plenty of settings. I highly recommend exploring the entire settings panel, but you can use this section as a guide.

<q>Note that this section does not primarily consist of authoritative information, but is to a large degree reverse 'engineered'.</q>

==== Dimensions & Scaling ====

* ''Width'', ''Height'': Defines the map size

* ''Scale'': This vector does '''not''' scale the whole map (see '''GlobalScale''' for that) - it's a multiplier on the ''Width'' and ''Height'' attributes.

* ''Mirror'': Enable this if you want a symmetrical map. You only draw the left half of the map, and the game generates the other half on the fly. To get a preview, use the ''mirror'' button at the bottom of the settings UI. Individual map objects can be excluded from mirroring via the ''Mirror'' flag.

* ''GlobalScale, GlobalPosition'': These values transform all objects on the map. Do '''not''' set these numbers in the settings panel, but use the ''transform'' button in the map settings panel (the transformation handle UI can appear outside of the map bounds)

==== Lighting ====
* '''SunLightColor''': Sunlight color taints all objects in the ''foreground'' rendering layer.
* '''SunIntensityShift''': The amount of sunlight
* '''SunHorizontalAngle''', '''SunVerticalAngle''': the angle from which light is applied, useful for shadows on protoshape normals.

* '''Fog''', '''FogColor''', '''FogDistance''': fog applies a taint to ''background'' objects, which is applied with increasing opacity with increasing depth (z axis coordinate).

* '''HueShift''' '''SaturationShift''' '''BrightnessShift''': These transform all colors specified in the settings panel, but does not apply to colors specified on individual map objects.

==== Sky / Background Colors ====

* '''SkyColor''', '''SkyColor2''': two colors with a gradient in between can be defined.
* '''SkyGradientScale''', '''SkyGradientOffset''', '''SkyGradientRotation''': Parameters for the gradient between ''SkyColor'' and ''SkyColor2''.
* '''BackDimColor''': fallback color for the sky, when the setting ''detailed backgrounds'' is disabled. Note that this also applies a taint on ''background'' objects (why tho?).

==== Other Colors ====

* '''FadeColor''': Color applied to the area outside of the map boundary.
* '''EffectsColor''': Color used to taint stuff like explosions. White == untainted.

==== Protoshapes ====

* '''PlatformsColor''': default color for all ''foreground'' platforms, unless they have an individual color specified.

* '''BackColor''': default color for all ''background'' platforms, unless they have an individual color specified.

* '''PlatformsTexture''', '''NormalTexture''': defines the texture of the protoshapes and their normals (i.e the depth information that makes them have shadows.
** '''TODO''': is it possible to provide custom textures by placing them next to a map in the <code>Levels/Custom/</code> dir?

* '''DetaulTexture''', '''DetailNormalTexture''', '''DetailTextureScale''', '''DetailNormalTextureScale''', '''DetailImpact''', '''DetailGradientTexture''', '''DetailColor''': Additionally to their primary texture, protoshapes have a detail overlay with a separate set of textures. ''DetailImpact'' scales the visibility of this overlay.
** Note: iiuc, this is mostly a relic from the pre-0.8 versions with a different renderer. To me, these settings are of little use for design.

==== Miscellaneous ====

* '''Author''': self-explanatory. Make sure to fill this in, people want to be able to find the creator of a map.
* '''AmbientSound''': selects one of a couple soundscapes. there is nothing worse than a sunny map with rumble ambience, be sure to choose a proper ambience.
* '''Generate''': ??? iirc when enabled enabled, some sandbags etc are placed around each basecamp / flag placement.
* '''Seed''': RNG initialization value for the ''generate'' feature.
* '''TopBarrierheight''': ???

=== Workarounds ===

While the editor is in beta, there are plenty of bugs. For many, a workaround is available:

==== Unwanted Spawn Locations ====

In DM, players spawn at random locations on top of any colliding protoshape within map bounds, and not at the spawn locations you can place with the Gostek symbol.
If your map is enclosed by a protoshape that does not extend well outside of the map bounds, players ''will'' spawn there.

This can be avoided, by placing another protoshape along the outer edge of your enclosing shape, extending it well outside of the map bounds.
To not affect your map design you can set apply <code>collision-model: players collide</code> and <code>rendering mode: none</code>.

==== Selecting / moving all map objects ====

It can quickly happen that you run out of space in the left or bottom area.
Instead of moving each object, use the ''transform'' button in the map settings panel to select all objects and move, rotate or scale them all.

==== Protoshape with ''render mode: color'' does not apply color ====

Restart the editor. ¯\_ (ツ)_/¯.

==== Protoshape is invisible ====

This can happen when a shape is very thin or has a very pointy corner.
Moving some vertices around can often fix the issue. If not, creating an extension of the shape

==== Protoshape is always drawn in front of Gosteks ====

The exact root cause is still unclear, some protoshapes just always appear in front of the player, independent of their rendering layer setting and depth value. It could have to do with the vertex order being wrong (clockwise instead of anticlockwise or vice versa). To fix this move some vertexes around, or just replace the shape another with another protoshape that does not have this problem.

== Third Party Tools ==

The community also has written tools for creating maps that integrate with the map game / map editor:

* [https://kreis.uber.space/soldat2/svg2map/ svg2map] by @noerw converts between map JSON files and SVG and can be used to create or edit protoshapes in programs like [https://inkscape.org/ Inkscape].

Scripting Events

2023-01-19T11:55:40Z

Nerf cardboard:

The main method for reacting to gameplay events in Soldat 2 scripting is by registering ''listeners''. This is done by calling the <code>AddListener()</code> function, usually on the <code>Eventor</code> object.

[[Category:Scripting]]

== Eventor Events ==
In the case of Eventor listeners, you will need to specify both the event type to listen for, as well as a function to be called when the event occurs. Callback functions should have the signature <code>void cb_func(IGameEvent)</code>.

The event types that are used with Eventor are defined by the <code>Events</code> enum, which currently contains:
* None
* New_Connection
* Created
* Destroyed
* Died
* Add_Player
* Remove_Player
* Player_Joined
* Player_Assigned
* Player_Left
* Player_Changed_Team
* Player_Unassigned
* Level_Loaded
* Rules_Loaded
* Impacted
* Weapon_Selected
* Trigger
* Match_Waiting
* Match_Warmup
* Match_Started
* Match_Ended
* Hit
* Camera_Target_Changed
* Camera_Created
* Powerup_Started
* Powerup_Ended
* Bullet_Created
* Bot_Assigned
* Flag_Captured
* Flag_Returned
* Flag_Grabbed
* Use_Weapon
* Construct_AddBody
* Construct_RemoveBody
* Properties_Changed
* Item_Dropped
* Item_Picked
* AssignedNetworkId
* Changed_Team
* Request_Spawn
* End_Condition
* Reserved

A full example of an AddListener call is <code>Eventor.AddListener(Events.Died, OnPlayerDied)</code>. These calls are usually placed within the <code>Awake()</code> function of the script, which is executed when the script is loaded. Note that each AddListener call should be paired with a RemoveListener call (usually in the <code>OnDestroy()</code> function) to ensure that the script does not continue to respond to events after it has been disabled. See the Unity manual entry for the [https://docs.unity3d.com/2020.1/Documentation/ScriptReference/MonoBehaviour.html MonoBehaviour] class for other special functions.

== Other Events ==
Not all necessary game events are currently accessible with just the Eventor object, methods for adding listeners to other useful events are listed below:
* Player chat events: <code>GameChat.instance.OnChat.AddListener()</code>, only takes a callback function as an argument, required signature for callback is <code>void cb_func(Player, string)</code>

If an event is not available for a specific gameplay element you are interested in responding to, it is also possible to use a polling approach to detect that event by using either the <code>Update()</code> or <code>FixedUpdate()</code> functions which are called periodically by the engine.

Category:Modding

2023-01-19T11:55:29Z

Nerf cardboard: Created blank page

Category:Scripting

2023-01-19T11:55:22Z

Nerf cardboard:

Pages related to scripting in Soldat 2

[[Category:Modding]]

Scripting Introduction

2023-01-19T11:48:11Z

Nerf cardboard:

Scripting in Soldat 2 is done in a Unity/C# environment. For a script to be usable in-game, the script file must be placed under <code>Soldat2/Scripts/</code> and there needs to be a ruleset that specifies that script in the GameScript object in its json - for example, see <code>Soldat2/Rules/Standard/Climb.json</code>. The script can be tested by starting a game that uses that ruleset.

[[Category:Scripting]]

== Scripting Resources ==
The Soldat 2 engine uses Unity, so it may be useful to familiarise yourself with the [https://docs.unity3d.com/2020.1/Documentation/Manual/index.html Unity Manual].

There is some [https://soldat2.com/docs/ preliminary documentation] for the Soldat 2 engine, however it is currently rather limited.

Some examples of scripts can be found in your Soldat 2 game directory under the path <code>Soldat2/Scripts/Standard/</code>.

More documentation is added to this wiki under [[:Category:Scripting]].

== Using Scripts ==

A script can be applied to a match via [[Modifiers]] or via a [[Game Mode]] ("Rules").

=== In a modifier ===
Example of a modifier <code>Modifiers/Custom/FlagIsPoison.json</code> applying the <code>Scripts/Custom/FlagIsPoison.cs</code> script:

<pre>
{
"Objects": {
"Rules": {
"FlagIsPoison": {
"FlagDamagePerSecond": 3.0
}
}
},
"Meta": {
"Description": "(applies the FlagIsPoison script)",
"Author": "noerw",
"Version": 1.0
}
}
</pre>

A script can be parametrized, where the parameters are defined in the modifier or rule definition. In the above example the <code>FlagDamagePerSecond</code> parameter is applied when the script class contains a <code>JsonProperty</code> with a default value:

<pre>
[JsonProperty("FlagDamagePerSecond")] public float flagDPS = 5.0;
</pre>

=== In a rule / game mode ===

Add the script name to the <code>GameRules</code> section of the rule definition in <code>Rules/Custom/YourGameMode.json</code>:

<pre>
{
"Objects": {
"YourGameMode": {

"GameScript": {
"Scripts": [
... potentially other scripts ...,
"YourScriptName"
]
}

}
}
}
</pre>

* TODO: check if parameters can be passed in this syntax too (eg <code>"Scripts": [{ "YourScriptName": { MyParam: false } }]</code>

Scripting Events

2023-01-19T11:43:12Z

Nerf cardboard: add Modding & Scripting categories

The main method for reacting to gameplay events in Soldat 2 scripting is by registering ''listeners''. This is done by calling the <code>AddListener()</code> function, usually on the <code>Eventor</code> object.

[[Category:Modding]]
[[Category:Scripting]]

== Eventor Events ==
In the case of Eventor listeners, you will need to specify both the event type to listen for, as well as a function to be called when the event occurs. Callback functions should have the signature <code>void cb_func(IGameEvent)</code>.

The event types that are used with Eventor are defined by the <code>Events</code> enum, which currently contains:
* None
* New_Connection
* Created
* Destroyed
* Died
* Add_Player
* Remove_Player
* Player_Joined
* Player_Assigned
* Player_Left
* Player_Changed_Team
* Player_Unassigned
* Level_Loaded
* Rules_Loaded
* Impacted
* Weapon_Selected
* Trigger
* Match_Waiting
* Match_Warmup
* Match_Started
* Match_Ended
* Hit
* Camera_Target_Changed
* Camera_Created
* Powerup_Started
* Powerup_Ended
* Bullet_Created
* Bot_Assigned
* Flag_Captured
* Flag_Returned
* Flag_Grabbed
* Use_Weapon
* Construct_AddBody
* Construct_RemoveBody
* Properties_Changed
* Item_Dropped
* Item_Picked
* AssignedNetworkId
* Changed_Team
* Request_Spawn
* End_Condition
* Reserved

A full example of an AddListener call is <code>Eventor.AddListener(Events.Died, OnPlayerDied)</code>. These calls are usually placed within the <code>Awake()</code> function of the script, which is executed when the script is loaded. Note that each AddListener call should be paired with a RemoveListener call (usually in the <code>OnDestroy()</code> function) to ensure that the script does not continue to respond to events after it has been disabled. See the Unity manual entry for the [https://docs.unity3d.com/2020.1/Documentation/ScriptReference/MonoBehaviour.html MonoBehaviour] class for other special functions.

== Other Events ==
Not all necessary game events are currently accessible with just the Eventor object, methods for adding listeners to other useful events are listed below:
* Player chat events: <code>GameChat.instance.OnChat.AddListener()</code>, only takes a callback function as an argument, required signature for callback is <code>void cb_func(Player, string)</code>

If an event is not available for a specific gameplay element you are interested in responding to, it is also possible to use a polling approach to detect that event by using either the <code>Update()</code> or <code>FixedUpdate()</code> functions which are called periodically by the engine.

Scripting Introduction

2023-01-19T11:39:43Z

Nerf cardboard:

Scripting in Soldat 2 is done in a Unity/C# environment. For a script to be usable in-game, the script file must be placed under <code>Soldat2/Scripts/</code> and there needs to be a ruleset that specifies that script in the GameScript object in its json - for example, see <code>Soldat2/Rules/Standard/Climb.json</code>. The script can be tested by starting a game that uses that ruleset.

== Scripting Resources ==
The Soldat 2 engine uses Unity, so it may be useful to familiarise yourself with the [https://docs.unity3d.com/2020.1/Documentation/Manual/index.html Unity Manual].

There is some [https://soldat2.com/docs/ preliminary documentation] for the Soldat 2 engine, however it is currently rather limited.

Some examples of scripts can be found in your Soldat 2 game directory under the path <code>Soldat2/Scripts/Standard/</code>.

[[Category:Scripting]]

== Using Scripts ==

A script can be applied to a match via [[Modifiers]] or via a [[Game Mode]] ("Rules").

=== In a modifier ===
Example of a modifier <code>Modifiers/Custom/FlagIsPoison.json</code> applying the <code>Scripts/Custom/FlagIsPoison.cs</code> script:

<pre>
{
"Objects": {
"Rules": {
"FlagIsPoison": {
"FlagDamagePerSecond": 3.0
}
}
},
"Meta": {
"Description": "(applies the FlagIsPoison script)",
"Author": "noerw",
"Version": 1.0
}
}
</pre>

A script can be parametrized, where the parameters are defined in the modifier or rule definition. In the above example the <code>FlagDamagePerSecond</code> parameter is applied when the script class contains a <code>JsonProperty</code> with a default value:

<pre>
[JsonProperty("FlagDamagePerSecond")] public float flagDPS = 5.0;
</pre>

=== In a rule / game mode ===

Add the script name to the <code>GameRules</code> section of the rule definition in <code>Rules/Custom/YourGameMode.json</code>:

<pre>
{
"Objects": {
"YourGameMode": {

"GameScript": {
"Scripts": [
... potentially other scripts ...,
"YourScriptName"
]
}

}
}
}
</pre>

* TODO: check if parameters can be passed in this syntax too (eg <code>"Scripts": [{ "YourScriptName": { MyParam: false } }]</code>

Scripting Introduction

2023-01-19T11:37:50Z

Nerf cardboard: document how to apply a script to a match

Scripting in Soldat 2 is done in a Unity/C# environment. For a script to be usable in-game, the script file must be placed under <code>Soldat2/Scripts/</code> and there needs to be a ruleset that specifies that script in the GameScript object in its json - for example, see <code>Soldat2/Rules/Standard/Climb.json</code>. The script can be tested by starting a game that uses that ruleset.

== Scripting Resources ==
The Soldat 2 engine uses Unity, so it may be useful to familiarise yourself with the [https://docs.unity3d.com/2020.1/Documentation/Manual/index.html Unity Manual].

There is some [https://soldat2.com/docs/ preliminary documentation] for the Soldat 2 engine, however it is currently rather limited.

Some examples of scripts can be found in your Soldat 2 game directory under the path <code>Soldat2/Scripts/Standard/</code>.

[[Category:Scripting]]

== Using Scripts ==

A script can be applied to a match via [[Modifiers]] or via a [[Game Mode]] ("Rules").

=== In a modifier ===
Example of a modifier <code>Modifiers/Custom/FlagIsPoison.json</code> applying the <code>Scripts/Custom/FlagIsPoison.cs</code> script:

<pre>
{
"Objects": {
"Rules": {
"FlagIsPoison": {
"FlagDamagePerSecond": 3.0
}
}
},
"Meta": {
"Description": "(applies the FlagIsPoison script)",
"Author": "noerw",
"Version": 1.0
}
}
</pre>

A script can be parametrized, where the parameters are defined in the modifier or rule definition. In the above example the <code>FlagDamagePerSecond</code> parameter is applied when the script class contains a <code>JsonProperty</code> with a default value:

<pre>
[JsonProperty("FlagDamagePerSecond")] public int flagDPSParameter = 5.0;
</pre>

=== In a rule / game mode ===

Add the script name to the <code>GameRules</code> section of the rule definition in <code>Rules/Custom/YourGameMode.json</code>:

<pre>
{
"Objects": {
"YourGameMode": {

"GameScript": {
"Scripts": [
... potentially other scripts ...,
"YourScriptName"
]
}

}
}
}
</pre>

* TODO: check if parameters can be passed in this syntax too (eg <code>"Scripts": [{ "YourScriptName": { MyParam: false } }]</code>

Movement

2022-12-10T09:55:22Z

Nerf cardboard:

Quick and controlled movement is - next to aiming well - a player's primary skill in Soldat 2.

== Move Set ==

The available mechanics are quite similar to the classic Soldat game, but the move set is a bit different.
What follows is an incomplete description of essential moves, in the spirit of [https://wiki.soldat.pl/index.php/Soldat%27s_Comprehensive_Movement_Tutorial guides for classic Soldat] (which still partially apply).

=== Jumps ===
The duration {{key press|Up}} or {{key press|W}} is held down determines the jump height.
Generally, jumps provide more momentum than simply walking, both vertically (duh) and horizontally:

A long jump is often used to kickstart vertical momentum, usually followed by using jets.
Kick jumps - many consecutive short jumps while moving left/right - are the fastest way to move up a slope - the optimal timing depends on the slope angle.

=== Jets ===
<code>RMB</code> enables jets. They have slow acceleration, so it's best to already have some momentum when using them, eg by doing a long jump before starting to jet boost.

=== Rolls ===
Pressing <code>↓</code> in combination with holding <code>←</code>/<code>→</code> causes you to roll.
Immediately rolling when touching ground allows to maintain horizontal momentum [citation needed].

=== Hard Stop ===
When on the ground, letting go of movement keys causes abrupt deceleration.

=== Soft Stop ===
When changing direction on the ground by pressing left before letting go of right (or vice versa), you slowly decelerate before changing directions.
Avoid doing that unless you explicitly need to decelerate, eg. in combination with a long jump.

=== Moving backwards ===
Going backwards (as determined by the cursor position relative to your [[Gostek]]) - provides higher acceleration than going forwards [citation needed].

=== Front Flip ===

After losing contact with the ground, you can make one front and one back flip.

=== Back Flip ===
Facing away from the cursor, and doing the same actions as for the front flip, your Gostek performs a backflip.

=== Cannonball ===
Combining a flip with a short use of jets causes a roll with strong horizontal acceleration.
This move strongly depends on micro timing, and thus requires practice, but is one of the best ways to gain acceleration. The required key sequence is: left/right down, up down, jet down, move up, jet up [citation needed].
The amount of upwards momentum primarily depends on the time window between letting go of up and letting of jets.

=== Superman / Prone ===
- Using jets while in superman provides ability to change directions mid air.
- Going into superman while close to a wall provides you extra momentum away from the wall.
- When on the ground, the direction of going prone / into superman depends on the direction slope you're standing on.
- When already moving quickly, being in superman allows to slide over solid surfaces without losing much momentum.

=== Explosion Boosts ===
Using explosives while standing next to obstacles, provides strong acceleration at the cost of a couple HP.
Technically no obstacle is needed: When in motion, holding a grenade until detonation also provides you a boost.

Different explosives provide a different amount of acceleration - in ascending order:
- (???)
- ...
- ...

== How To Be Hasty™ ==

This guide aims to help with movement on a higher level. Using the above elements from the move set, good ways to solve high level tasks are described.

=== Accelerating ===

==== ...from standstill ====

==== ...horizontally ====

==== ...vertically ====

==== ...going up slope ====

==== ...going down slope ====

==== ...while mid air ====

=== Changing directions ===

=== Using the map & your equipment ===

Movement

2022-12-10T09:54:10Z

Nerf cardboard:

Quick and controlled movement is - next to aiming well - a player's primary skill in Soldat 2.

== Move Set ==

The available mechanics are quite similar to the classic Soldat game, but the move set is a bit different.
What follows is an incomplete description of essential moves, in the spirit of [https://wiki.soldat.pl/index.php/Soldat%27s_Comprehensive_Movement_Tutorial guides for classic Soldat]

=== Jumps ===
The duration {{key press|Up}} or {{key press|W}} is held down determines the jump height.
Generally, jumps provide more momentum than simply walking, both vertically (duh) and horizontally:

A long jump is often used to kickstart vertical momentum, usually followed by using jets.
Kick jumps - many consecutive short jumps while moving left/right - are the fastest way to move up a slope - the optimal timing depends on the slope angle.

=== Jets ===
<code>RMB</code> enables jets. They have slow acceleration, so it's best to already have some momentum when using them, eg by doing a long jump before starting to jet boost.

=== Rolls ===
Pressing <code>↓</code> in combination with holding <code>←</code>/<code>→</code> causes you to roll.
Immediately rolling when touching ground allows to maintain horizontal momentum [citation needed].

=== Hard Stop ===
When on the ground, letting go of movement keys causes abrupt deceleration.

=== Soft Stop ===
When changing direction on the ground by pressing left before letting go of right (or vice versa), you slowly decelerate before changing directions.
Avoid doing that unless you explicitly need to decelerate, eg. in combination with a long jump.

=== Moving backwards ===
Going backwards (as determined by the cursor position relative to your [[Gostek]]) - provides higher acceleration than going forwards [citation needed].

=== Front Flip ===

After losing contact with the ground, you can make one front and one back flip.

=== Back Flip ===
Facing away from the cursor, and doing the same actions as for the front flip, your Gostek performs a backflip.

=== Cannonball ===
Combining a flip with a short use of jets causes a roll with strong horizontal acceleration.
This move strongly depends on micro timing, and thus requires practice, but is one of the best ways to gain acceleration. The required key sequence is: left/right down, up down, jet down, move up, jet up [citation needed].
The amount of upwards momentum primarily depends on the time window between letting go of up and letting of jets.

=== Superman / Prone ===
- Using jets while in superman provides ability to change directions mid air.
- Going into superman while close to a wall provides you extra momentum away from the wall.
- When on the ground, the direction of going prone / into superman depends on the direction slope you're standing on.
- When already moving quickly, being in superman allows to slide over solid surfaces without losing much momentum.

=== Explosion Boosts ===
Using explosives while standing next to obstacles, provides strong acceleration at the cost of a couple HP.
Technically no obstacle is needed: When in motion, holding a grenade until detonation also provides you a boost.

Different explosives provide a different amount of acceleration - in ascending order:
- (???)
- ...
- ...

== How To Be Hasty™ ==

This guide aims to help with movement on a higher level. Using the above elements from the move set, good ways to solve high level tasks are described.

=== Accelerating ===

==== ...from standstill ====

==== ...horizontally ====

==== ...vertically ====

==== ...going up slope ====

==== ...going down slope ====

==== ...while mid air ====

=== Changing directions ===

=== Using the map & your equipment ===

Mapping

2022-12-10T01:09:21Z

Nerf cardboard:

Creating custom maps & mods is explicitly welcomed - Soldat 2 ships with a built in map editor.

== General Tips for Mapping ==

* Make your map ''readable''; follow functional conventions of map design. Steel beams and big bridges are almost always ''collisionmodel: players collide'', while small stairs and platforms are - guess what - ''collisionmodel: platform''. Sandbags and barrels are always ''collisionmodel: bullets collide''.

* Especially on CTF maps, make sure to place grenade kits, health packs, and sandbags / barrels, and choose their locations wisely.

* Check your map for bad spawn locations in DM - even if it's not a DM map. See section [[#Unwanted Spawn Locations]] for details.

* Put work in selecting good colors from the start (see below for a guide to what each color does). This will help a lot getting a good feel for the map.

* Always test your maps with the graphics setting ''detailed backgrounds'' set to off. Many people play with this setting (for various reasons), so the map must look okay with this. With this configuration...
** the <code>SkyColor1</code> and <code>SkyColor2</code> colors are not used for the map background. Instead <code>BackDimColor</code> is applied to the background. Make sure it looks OK.
** anything in the ''background'' layer is not drawn. Look for map-props that appear floating because they are placed on a ''background'' shape. To fix this, put these objects also in the ''background'' layer, or move them to a better position.

* Add depth to the map by placing objects deep into the foreground and background. ''dm_db_cuba'' is a good example of this.

* Most props are 3D - rotating them often gives them quite different appearance and use on the map. Make use of this property to reduce repetition, or to reinterpret what those props represent.

* Don't overdo decoration, it will distract too much during game play and in some cases eat FPS of your players. When in doubt, place decorative props on the background layer, so players can hide them via the ''disable detailed backgrounds'' setting.

* There are already a shitload of maps (check out [https://tms2.jrgp.org/ TMS]). If you want to create a map that gets played, make sure you do at least one thing differently. Or fill a niche that isn't populated yet. If you just want to create a piece of art that's great too of course

== Built-in Map Editor ==

The built-in editor is as of v0.8.46a still very much beta - its UI is quite rough around the edges.
Here are some tips for working with it.

=== General Concepts ===

Maps primarily consist of polygons (''protoshapes''), 3D-props, and spawn locations for various items, and a color scheme.
Props and protoshapes have attributes that affect their rendering.
Protoshapes also have a collision model (props don't - to make something collide with a prop, draw a protoshape with disabled rendering on top of it).
Maps are persisted to a JSON structure.

=== MapProp & Protoshape Properties ===

==== Rendering Layer ====

Each object on the map is placed a rendering layer, which affects (a) how it is colored, and (b) sets a default value for the depth / z parameter. Available values are:

* foreground: slightly desaturated, applies ''SunColor'' taint. default for solid protoshapes.
* none: don't draw this object.
* background: desaturates and darkens the object, and applies ''Fog*'' and ''BackDimColor'' taints to it. default for non-colliding protoshapes, which get a different texture applied.
* color: directly applies the color defined on the object 1:1. protoshapes with this also get a different texture.
* original: similar to ''color'', but not the same?
** TODO: whats the difference?

==== Collision Model ====

Applies to Protoshapes only, it's pretty self-explanatory.
Note that platform shapes will always draw a dashed outline, which is good, as it helps with map readability.

==== Material ====

Defines the sound effect when bullets hit this shape. Also applies different bullet ricochet visuals (but those are not actual bullet ricochets able to hit players).

=== Map Settings ===

There are plenty of settings. I highly recommend exploring the entire settings panel, but you can use this section as a guide.

<q>Note that this section does not primarily consist of authoritative information, but is to a large degree reverse 'engineered'.</q>

==== Dimensions & Scaling ====

* ''Width'', ''Height'': Defines the map size

* ''Scale'': This vector does '''not''' scale the whole map (see '''GlobalScale''' for that) - it's a multiplier on the ''Width'' and ''Height'' attributes.

* ''Mirror'': Enable this if you want a symmetrical map. You only draw the left half of the map, and the game generates the other half on the fly. To get a preview, use the ''mirror'' button at the bottom of the settings UI. Individual map objects can be excluded from mirroring via the ''Mirror'' flag.

* ''GlobalScale, GlobalPosition'': These values transform all objects on the map. Do '''not''' set these numbers in the settings panel, but use the ''transform'' button in the map settings panel (the transformation handle UI can appear outside of the map bounds)

==== Lighting ====
* '''SunLightColor''': Sunlight color taints all objects in the ''foreground'' rendering layer.
* '''SunIntensityShift''': The amount of sunlight
* '''SunHorizontalAngle''', '''SunVerticalAngle''': the angle from which light is applied, useful for shadows on protoshape normals.

* '''Fog''', '''FogColor''', '''FogDistance''': fog applies a taint to ''background'' objects, which is applied with increasing opacity with increasing depth (z axis coordinate).

* '''HueShift''' '''SaturationShift''' '''BrightnessShift''': These transform all colors specified in the settings panel, but does not apply to colors specified on individual map objects.

==== Sky / Background Colors ====

* '''SkyColor''', '''SkyColor2''': two colors with a gradient in between can be defined.
* '''SkyGradientScale''', '''SkyGradientOffset''', '''SkyGradientRotation''': Parameters for the gradient between ''SkyColor'' and ''SkyColor2''.
* '''BackDimColor''': fallback color for the sky, when the setting ''detailed backgrounds'' is disabled. Note that this also applies a taint on ''background'' objects (why tho?).

==== Other Colors ====

* '''FadeColor''': Color applied to the area outside of the map boundary.
* '''EffectsColor''': Color used to taint stuff like explosions. White == untainted.

==== Protoshapes ====

* '''PlatformsColor''': default color for all ''foreground'' platforms, unless they have an individual color specified.

* '''BackColor''': default color for all ''background'' platforms, unless they have an individual color specified.

* '''PlatformsTexture''', '''NormalTexture''': defines the texture of the protoshapes and their normals (i.e the depth information that makes them have shadows.
** '''TODO''': is it possible to provide custom textures by placing them next to a map in the <code>Levels/Custom/</code> dir?

* '''DetaulTexture''', '''DetailNormalTexture''', '''DetailTextureScale''', '''DetailNormalTextureScale''', '''DetailImpact''', '''DetailGradientTexture''', '''DetailColor''': Additionally to their primary texture, protoshapes have a detail overlay with a separate set of textures. ''DetailImpact'' scales the visibility of this overlay.
** Note: iiuc, this is mostly a relic from the pre-0.8 versions with a different renderer. To me, these settings are of little use for design.

==== Miscellaneous ====

* '''Author''': self-explanatory. Make sure to fill this in, people want to be able to find the creator of a map.
* '''AmbientSound''': selects one of a couple soundscapes. there is nothing worse than a sunny map with rumble ambience, be sure to choose a proper ambience.
* '''Generate''': ??? iirc when enabled enabled, some sandbags etc are placed around each basecamp / flag placement.
* '''Seed''': RNG initialization value for the ''generate'' feature.
* '''TopBarrierheight''': ???

=== Workarounds ===

While the editor is in beta, there are plenty of bugs. For many, a workaround is available:

==== Unwanted Spawn Locations ====

In DM, players spawn at random locations on top of any colliding protoshape within map bounds, and not at the spawn locations you can place with the Gostek symbol.
If your map is enclosed by a protoshape that does not extend well outside of the map bounds, players ''will'' spawn there.

This can be avoided, by placing another protoshape along the outer edge of your enclosing shape, extending it well outside of the map bounds.
To not affect your map design you can set apply <code>collision-model: players collide</code> and <code>rendering mode: none</code>.

==== Selecting / moving all map objects ====

It can quickly happen that you run out of space in the left or bottom area.
Instead of moving each object, use the ''transform'' button in the map settings panel to select all objects and move, rotate or scale them all.

==== Protoshape with ''render mode: color'' does not apply color ====

Restart the editor. ¯\_ (ツ)_/¯.

==== Protoshape is invisible ====

This can happen when a shape is very thin or has a very pointy corner.
Moving some vertices around can often fix the issue. If not, creating an extension of the shape

==== Protoshape is always drawn in front of Gosteks ====

The exact root cause is still unclear, some protoshapes just always appear in front of the player, independent of their rendering layer setting and depth value. It could have to do with the vertex order being wrong (clockwise instead of anticlockwise or vice versa). To fix this move some vertexes around, or just replace the shape another with another protoshape that does not have this problem.

== Third Party Tools ==

The community also has written tools for creating maps that integrate with the map game / map editor:

* [https://kreis.uber.space/soldat2/svg2map/ svg2map] by @noerw converts between map JSON files and SVG and can be used to create or edit protoshapes in programs like [https://inkscape.org/ Inkscape].

Mapping

2022-12-10T01:04:46Z

Nerf cardboard:

Creating custom maps & mods is explicitly welcomed - Soldat 2 ships with a built in map editor.

== General Tips for Mapping ==

* Make your map ''readable'': Follow functional conventions of map design. Steel beams and big bridges are almost always ''collisionmodel: players collide'', while small stairs and platforms are - guess what - ''collisionmodel: platform''. Sandbags and barrels are always ''collisionmodel: bullets collide''.

* Especially on CTF maps, make sure to place grenade kits, health packs, and sandbags / barrels, and choose their locations wisely.

* Check your map for bad spawn locations in DM - even if it's not a DM map. See section [[#Unwanted Spawn Locations]] for details.

* Put work in selecting good colors from the start (see below for a guide to what each color does). This will help a lot getting a good feel for the map.

* Always test your maps with the graphics setting ''detailed backgrounds'' set to off. Many people play with this setting (for various reasons), so the map must look okay with this. With this configuration...
** the <code>SkyColor1</code> and <code>SkyColor2</code> colors are not used for the map background. Instead <code>BackDimColor</code> is applied to the background. Make sure it looks OK.
** anything in the ''background'' layer is not drawn. Look for map-props that appear floating because they are placed on a ''background'' shape. To fix this, put these objects also in the ''background'' layer, or move them to a better position.

* Add depth to the map by placing objects deep into the foreground and background. ''dm_db_cuba'' is a good example of this.

* Most props are 3D - rotating them often gives them quite different appearance and use on the map. Make use of this property to reduce repetition, or to reinterpret what those props represent.

* Don't overdo decoration, it will distract too much during game play and in some cases eat FPS of your players. When in doubt, place decorative props on the background layer, so players can hide them via the ''disable detailed backgrounds'' setting.

* There are already a shitload of maps (check out [https://tms2.jrgp.org/ TMS]). If you want to create a map that gets played, make sure you do at least one thing differently. Or fill a niche that is not yet. If you just want to create a piece of art that's of course great too ;)

== Built-in Map Editor ==

The built-in editor is as of v0.8.46a still very much beta - its UI is quite rough around the edges.
Here are some tips for working with it.

=== General Concepts ===

Maps primarily consist of polygons (''protoshapes''), 3D-props, and spawn locations for various items, and a color scheme.
Props and protoshapes have attributes that affect their rendering.
Protoshapes also have a collision model (props don't. To make something collide with a prop, draw a protoshape with disabled rendering on top of it.
Maps are persisted to a JSON structure.

=== MapProp & Protoshape Properties ===

==== Rendering Layer ====

Each object on the map is placed a rendering layer, which affects (a) how it is colored, and (b) sets a default value for the depth / z parameter. Available values are:

* foreground: slightly desaturated, applies ''SunColor'' taint. default for solid protoshapes.
* none: don't draw this object.
* background: desaturates and darkens the object, and applies ''Fog*'' and ''BackDimColor'' taints to it. default for non-colliding protoshapes, which get a different texture applied.
* color: directly applies the color defined on the object 1:1. protoshapes with this also get a different texture.
* original: similar to ''color'', but not the same?
** TODO: whats the difference?

==== Collision Model ====

Applies to Protoshapes only, it's pretty self-explanatory.
Note that platform shapes will always draw a dashed outline, which is good, as it helps with map readability.

==== Material ====

Defines the sound effect when bullets hit this shape. Also applies different bullet ricochet visuals (but those are not actual bullet ricochets able to hit players).

=== Map Settings ===

There are plenty of settings. I highly recommend exploring the entire settings panel, but you can use this section as a guide.

<q>Note that this section does not primarily consist of authoritative information, but is to a large degree reverse 'engineered'.</q>

==== Dimensions & Scaling ====

* ''Width'', ''Height'': Defines the map size

* ''Scale'': This vector does '''not''' scale the whole map (see '''GlobalScale''' for that) - it's a multiplier on the ''Width'' and ''Height'' attributes.

* ''Mirror'': Enable this if you want a symmetrical map. You only draw the left half of the map, and the game generates the other half on the fly. To get a preview, use the ''mirror'' button at the bottom of the settings UI. Individual map objects can be excluded from mirroring via the ''Mirror'' flag.

* ''GlobalScale, GlobalPosition'': These values transform all objects on the map. Do '''not''' set these numbers in the settings panel, but use the ''transform'' button in the map settings panel (the transformation handle UI can appear outside of the map bounds)

==== Lighting ====
* '''SunLightColor''': Sunlight color taints all objects in the ''foreground'' rendering layer.
* '''SunIntensityShift''': The amount of sunlight
* '''SunHorizontalAngle''', '''SunVerticalAngle''': the angle from which light is applied, useful for shadows on protoshape normals.

* '''Fog''', '''FogColor''', '''FogDistance''': fog applies a taint to ''background'' objects, which is applied with increasing opacity with increasing depth (z axis coordinate).

* '''HueShift''' '''SaturationShift''' '''BrightnessShift''': These transform all colors specified in the settings panel, but does not apply to colors specified on individual map objects.

==== Sky / Background Colors ====

* '''SkyColor''', '''SkyColor2''': two colors with a gradient in between can be defined.
* '''SkyGradientScale''', '''SkyGradientOffset''', '''SkyGradientRotation''': Parameters for the gradient between ''SkyColor'' and ''SkyColor2''.
* '''BackDimColor''': fallback color for the sky, when the setting ''detailed backgrounds'' is disabled. Note that this also applies a taint on ''background'' objects (why tho?).

==== Other Colors ====

* '''FadeColor''': Color applied to the area outside of the map boundary.
* '''EffectsColor''': Color used to taint stuff like explosions. White == untainted.

==== Protoshapes ====

* '''PlatformsColor''': default color for all ''foreground'' platforms, unless they have an individual color specified.

* '''BackColor''': default color for all ''background'' platforms, unless they have an individual color specified.

* '''PlatformsTexture''', '''NormalTexture''': defines the texture of the protoshapes and their normals (i.e the depth information that makes them have shadows.
** '''TODO''': is it possible to provide custom textures by placing them next to a map in the <code>Levels/Custom/</code> dir?

* '''DetaulTexture''', '''DetailNormalTexture''', '''DetailTextureScale''', '''DetailNormalTextureScale''', '''DetailImpact''', '''DetailGradientTexture''', '''DetailColor''': Additionally to their primary texture, protoshapes have a detail overlay with a separate set of textures. ''DetailImpact'' scales the visibility of this overlay.
** Note: iiuc, this is mostly a relic from the pre-0.8 versions with a different renderer. To me, these settings are of little use for design.

==== Miscellaneous ====

* '''Author''': self-explanatory. Make sure to fill this in, people want to be able to find the creator of a map.
* '''AmbientSound''': selects one of a couple soundscapes. there is nothing worse than a sunny map with rumble ambience, be sure to choose a proper ambience.
* '''Generate''': ??? iirc when enabled enabled, some sandbags etc are placed around each basecamp / flag placement.
* '''Seed''': RNG initialization value for the ''generate'' feature.
* '''TopBarrierheight''': ???

=== Workarounds ===

While the editor is in beta, there are plenty of bugs. For many, a workaround is available:

==== Unwanted Spawn Locations ====

In DM, players spawn at random locations on top of any colliding protoshape within map bounds, and not at the spawn locations you can place with the Gostek symbol.
If your map is enclosed by a protoshape that does not extend well outside of the map bounds, players ''will'' spawn there.

This can be avoided, by placing another protoshape along the outer edge of your enclosing shape, extending it well outside of the map bounds.
To not affect your map design you can set apply <code>collision-model: players collide</code> and <code>rendering mode: none</code>.

==== Selecting / moving all map objects ====

It can quickly happen that you run out of space in the left or bottom area.
Instead of moving each object, use the ''transform'' button in the map settings panel to select all objects and move, rotate or scale them all.

==== Protoshape with ''render mode: color'' does not apply color ====

Restart the editor. ¯\_ (ツ)_/¯.

==== Protoshape is invisible ====

This can happen when a shape is very thin or has a very pointy corner.
Moving some vertices around can often fix the issue. If not, creating an extension of the shape

==== Protoshape is always drawn in front of Gosteks ====

The exact root cause is still unclear, some protoshapes just always appear in front of the player, independent of their rendering layer setting and depth value. It could have to do with the vertex order being wrong (clockwise instead of anticlockwise or vice versa). To fix this move some vertexes around, or just replace the shape another with another protoshape that does not have this problem.

== Third Party Tools ==

The community also has written tools for creating maps that integrate with the map game / map editor:

* [https://kreis.uber.space/soldat2/svg2map/ svg2map] by @noerw converts between map JSON files and SVG and can be used to create or edit protoshapes in programs like [https://inkscape.org/ Inkscape].

Mapping

2022-12-10T00:59:02Z

Nerf cardboard:

Creating custom maps & mods is explicitly welcomed - Soldat 2 ships with a built in map editor.

== General Tips for Mapping ==

* Put work in selecting good colors from the start (see below for a guide to what each color does). This will help a lot getting a good feel for the map.

* Make your map ''readable'': Follow functional conventions of map design. Steel beams and big bridges are almost always ''collisionmodel: players collide'', while small stairs and platforms are - guess what - ''collisionmodel: platform''. Sandbags and barrels are always ''collisionmodel: bullets collide''.

* Especially on CTF maps, make sure to place grenade kits, health packs, and sandbags / barrels, and choose their locations wisely.

* Check your map for bad spawn locations in DM - even if it's not a DM map. See section [[#Unwanted Spawn Locations]] for details.

* Always test your maps with the graphics setting ''detailed backgrounds'' set to off. Many people play with this setting (for various reasons), so the map must look okay with this. With this configuration...
** the <code>SkyColor1</code> and <code>SkyColor2</code> colors are not used for the map background. Instead <code>BackDimColor</code> is applied to the background. Make sure it looks OK.
** anything in the ''background'' layer is not drawn. Look for map-props that appear floating because they are placed on a ''background'' shape. (To fix this, put these objects also in the ''background'' layer, or move them to a better place'

* There are already a shitload of maps (check out [https://tms2.jrgp.org/ TMS]. If you want to create a map that gets played, make sure you do at least one thing differently. Or fill a niche that is not yet. If you just want to create a piece of art that's of course great too ;)

* Add depth to the map by placing objects deep into the foreground and background. ''dm_db_cuba'' is a good example of this.

* Most props are 3D - rotating them often gives them quite different appearance and use on the map. Make use of this property to reduce repetition, or to reinterpret what those props represent.

* Don't overdo decoration, it will distract too much during game play and in some cases eat FPS of your players. When in doubt, place decorative props on the background layer, so players can hide them via the ''disable detailed backgrounds'' setting.

== Built-in Map Editor ==

The built-in editor is as of v0.8.46a still in early beta - its UI is quite rough around the edges.
Here are some tips for working with it.

=== MapProp & Protoshape Properties ===

==== Rendering Layer ====

Each object on the map is placed a rendering layer, which affects (a) how it is colored, and (b) sets a default value for the depth / z parameter. Available values are:

* foreground: slightly desaturated, applies ''SunColor'' taint. default for solid protoshapes.
* none: don't draw this object.
* background: desaturates and darkens the object, and applies ''Fog*'' and ''BackDimColor'' taints to it. default for non-colliding protoshapes, which get a different texture applied.
* color: directly applies the color defined on the object 1:1. protoshapes with this also get a different texture.
* original: similar to ''color'', but not the same?
** TODO: whats the difference?

==== Collision Model ====

Applies to Protoshapes only, it's pretty self-explanatory.
Note that platform shapes will always draw a dashed outline, which is good, as it helps with map readability.

==== Material ====

Defines the sound effect when bullets hit this shape. Also applies different bullet ricochet visuals (but those are not actual bullet ricochets able to hit players).

=== Map Settings ===

There are plenty of settings. I highly recommend exploring the entire settings panel, but you can use this section as a guide.

<q>Note that this section does not primarily consist of authoritative information, but is to a large degree reverse 'engineered'.</q>

==== Dimensions & Scaling ====

* ''Width'', ''Height'': Defines the map size

* ''Scale'': This vector does '''not''' scale the whole map (see '''GlobalScale''' for that) - it's a multiplier on the ''Width'' and ''Height'' attributes.

* ''Mirror'': Enable this if you want a symmetrical map. You only draw the left half of the map, and the game generates the other half on the fly. To get a preview, use the ''mirror'' button at the bottom of the settings UI. Individual map objects can be excluded from mirroring via the ''Mirror'' flag.

* ''GlobalScale, GlobalPosition'': These values transform all objects on the map. Do '''not''' set these numbers in the settings panel, but use the ''transform'' button in the map settings panel (the transformation handle UI can appear outside of the map bounds)

==== Lighting ====
* '''SunLightColor''': Sunlight color taints all objects in the ''foreground'' rendering layer.
* '''SunIntensityShift''': The amount of sunlight
* '''SunHorizontalAngle''', '''SunVerticalAngle''': the angle from which light is applied, useful for shadows on protoshape normals.

* '''Fog''', '''FogColor''', '''FogDistance''': fog applies a taint to ''background'' objects, which is applied with increasing opacity with increasing depth (z axis coordinate).

* '''HueShift''' '''SaturationShift''' '''BrightnessShift''': These transform all colors specified in the settings panel, but does not apply to colors specified on individual map objects.

==== Sky / Background Colors ====

* '''SkyColor''', '''SkyColor2''': two colors with a gradient in between can be defined.
* '''SkyGradientScale''', '''SkyGradientOffset''', '''SkyGradientRotation''': Parameters for the gradient between ''SkyColor'' and ''SkyColor2''.
* '''BackDimColor''': fallback color for the sky, when the setting ''detailed backgrounds'' is disabled. Note that this also applies a taint on ''background'' objects (why tho?).

==== Other Colors ====

* '''FadeColor''': Color applied to the area outside of the map boundary.
* '''EffectsColor''': Color used to taint stuff like explosions. White == untainted.

==== Protoshapes ====

* '''PlatformsColor''': default color for all ''foreground'' platforms, unless they have an individual color specified.

* '''BackColor''': default color for all ''background'' platforms, unless they have an individual color specified.

* '''PlatformsTexture''', '''NormalTexture''': defines the texture of the protoshapes and their normals (i.e the depth information that makes them have shadows.
** '''TODO''': is it possible to provide custom textures by placing them next to a map in the <code>Levels/Custom/</code> dir?

* '''DetaulTexture''', '''DetailNormalTexture''', '''DetailTextureScale''', '''DetailNormalTextureScale''', '''DetailImpact''', '''DetailGradientTexture''', '''DetailColor''': Additionally to their primary texture, protoshapes have a detail overlay with a separate set of textures. ''DetailImpact'' scales the visibility of this overlay.
** Note: iiuc, this is mostly a relic from the pre-0.8 versions with a different renderer. To me, these settings are of little use for design.

==== Miscellaneous ====

* '''Author''': self-explanatory. Make sure to fill this in, people want to be able to find the creator of a map.
* '''AmbientSound''': selects one of a couple soundscapes. there is nothing worse than a sunny map with rumble ambience, be sure to choose a proper ambience.
* '''Generate''': ??? iirc when enabled enabled, some sandbags etc are placed around each basecamp / flag placement.
* '''Seed''': RNG initialization value for the ''generate'' feature.
* '''TopBarrierheight''': ???

=== Workarounds ===

While the editor is in beta, there are plenty of bugs. For many, a workaround is available:

==== Unwanted Spawn Locations ====

In DM, players spawn at random locations on top of any colliding protoshape within map bounds, and not at the spawn locations you can place with the Gostek symbol.
If your map is enclosed by a protoshape that does not extend well outside of the map bounds, players ''will'' spawn there.

This can be avoided, by placing another protoshape along the outer edge of your enclosing shape, extending it well outside of the map bounds.
To not affect your map design you can set apply <code>collision-model: players collide</code> and <code>rendering mode: none</code>.

==== Selecting / moving all map objects ====

It can quickly happen that you run out of space in the left or bottom area.
Instead of moving each object, use the ''transform'' button in the map settings panel to select all objects and move, rotate or scale them all.

==== Protoshape with ''render mode: color'' does not apply color ====

Restart the editor. ¯\_ (ツ)_/¯.

==== Protoshape is invisible ====

This can happen when a shape is very thin or has a very pointy corner.
Moving some vertices around can often fix the issue. If not, creating an extension of the shape

==== Protoshape is always drawn in front of Gosteks ====

The exact root cause is still unclear, some protoshapes just always appear in front of the player, independent of their rendering layer setting and depth value. It could have to do with the vertex order being wrong (clockwise instead of anticlockwise or vice versa). To fix this move some vertexes around, or just replace the shape another with another protoshape that does not have this problem.

== Third Party Tools ==

The community also has written tools for creating maps that integrate with the map game / map editor:

* [https://kreis.uber.space/soldat2/svg2map/ svg2map] by @noerw converts between map JSON files and SVG and can be used to create or edit protoshapes in programs like [https://inkscape.org/ Inkscape].

Mapping

2022-12-10T00:54:19Z

Nerf cardboard: add initial mapping guide

Creating custom maps & mods is explicitly welcomed - Soldat 2 ships with a built in map editor.

== General Tips for Mapping ==

* Put work in selecting good colors from the start (see below for a guide to what each color does). This will help a lot getting a good feel for the map.

* Make your map ''readable'': Follow functional conventions of map design. Steel beams and big bridges are almost always ''collisionmodel: players collide'', while small stairs and platforms are - guess what - ''collisionmodel: platform''. Sandbags and barrels are always ''collisionmodel: bullets collide''.

* Especially on CTF maps, make sure to place grenade kits, health packs, and sandbags / barrels, and choose their locations wisely.

* Check your map for bad spawn locations in DM - even if it's not a DM map. See section [[#Unwanted Spawn Locations]] for details.

* Always test your maps with the graphics setting ''detailed backgrounds'' set to off. Many people play with this setting (for various reasons), so the map must look okay with this. With this configuration...
** the <code>SkyColor1</code> and <code>SkyColor2</code> colors are not used for the map background. Instead <code>BackDimColor</code> is applied to the background. Make sure it looks OK.
** anything in the ''background'' layer is not drawn. Look for map-props that appear floating because they are placed on a ''background'' shape. (To fix this, put these objects also in the ''background'' layer, or move them to a better place'

* There are already a shitload of maps (check out [https://tms2.jrgp.org/ TMS]. If you want to create a map that gets played, make sure you do at least one thing differently. Or fill a niche that is not yet. If you just want to create a piece of art that's of course great too ;)

* Add depth to the map by placing objects deep into the foreground and background. ''dm_db_cuba'' is a good example of this.

* Don't overdo decoration, it will distract too much during game play. When in doubt, place it on the background layer, so players can hide it via the ''disable detailed backgrounds'' setting.

== Built-in Map Editor ==

The built-in editor is as of v0.8.46a still in early beta - its UI is quite rough around the edges.
Here are some tips for working with it.

=== MapProp & Protoshape Properties ===

==== Rendering Layer ====

Each object on the map is placed a rendering layer, which affects (a) how it is colored, and (b) sets a default value for the depth / z parameter. Available values are:

* foreground: slightly desaturated, applies ''SunColor'' taint. default for solid protoshapes.
* none: don't draw this object.
* background: desaturates and darkens the object, and applies ''Fog*'' and ''BackDimColor'' taints to it. default for non-colliding protoshapes, which get a different texture applied.
* color: directly applies the color defined on the object 1:1. protoshapes with this also get a different texture.
* original: similar to ''color'', but not the same?
** TODO: whats the difference?

==== Collision Model ====

Applies to Protoshapes only, it's pretty self-explanatory.
Note that platform shapes will always draw a dashed outline, which is good, as it helps with map readability.

==== Material ====

Defines the sound effect when bullets hit this shape. Also applies different bullet ricochet visuals (but those are not actual bullet ricochets able to hit players).

=== Map Settings ===

There are plenty of settings. I highly recommend exploring the entire settings panel, but you can use this section as a guide.

<q>Note that this section does not primarily consist of authoritative information, but is to a large degree reverse 'engineered'.</q>

==== Dimensions & Scaling ====

* ''Width'', ''Height'': Defines the map size

* ''Scale'': This vector does '''not''' scale the whole map (see '''GlobalScale''' for that) - it's a multiplier on the ''Width'' and ''Height'' attributes.

* ''Mirror'': Enable this if you want a symmetrical map. You only draw the left half of the map, and the game generates the other half on the fly. To get a preview, use the ''mirror'' button at the bottom of the settings UI. Individual map objects can be excluded from mirroring via the ''Mirror'' flag.

* ''GlobalScale, GlobalPosition'': These values transform all objects on the map. Do '''not''' set these numbers in the settings panel, but use the ''transform'' button in the map settings panel (the transformation handle UI can appear outside of the map bounds)

==== Lighting ====
* '''SunLightColor''': Sunlight color taints all objects in the ''foreground'' rendering layer.
* '''SunIntensityShift''': The amount of sunlight
* '''SunHorizontalAngle''', '''SunVerticalAngle''': the angle from which light is applied, useful for shadows on protoshape normals.

* '''Fog''', '''FogColor''', '''FogDistance''': fog applies a taint to ''background'' objects, which is applied with increasing opacity with increasing depth (z axis coordinate).

* '''HueShift''' '''SaturationShift''' '''BrightnessShift''': These transform all colors specified in the settings panel, but does not apply to colors specified on individual map objects.

==== Other Colors ====

* '''FadeColor''': Color applied to the area outside of the map boundary.
* '''EffectsColor''': Color used to taint stuff like explosions. White == untainted.

===== Protoshapes =====

* '''PlatformsColor''': default color for all ''foreground'' platforms, unless they have an individual color specified.

* '''BackColor''': default color for all ''background'' platforms, unless they have an individual color specified.

* '''PlatformsTexture''', '''NormalTexture''': defines the texture of the protoshapes and their normals (i.e the depth information that makes them have shadows.
** '''TODO''': is it possible to provide custom textures by placing them next to a map in the <code>Levels/Custom/</code> dir?

* '''DetaulTexture''', '''DetailNormalTexture''', '''DetailTextureScale''', '''DetailNormalTextureScale''', '''DetailImpact''', '''DetailGradientTexture''', '''DetailColor''': Additionally to their primary texture, protoshapes have a detail overlay with a separate set of textures. ''DetailImpact'' scales the visibility of this overlay.
** Note: iiuc, this is mostly a relic from the pre-0.8 versions with a different renderer. To me, these settings are of little use for design.

===== Sky / Background =====

* '''SkyColor''', '''SkyColor2''': two colors with a gradient in between can be defined.
* '''SkyGradientScale''', '''SkyGradientOffset''', '''SkyGradientRotation''': Parameters for the gradient between ''SkyColor'' and ''SkyColor2''.
* '''BackDimColor''': fallback color for the sky, when the setting ''detailed backgrounds'' is disabled. Note that this also applies a taint on ''background'' objects (why tho?).

==== Other ====

* '''Author''': self-explanatory. Make sure to fill this in, people want to be able to find the creator of a map.
* '''AmbientSound''': selects one of a couple soundscapes. there is nothing worse than a sunny map with rumble ambience, be sure to choose a proper ambience.
* '''Generate''': ??? iirc when enabled enabled, some sandbags etc are placed around each basecamp / flag placement.
* '''Seed''': RNG initialization value for the ''generate'' feature.
* '''TopBarrierheight''': ???

=== Workarounds ===

While the editor is in beta, there are plenty of bugs. For many, a workaround is available:

==== Unwanted Spawn Locations ====

In DM, players spawn at random locations on top of any colliding protoshape within map bounds, and not at the spawn locations you can place with the Gostek symbol.
If your map is enclosed by a protoshape that does not extend well outside of the map bounds, players ''will'' spawn there.

This can be avoided, by placing another protoshape along the outer edge of your enclosing shape, extending it well outside of the map bounds.
To not affect your map design you can set apply <code>collision-model: players collide</code> and <code>rendering mode: none</code>.

==== Selecting / moving all map objects ====

It can quickly happen that you run out of space in the left or bottom area.
Instead of moving each object, use the ''transform'' button in the map settings panel to select all objects and move, rotate or scale them all.

==== Protoshape with ''render mode: color'' does not apply color ====

Restart the editor. ¯\_ (ツ)_/¯.

==== Protoshape is invisible ====

This can happen when a shape is very thin or has a very pointy corner.
Moving some vertices around can often fix the issue. If not, creating an extension of the shape

==== Protoshape is always drawn in front of Gosteks ====

The exact root cause is still unclear, some protoshapes just always appear in front of the player, independent of their rendering layer setting and depth value. It could have to do with the vertex order being wrong (clockwise instead of anticlockwise or vice versa). To fix this move some vertexes around, or just replace the shape another with another protoshape that does not have this problem.

== Third Party Tools ==

The community also has written tools for creating maps that integrate with the map game / map editor:

* [https://kreis.uber.space/soldat2/svg2map/ svg2map] by @noerw converts between map JSON files and SVG and can be used to create or edit protoshapes in programs like [https://inkscape.org/ Inkscape].

Ranked

2022-12-09T22:26:47Z

Nerf cardboard: add page

Ranked mode is a ladder system, where balanced teams play [[Capture The Flag]] against each other via a ranking & queue system.
Its spirit is similar to the 'Gather' format from classic [[Soldat]] - i.e. competitive, but without the drama.

While many top players play this format, beginners are explicitly welcome - don't be intimidated, it's a great opportunity to learn the mechanics of the game!

== How it works ==

Players queue up for a match in from the ''play ranked'' game menu.
There are multiple queues for different server locations and team sizes.
Once enough players queued for a match, they fight two rounds plus an optional tie-breaker round. The teams are balanced based on all players ranks.
The result of the game affects each players rank (players receive their initial rank only after 10 played ranked matches).
For each round, one team votes (one of three) for a map out of the [#map-rotation map rotation].

== Map Rotation ==

The map rotation currently consists of a subset of the CTF maps included in the game:

* ctf_ash
* ctf_campsite
* ctf_cobra
* ctf_crossfire
* ctf_division
* ctf_dogbite
* ctf_dopamine
* ctf_guardian
* ctf_hormone
* ctf_lanubya
* ctf_limbo
* ctf_rotten
* ctf_snakebite
* ctf_steel
* ctf_tyrus
* ctf_wretch

== Events ==

[[Transhuman Design]] occasionally holds events such as tournaments (whose rules are based on the principle and ladder from ranked mod).

* ''2022-12-17'': Tournament ([https://discord.com/channels/498800300199772162/1050173726387347476/1050337407414837248 Announcement])

== External resources ==

* The [https://kreis.uber.space/soldat2/mapview/ map viewer] has a filter for the rotation and can be used to get an overview of these maps.
* [https://stats.soldat2.com/ Ranked eaderboard & statistics]
* [https://oczki.pl/s2-players Realtime matchmaking status]

Template:Key press

2022-12-09T20:18:44Z

Nerf cardboard: Blanked the page

Template:Key press/styles.css

2022-12-09T20:18:27Z

Nerf cardboard: Blanked the page

Template:Key press/styles.css

2022-12-09T19:59:59Z

Nerf cardboard: copied from https://www.mediawiki.org/wiki/Template:Key_press/styles.css

.keyboard-key {
border: 1px solid #aaa;
border-radius: 0.2em;
box-shadow: 0.1em 0.2em 0.2em #ddd;
background-image: linear-gradient(to bottom, #eee, #f9f9f9, #eee);
padding: 0.1em 0.3em;
font-family: inherit;
font-size: 0.85em;
}

Template:Key press

2022-12-09T19:50:57Z

Nerf cardboard: copied from https://www.mediawiki.org/wiki/Template:Key_press

<templatestyles src="Key press/styles.css"/>{{key press/core|{{{1|}}}}}{{#if:{{{2|}}}|{{{chain first|{{{chain|+}}}}}}{{key press/core|{{{2}}}}}}}{{#if:{{{3|}}}|{{{chain second|{{{chain|+}}}}}}{{key press/core|{{{3}}}}}}}{{#if:{{{4|}}}|{{{chain third|{{{chain|+}}}}}}{{key press/core|{{{4}}}}}}}{{#if:{{{5|}}}|{{{chain fourth|{{{chain|+}}}}}}{{key press/core|{{{5}}}}}}}{{#if:{{{6|}}}|{{{chain fifth|{{{chain|+}}}}}}{{key press/core|{{{6}}}}}}}{{#if:{{{7|}}}|{{{chain sixth|{{{chain|+}}}}}}{{key press/core|{{{7}}}}}}}{{#if:{{{8|}}}|{{{chain seventh|{{{chain|+}}}}}}{{key press/core|{{{8}}}}}}}{{#if:{{{9|}}}|{{{chain eighth|{{{chain|+}}}}}}{{key press/core|{{{9}}}}}}}{{#if:{{{10|}}}|{{{chain ninth|{{{chain|+}}}}}}{{key press/core|{{{10}}}}}}}{{#if:{{{11|}}}|[[Category:Wikipedia keypress template parameter needs fixing]]}}<noinclude>
{{documentation}}

</noinclude>

Movement

2022-12-09T19:48:46Z

Nerf cardboard: add initial version describing some moves - probably highly inaccurate, plz correct

Quick and controlled movement is - next to aiming well - a player's primary skill in Soldat 2.

== Move Set ==

The available mechanics are quite similar to the classic Soldat game, but the move set is bigger.
What follows is an incomplete description of essential moves, in the spirit of [https://wiki.soldat.pl/index.php/Soldat%27s_Comprehensive_Movement_Tutorial guides for classic soldat]

=== Jumps ===
The duration {{key press|Up}} or {{key press|W}} is held down determines the jump height.
Generally, jumps provide more momentum than simply walking, both vertically (duh) and horizontally:

A long jump is often used to kickstart vertical momentum, usually followed by using jets.
Kick jumps - many consecutive short jumps while moving left/right - are the fastest way to move up a slope - the optimal timing depends on the slope angle.

=== Jets ===
{{key press|RMB}} enables jets. They have slow acceleration, so it's best to already have some momentum when using them, eg by doing a long jump before starting to jet boost.

=== Rolls ===
Pressing {{key press|Down}} in combination with holding {{key press|Left}}/{{key press|Right}} causes you to roll.
Immediately rolling when touching ground allows to maintain horizontal momentum [citation needed].

=== Hard Stop ===
When on the ground, letting go of movement keys causes abrupt deceleration.

=== Soft Stop ===
When changing direction on the ground by pressing left before letting go of right (or vice versa), you slowly decelerate before changing directions.
Avoid doing that unless you explicitly need to decelerate, eg. in combination with a long jump.

=== Moving backwards ===
Going backwards (as determined by the cursor position relative to your [[Gostek]]) - provides higher acceleration than going forwards [citation needed].

=== Front Flip ===

After losing contact with the ground, you can make one front and one back flip.

=== Back Flip ===
Facing away from the cursor, and doing the same actions as for the front flip, your Gostek performs a backflip.

=== Cannonball ===
Combining a flip with a short use of jets causes a roll with strong horizontal acceleration.
This move strongly depends on micro timing, and thus requires practice, but is one of the best ways to gain acceleration. The required key sequence is: left/right down, up down, jet down, move up, jet up [citation needed].
The amount of upwards momentum primarily depends on the time window between letting go of up and letting of jets.

=== Superman / Prone ===
- Using jets while in superman provides ability to change directions mid air.
- Going into superman while close to a wall provides you extra momentum away from the wall.
- When on the ground, the direction of going prone / into superman depends on the direction slope you're standing on.
- When already moving quickly, being in superman allows to slide over solid surfaces without losing much momentum.

=== Explosion Boosts ===
Using explosives while standing next to obstacles, provides strong acceleration at the cost of a couple HP.
Technically no obstacle is needed: When in motion, holding a grenade until detonation also provides you a boost.

Different explosives provide a different amount of acceleration - in ascending order:
- (???)
- ...
- ...

== How To Be Hasty™ ==

This guide aims to help with movement on a higher level. Using the above elements from the move set, good ways to solve high level tasks are described.

=== Accelerating ===

==== ...from standstill ====

==== ...horizontally ====

==== ...vertically ====

==== ...going up slope ====

==== ...going down slope ====

==== ...while mid air ====

=== Changing directions ===

=== Using the map & your equipment ===

Main Page

2022-12-09T17:16:08Z

Nerf cardboard: make internal links internal

Welcome to the Soldat 2 Wiki

== Contents ==
* [[Weapons]]
* [[Movement|Movement Guide]]
* [[Mapping|Mapping Guide]]
* [[Server Hosting]]

== Important Links ==
* [https://store.steampowered.com/app/474220/Soldat_2/ Soldat 2 on STEAM]
* [https://oczki.pl/s2-players Active Player Dashboard]
* [https://stats.soldat2.com/ Ranked Ladder Statistics & Leaderboards]
* [https://tms2.jrgp.org/ The Soldat 2 Mapping Showcase]
* [https://kreis.uber.space/soldat2/mapview/ Map Search & Overview]

Main Page

2022-12-09T17:14:44Z

Nerf cardboard: add more links to community contributed sites, add links to new page stubs

Welcome to the Soldat 2 Wiki

== Contents ==
* [https://wiki.soldat2.com/index.php?title=Weapons Weapons]
* [https://wiki.soldat2.com/index.php?title=Movement Movement Guide]
* [https://wiki.soldat2.com/index.php?title=Mapping Mapping Guide]
* [https://wiki.soldat2.com/index.php?title=Server+Hosting Server Hosting]

== Important Links ==
* [https://store.steampowered.com/app/474220/Soldat_2/ Soldat 2 on STEAM]
* [https://oczki.pl/s2-players Active Player Dashboard]
* [https://stats.soldat2.com/ Ranked Ladder Statistics & Leaderboards]
* [https://tms2.jrgp.org/ The Soldat 2 Mapping Showcase]
* [https://kreis.uber.space/soldat2/mapview/ Map Search & Overview]