Commands

Anything that has Local permissions can be used with %command instead of !command when playing as a client in another server.

Quick jump to commands (click to open)

• Auto
• Auto-spectate
• Clear
• Countdown
• Date
• Del
• Dels
• Filter
• Force Start
• Help
• Info
• Kick
• Level
• List
• Load
• Log
• Play
• Players
• Playlist
• Plugin
• Rip
• Save
• Say
• Scores
• Server
• Settings
• Shuffle
• Spectate
• Stuck
• Timelimit
• Unstuck
• Vote
• Vote Control
• Welcome
• Win

Commands:

Auto

Permission Level	Host
Command	!auto

Toggles automatic server mode.

When activated, the server jumps to the next level when every player finishes, or after the timeout specified by autoMaxTime (default 15 minutes).

Settings
autoMaxTime = 900	The maximum time before a level will DNF all players and move to the next. Default: 900 (15 minutes)
autoMinPlayers = 1	The minimum amount of active players required for auto mode to go to the next level. Players in auto-spectate mode are not counted as "active".
voteNext = true	Turns on/off the vote system. The vote system allows players to vote on one of 3 maps to play next
autoUniqueVotes = true	When true: The votes at the end of a level will always show unique levels until the playlist repeats or is reshuffled. All the maps not voted for are skipped. Note that this will get the playlist out-of-order if it's repeated without shuffling.
	When false: The votes at the end of a level can show levels in a vote twice. In this manner, players choose to skip levels instead of play specific levels.
autoShuffleAtEnd = true	Whether to shuffle all levels on playlist repeat or keep the original order.
autoAdvanceMessage = ""	The message to display on every new level. You can set this to some help text like "Press C to chat. Chat !help for commands." or fun text like "Good luck, have fun!"
autoSkipOffline = true	Whether or not to skip local maps and maps deleted from the workshop. If one of these maps is loaded, players are kicked from the server. This makes sure that all maps are Refract maps or can be downloaded from the Workshop.
autoVoteText = "[b]%NAME% [A0A0A0]by %AUTHOR%[-][/b]"	The text to display for each level voted on. See Level Formatting for available formatting options.

---

Auto-Spectate

Permission Level	All/Local
Command	!autospec	Toggles auto-spectate for you
	!autospec <player>	Toggles auto-spectate for another player (Host Only)
	%autospec	Toggles auto-spectate locally when in another server

Auto-spectate mode will put players into spectate mode at the beginning of each level. This can be used when going AFK or using Auto mode.

Settings
autoSpecAllowPlayers = true	Whether or not players can use the !autospec command to turn on auto-spectate mode in your servers. It is suggested that you leave this on, as turning it off will not prevent players from getting ServerMod and using %autospec locally. Ultimately, players have complete control over whether or not they are spectating.
	If this is true, then the Permission Level is All. If this is false then ther Permission Level is Local.
autoSpecIdleTimeout = -1	When set to a positive number, players will be put into spectate mode or auto-spectate mode after this many seconds. This allows players to go AFK without stalling the levels, especially in auto mode.
autoSpecIdleSingle = true	When true: The Idle Timeout puts players into spectate mode.
	When false: The Idle Timeout puts players into auto-spectate mode.
autoSpecReturnToLobby = false	When true: Return to the lobby if Host and no one else is playing.
	When false: Stay in-game in spectate mode.
	This setting is left in for compatibility with version 0.4 of Nico's ServerMod. Auto-spectate as a host is generally combined with auto mode, where you would not want to return to the lobby if all the players leave, as that would quit auto
autoSpecDebug = true	When true: Put auto-idle-spectate debug info in the console
	If you develop mods, you may want to turn this off so it doesn't fill the console window. This is on by default in order to troubleshoot some auto-idle-spectate issues.

---

Clear

Permission Level	Host
Command	!clear

Clears everything from the playlist. Does not work in Trackmogrify.

---

Countdown

Permission Level	Host
Command	!countdown	Start a 60-second countdown
	!countdown <time>	Start a <time>-countdown
	!countdown stop	Stop the countdown

---

Date

Permission Level	All
Command	!date	Show the time and date of the host

---

Del

Permission Level	Host
Command	!del <index>	Remove the level at <index> from the playlist. The next map has an <index> of 0

---

Dels

Permission Level	Host
Command	!dels <index start> <index end>	Remove all level from <index start> to <index end>. The next level has an <index> of 0.

---

Filter

Permission Level	Host + Local
Command	!filter	View help
	!filter list [search text]	Find all filters including [search text]. If no [search text] is provided, then every filter is shown.
	!filter save <name> <filter>	Saves a filter (<filter>) as <name>. <name> must have no spaces in it.
	!filter show <name>	Shows what the first filter matching <name> looks like.
	!filter del <name>	Deletes all filters matching <name>. Will ask for confirmation requiring !filter del yes
	!filter upcoming <filter>	Filters all upcoming levels according to <filter>

The Filter command is used to save filters that can be used later. You can use saved filters with the -f <filter name> or -filter <filter name level filters. See Level Filters for more info.

