Editing Dedicated Server Hosting Guide (section)

=RCON=

<span id="bots-tools"></span>
==Bots &amp; Tools==

Mordhau uses the Source Engine RCON protocol, and should work with most RCON tools that support the Source RCON protocol.

Here a few examples of tools specifically for use with Mordhau:

* [https://sourceforge.net/projects/ssrcdsrcon/ Simple SourceDS RCON]
* [https://github.com/WaGi-Coding/mordhau-rcon-tool Taki7o7's Mordhau RCON-Tool]
* [https://github.com/Tom-Beijner/Mordhau-RCON Schweppes' Mordhau RCON Bot]

<span id="broadcasts"></span>

==Broadcasts==

Broadcasts are messages that the game server can send out to RCON clients

There are currently 6 supported broadcast channels that can be used:

* '''Chat:''' Connected clients will receive the chat feed
* '''Login:''' This will inform clients when a player logs in or out
* '''Matchstate:''' Informs clients when the match is starting or ending (may add more later)
* '''Scorefeed:''' Notifies clients when scores change (both player and team)
* '''Killfeed:''' Notifies clients when a player is killed
* '''Custom:''' A customizable channel that modders can use to broadcast custom information

Server-side mods can be used to extend the information sent through each of these channels.

In order to begin listening to a channel, use the 'listen' command: e.g. "listen chat start" would start listening for chat messages being broadcasted

You can set channels that new connecting clients will listen to by default by adding this to Game.ini:

<syntaxhighlight lang="ini">[Rcon]
ListeningToByDefault=InsertTypeOfBroadcastHere
ListeningToByDefault=chat
ListeningToByDefault=custom
</syntaxhighlight>
&nbsp;

See the [[Server Configuration]] page for more details on how to configure RCON.

<span id="commands"></span>

==Commands==

{| class="wikitable"
|-
!Command
!Description
|-
|
<code>help</code>
|Provides a list of these commands.
|-
|
<code>alive</code>
|Prevents the connection from being timed out due to inactivity. Only usually necessary if you are not listening to any broadcasts (see above), or the server has been inactive for too long.
|-
|
<code>listen <Type> <Start/Stop></code>
|This command will allow you to toggle listening for broadcasted data from the server. Supported types: all login, matchstate, killfeed, scorefeed, chat
|-
|
<code>listenstatus</code>
|Retrieve a list of what types of broadcasts you are listening for
|-
|
<code>adminlist</code>
|Displays a list of PlayfabID's for all current admins
|-
|
<code>banlist</code>
|Displays a list of PlayfabID's for all current bans and their duration
|-
|
<code>mutelist</code>
|Displays a list of PlayfabID's for all current mutes and their duration
|-
|
<code>playerlist</code>
|Displays a list of PlayfabID's for all players on the server, displaying their name, ping, and team (if applicable).
|-
|
<code>maplist</code>
|Displays a list of all of the current maps in the map rotation, as well as their ArrayIndex.
|-
|
<code>addmap <MapName> <ArrayIndex> <UpdateConfig></code>
|Adds a map to the map rotation. For '''MapName''' see [[Server Map Names]]. '''ArrayIndex''' would be the position you wish to insert the map (see the ArrayIndex from maplist), you can set this to 0 to place at the top. '''UpdateConfig''' is a boolean, setting to True would save the change to the Game.ini file, False would hold it in memory only.
|-
|
<code>removemap <MapName> <UpdateConfig></code>
|Removes a map from the map rotation. See the maplist command for the valid map name to use. '''UpdateConfig''' is a boolean, setting to True would save the change to the Game.ini file, False would hold it in memory only.
|-
|
<code>addadmin <PlayerName/PlayfabID></code>
|Adds a player or PlayfabID to the list of admins.
|-
|
<code>removeadmin <PlayerName/PlayfabID></code>
|Remove a player or PlayfabID from the list of admins.
|-
|
<code>addbots <Amount> <Team></code>
|Adds the specified amount of bots to the server. The team is 0 by default for non-team modes, otherwise 0 for the Red team, and 1 for the Blue Team.
|-
|
<code>removebots <Amount> <Team></code>
|Removes the specified amount of bots from the server. The team is 0 by default for non-team modes, otherwise 0 for the Red team, and 1 for the Blue Team.
|-
|
<code>changelevel <MapName></code>
|Changes the current map to the specified Map. For a list of valid maps see [[Server Map Names]].
|-
|
<code>say <Message></code>
|Send a generic message as the server
|-
|
<code>customsay <Message> <MessageType></code>
|Currently disabled/non-functional.
|-
|
<code>string <String></code>
|Used for modding.
|-
|
<code>event <EventName></code>
|Used for modding.
|-
|
<code>spawnserveractor <ActorPath> <Transform></code>
|Used for modding.
|-
|
<code>kick <PlayerName/PlayfabID> <Reason></code>
|Kicks the specified player or PlayfabID for the given reason. Player name can only be used if the player is currently on the server.
|-
|
<code>ban <PlayerName/PlayfabID> <Reason> <Duration></code>
|Bans the specified player or PlayfabID for the given reason and duration. Duration must be an integer, in minutes. Player name can only be used if the player is currently on the server.
|-
|
<code>unban <PlayFabID></code>
|Unbans a specified PlayfabID.
|-
|
<code>mute <PlayerName/PlayfabID> <Duration></code>
|Mutes the specified player or PlayfabID for the given duration. Duration must be an integer, in minutes. Player name can only be used if the player is currently on the server.
|-
|
<code>unmute <PlayFabID></code>
|Unmutes a specified PlayfabID.
|-
|
<code>scoreboard</code>
|Displays the current scoreboard on the server. Output is as follows: PLAYFABID, NAME, TEAM (0 for Red or No Team, 1 for Blue -1 for spectator), LEVEL/MMR (0 for unranked or bot), SCORE, KILLS, DEATHS, ASSISTS
|-
|
<code>info</code>
|Displays the current server info. HostName, ServerName, Version, GameMode and Map.
|-
|
<code>stats</code>
|Returns server performance statistics - minimum, average and maximum tick rate
|-
|
<code>writetoconsole <Message></code>
|Displays a message in the console, that won't be seen by players.
|-
|
<code>changeteam <PlayerName/PlayfabID> <Team></code>
|Changes the team of the specified Player or PlayfabID. The team is 0 for the Red team and 1 for the Blue team. It cannot be used to force a player into Spectator.
|-
|
<code>modifyinivar <File name> <nowiki><Section name> <Variable name> <Value> <Type></nowiki></code>
|The file name should be 'game' or 'engine'. The section name and variable name must match an INI heading and value from that file. Supported types: bool, int, float, string, text, vector2d, vector, rotator, color
|-
|
<code>getmatchduration</code>
|Will output how many seconds are remaining on the current match.
|-
|
<code>extendmatchduration <Duration in seconds></code>
|Allows you to extend the current match duration, Duration must be in Seconds.
|-
|
<code>setmotd <Url></code>
|Must link to a valid Markdown file, see [[MOTD Markdown Guide]]
|-
|
<code>teleportplayer <PlayerName/PlayfabID> <x=#,y=#,z=#></code>
|Teleports the specified Player or PlayfabID to the coordinates provided. Must be provided in the format: '''x=#,y=#,z=# .''' You can get these coordinates from the SDK, or using in-game console commands such as '''ShowDebug CAMERA'''
|-
|
<code>killplayer <PlayerName/PlayfabID></code>
|Kills the specified Player or PlayfabID. The player must be on the server to function.
|-
|
<code>getteamdamage <PlayerName/PlayfabID></code>
|Displays the current team damage of a specified Player or PlayfabID. Must be a team mode, and player must be on the server.
|-
|
<code>renameplayer <PlayerName/PlayfabID> <New name></code>
|Renames the specified Player or PlayfabID to the new name.
|-
|
<code>chatlog <Num messages to retrieve></code>
|Returns the specified number of recent chat messages. You should use the Chat Listen Broadcast instead (see above) to get a real-time feed of chat messages.
|-
|
<code>shutdown</code>
|Shuts down the server
|}

<span id="motd"></span>