Settings
filters	The list of saved filters. Can only be modified with the !filter command or by modifying the Settings File.

---

Force Start

Permission Level	Host
Command	!forcestart	Start the level even if players are not Ready.

---

Help

Permission Level	All + Local
Command	!help	View all commands you can use
	!help all	View all commands, including those you cannot use and their permission level
	!help <command>	View help for <command>

---

Info

Permission Level	All + Local
Command	!info <level name>	View information for <level name>, including name, author, ficciulty, mode, rating, medals, creation date, and update date.

---

Kick

Permission Level	Host
Command	!kick <player name>	Kicks the player matching <player name> from the server. <player name> can be a partial match.

---

Level

Permission Level	All + Local
Command	!level <name>	Find levels matching <name>
	!level <filter>	Find levels matching <filter>. See Level Filters.

Settings
levelFormat = "%INDEX% %MODE%: [FFFFFF]%NAME%[-] by %AUTHOR%"	The level format for levels displayed with the Level command. See Level Formatting.
levelFormatReplacements	Regex replacements for formatted level text.
	You must modify the ServerMod.plugin.json file to add to this
	The following example makes all instances of "Challenge" red:

	"levelFormatReplacements" : {
		"Challenge" : "[FF0000]Challenge[-]"
	}

---

List

Permission Level	All
Command	!list	Show upcoming levels in the playlist
	!list <filter>	Show upcoming levels matching <filter>

This re-uses levelFormat for its level formatting.

---

Load

Permission Level	Host
Command	!load	View all playlists
	!load <playlist name>	Loads the first playlist matching <playlist name> into the currently-running playlist.

---

Log

Permission Level	Host + Local
Command	!log [player]	View recent the log, optionally for a specific player.
	!log [player] <page>	View page <page> of the log, optionally for a specific player.
	!log [player] <page> <index>	View index <index> of page <page> of the log, optionally for a specific player.
	!log [player] <page> <index start> <index end>	View logs between <index start> and <index end> of page <page> of the log, optionally for a specific player.

The Log command lets you view command logs. This lets you see what commands players have used and their results.

This also houses all chat-related settings.

Settings
logCount = 100	The number of command logs to keep
showHostCommand = true	Whether the Host should see all commands used.
showHostResults = false	Whether the host should see the results of all commands used.
localHostCommand = true	Whether the host's use of commands should display only to the host.
localHostResults = true	Whether the host's command results should display only to the host.
localClientCommand = false	Whether clients' use of commands should display only to the client that used it (and Host if showHostCommand). When this is on, clients' use of commands will briefly flash on the screen and then be removed. This is due to limitations in Distance's chat system.
localClientResults = true	Whether clients' command results should display only to the client that used the command (and Host if showHostResults). This does not have the problems that localClientCommand does. Client results are local by default because some commands have 10+ lines of results that clutter the chat.
debugChatLogs = false	Whether to print chat log debugging info to the console.

---

Play

Permission Level	All/Host
Command	!play <name>	Add all levels matching <name> to the playlist as the next levels.
	!play <filter>	Add all level matching <filter> to the playlist as the next levels. See Level Filters.

Lets Hosts easily add levels to the playlist. Lets clients easily add or vote for a limited number of levels. You can use the Level command to search for levels, then !play -last to add your last search to the playlist.

Settings
playersCanAddMap = false	Whether or not players/clients are allowed to add maps to the playlist. If true, the Permission Level is All, otherwise it is Host.
playMaxPerCmd = 0	If greater than 0, limits how many levels a player/client can add to the playlist at one time.
playMaxPerRound = 1	If greater than 0, limits how many levels a player/client can add to the playlist in one round.
playIsVote = false	If true, !play <level> acts as !vote play <level> for non-hosts.
playFilter = ""	A filter to narrow down the levels players are allowed to use !play with. You can filter out players you don't want players adding using this. See Level Filters.

---

Players

Permission Level	All + Local
Command	!players	View all players
	!players <name>	View all players matching <name>

---

Playlist

Permission Level	Host + Local
Command	!playlist	View help
	!playlist list [name]	View all playlists, or playlists matching [name] if provided.
	!playlist new [filter]	Creates an empty playlist. If [filter] is provided then the playlist will include all levels matching [filter].
	!playlist load <name>	Loads the playlist matching <name> into the command to be modified.
	!playlist save [name]	Saves the playlist as [name], or whatever its previous name was if [name] is not provided.
	!playlist active	Show the name of the playlist currently being modified.
	!playlist del <name>	Delete a playlist.
	!playlist show [filter]	Shows all levels in the currently-modifying playlist, or levels matching [filter] if provided.
	!playlist filter <filter>	Filters the currently-modifying playlist using <filter>. See Level Filters.
	!playlist add <filter>	Adds all levels matching <filter> to the currently-modifying playlist. See Level Filters.
	!playlist clear	Cleats the currently-modifying playlist.

Some special playlist names:

• current: The playlist you are currently playing, including levels you have already played.
• upcoming: All level in the current playlist that you haven't played.
• active: The currently-modifying playlist.

You can use these like any other playlist name. For example, !playlist load upcoming or !playlist save upcoming

Some examples:

• Save upcoming levels to be played next time:
  • !playlist load upcoming
  • !playlist save last session
• Play a playlist starting after the current level
  • !playlist load my playlist name
  • !playlist save upcoming
• Add a level to your "favorites" playlist
  • !playlist load favorites
  • !playlist add level name
  • !playlist save
• Make come changes to the upcoming levels
  • !playlist load upcoming
  • !playlist filter -shuffle
  • !playlist filter -stars >= 4
  • !playlist save upcoming

Settings
playlistLevelFormat = "%INDEX%: %NAME%"	How to format levels viewed using the Playlist command. See Level Formatting.

---

Plugin

Permission Level	All + Local
Command	!plugin	View everyone's plugin version. This also works on ServerMod clients in any server.

---

Rip

Permission Level	All + Local
Command	!rip %rip	Show a random "rip" text.

Settings
rip	The list of rip text. Can only be edited by editing the settings file.

---

Save

Permission Level	Host
Command	!save <name>	Save the currently-playing playlist to <name>

---

Say

Permission Level
Command	!say <formatted text>	Says something as your name, but does not strip text formatting. See Text formatting.

---

Scores

Permission Level	All + Local
Command	!scores	Show the scores of all players. This includes distance to finish, finish time, and finish result.

---

Server

Permission Level	All + Local
Command	!server	View server info. Available to all + local.
	!server <name>	Change the server name. Host only.
	!server private <password>	Make the server private with <password>. Host only.
	!server public	Make the server public. Host only.

---

Settings

Permission Level
Command	!settings	View help
	!settings reload	Reload settings from the settings file.
	!settings summary	View the value of all settings.
	!settings defaults	View the default value for all settings.
	!settings reset <setting>	Reset <setting> to its default value.
	!settings default <setting>	View the default for <setting>.
	!settings help <setting>	View the help for <settings>.

Settings lets you control settings in-game. The settings names in-game are slightly different from those in the file. You should use !settings or !settings summary before modifying anything.

---

Shuffle

Permission Level	Host
Command	!shuffle	Shuffle the currently-playing playlist.

---

Spectate

Permission Level	Host
Command	!spec <player>	Forces the play matching <player> to spectate.

---

Stuck

Permission Level	All + Local
Command	!stuck	Print server-stuck debugging information.

If the server gets stuck on the loading screen, use !stuck and report the results, preferably as a screenshot. If there are any players with no name or that are stuck being "not ready" then they are the cause of the server being stuck. If the cause of the server getting stuck is found out then a patch can be made in ServerMod to work around it.

---

Timelimit

Permission Level	Host
Command	!timelimit <time>	Change the maximum time for Reverse Tag.

---

Unstuck

Permission Level	Host
Command	!unstuck	Try the default unstuck method
	!unstuck [mode] [param]	Try the other unstuck methods
	!unstuck 1	Default unstuck method; fires ReadyToStartMode locally. Skips players still loading into the game.
	!unstuck 1 all	Fires ReadyToStartMode, but includes every player.
	!unstuck 2	Sends StartMode to all players. Skips players still loading into the game.
	!unstuck 2 all	Sends StartMode, but includes every player.
	!unstuck 3	Deletes the loading screen.

The results of !unstuck can be useful to debug as well. If a particular !unstuck method works for you, tell me so I can integrate it as an automatic solution.

---

Update

Permission Level	Host
Command	!update	Check for ServerMod updates

This command checks the Github Releases page for new versions of ServerMod and displays the first 5 changes in the change list.

Settings
updateCheck = true	Whether or not to check for updates whenever a server is started.
updateShowPreReleases = true	Whether or not to show pre-release versions. All versions are pre-release at the moment, so turning this off means that the update chekcer won't show anything for a long time.

---

Vote

Permission Level	All
Command	!vote	View help
	!vote skip	Vote to skip the map
	!vote stop	Vote to stop the countdown
	!vote play <level>	Vote to play all levels matching <level>

When votes pass a certain threshold of percentage of all players determined by the settings, the vote will come into affect. There are unimplemented kick and count vote types that will show up in the settings.

Settings
allowVoteSystem = false	Whether or not players can use votes
voteSystemThresholds	Can only be modified in the settings file or with !votectrl

---

Vote Control

Permission Level	Host
Command	!votectrl <vote type> <percentage>	Sets the threshold for <vote type> to <percentage>. You can disable specific vote types entirely by setting a <percentage> greater than 100.

---

Welcome

Permission Level	All
Command	!welcome	View the welcome message.

The welcome message is shown to all new players that enter the server.

Settings
welcome	Sets the welcome message.

---

Win

Permission Level	All + Local
Command	!win %win	Show a random "win" text.

Settings
win	The list of win text. Can only be modified in the settings file.