Starbound Admin Commands: Difference between revisions

From Survival Servers
Jump to navigation Jump to search
Starbound server hosting guide
 
[wiki:wiki-operator] Reworded to the house writing rules; facts that were wrong today corrected (approved by Ryan, Nov 17)
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
Starbound splits its commands into two groups: the ones you type in chat as an admin inside the game, and the much smaller set a remote RCON console can run. This page covers both.
{{#seo:|title=Starbound Admin Commands: How to Get Admin and Use RCON|description=Starbound admin commands: get admin with a serverUsers account and /admin, then spawn items, kick and ban players, and run the smaller RCON command set.}}
Starbound splits its commands into two groups: the ones you type in chat as an admin inside the game, and the much smaller set a remote RCON console can run.


== Becoming admin ==
== Becoming admin ==


Admin in Starbound is an account, not a password prompt. The server owner adds an entry to <code>serverUsers</code> in <code>storage/starbound_server.config</code> with <code>"admin" : true</code>, you log in with that account name and password when you join, and then you type the following in chat:
Admin in Starbound is an account, not a password prompt. The server owner adds an entry to <code>serverUsers</code> in <code>storage/starbound_server.config</code> with <code>"admin" : true</code>. You log in with that account name and password when you join, then type this in chat:


  /admin
  /admin


That toggles admin mode on and off. While it is on you have unlimited resources, no fall damage, and access to the commands below.
That toggles admin mode on and off. While it's on, you have every crafting recipe unlocked, no damage or energy loss, and access to the in-game admin commands.


'''Note:''' if <code>allowAdminCommands</code> is set to false in the server config, none of these work for anybody, including the owner.
'''Note:''' if <code>allowAdminCommands</code> is set to false in the server config, none of these work for anybody, including the owner.
Line 15: Line 16:
* <code>/admin</code> toggle admin mode
* <code>/admin</code> toggle admin mode
* <code>/help</code> list the commands available to you
* <code>/help</code> list the commands available to you
* <code>/who</code> list the players currently connected
* <code>/list</code> list the players currently connected
* <code>/whereis <player></code> show a player's current world
* <code>/whereis <player></code> show a player's current world
* <code>/warp <destination></code> travel to a world or player
* <code>/warp <destination></code> travel to a world or player
Line 23: Line 24:
* <code>/kick <player> [reason]</code> remove a player
* <code>/kick <player> [reason]</code> remove a player
* <code>/ban <player> [reason] [ip/uuid] [seconds]</code> ban a player, permanently or for a time
* <code>/ban <player> [reason] [ip/uuid] [seconds]</code> ban a player, permanently or for a time
* <code>/unban <uuid or ip></code> lift a ban
* <code>/unbanip <ip></code> or <code>/unbanuuid <uuid></code> lift a ban
* <code>/timewarp <seconds></code> jump the whole server forward in time
* <code>/timewarp <seconds></code> jump the whole server forward in time
* <code>/settileprotection <dungeonId> <true/false></code> protect or unprotect a region
* <code>/settileprotection <dungeonId> <true/false></code> protect or unprotect a region
Line 31: Line 32:
== RCON commands ==
== RCON commands ==


Starbound ships a standard Source RCON server, switched off by default. The command surface over RCON is much smaller than the in-game set, because most Starbound commands act through a character standing in the world and RCON has none. What reliably works:
Starbound comes with a standard Source RCON server, turned off by default. RCON runs far fewer commands than the in-game set, because most Starbound commands act through a character standing in the world, and RCON has none. These work reliably:


* <code>help</code> list what this console can run
* <code>help</code> list what this console can run
* <code>ban</code>, <code>unban</code>, <code>kick</code>
* <code>ban</code>, <code>unbanip</code>, <code>unbanuuid</code>, <code>kick</code>
* <code>whisper</code> send a private message to a player
* <code>say</code> send a message to every player
* <code>whereis</code> return a player's coordinates
* <code>whereis</code> return the world a player is on
* <code>timewarp</code>
* <code>timewarp</code>
* <code>serverreload</code> reload assets and mods without a restart
* <code>serverreload</code> reload assets and mods without a restart
* <code>shutdown</code> stop the server cleanly
* <code>stop</code> stop the server cleanly


'''Note:''' the leading slash is not needed over RCON.
'''Note:''' the leading slash isn't needed over RCON.


== Running a server ==
== Running a server ==


Setting all of this up by hand means a Steam licence, a JSON file that silently reverts if you mistype it, and mod files that overwrite each other. [https://www.survivalservers.com/services/game_servers/starbound/ Starbound dedicated server] hosting from Survival Servers handles the lot, with admin accounts and RCON configurable from a control panel.
Setting all of this up yourself means a Steam licence, a JSON file that silently reverts if you mistype it, and mod files that overwrite each other. [https://www.survivalservers.com/services/game_servers/starbound/ Starbound dedicated server] hosting from Survival Servers handles all of it, with admin accounts and RCON set up in the Command Center.

Latest revision as of 09:06, 17 November 2026

Starbound splits its commands into two groups: the ones you type in chat as an admin inside the game, and the much smaller set a remote RCON console can run.

Becoming admin

Admin in Starbound is an account, not a password prompt. The server owner adds an entry to serverUsers in storage/starbound_server.config with "admin" : true. You log in with that account name and password when you join, then type this in chat:

/admin

That toggles admin mode on and off. While it's on, you have every crafting recipe unlocked, no damage or energy loss, and access to the in-game admin commands.

Note: if allowAdminCommands is set to false in the server config, none of these work for anybody, including the owner.

In-game admin commands

  • /admin toggle admin mode
  • /help list the commands available to you
  • /list list the players currently connected
  • /whereis <player> show a player's current world
  • /warp <destination> travel to a world or player
  • /spawnitem <name> [count] spawn an item
  • /spawnmonster <name> spawn a monster
  • /spawnnpc <species> <type> spawn an NPC
  • /kick <player> [reason] remove a player
  • /ban <player> [reason] [ip/uuid] [seconds] ban a player, permanently or for a time
  • /unbanip <ip> or /unbanuuid <uuid> lift a ban
  • /timewarp <seconds> jump the whole server forward in time
  • /settileprotection <dungeonId> <true/false> protect or unprotect a region
  • /serverreload reload assets, including mods
  • /pvp toggle your own PvP flag

RCON commands

Starbound comes with a standard Source RCON server, turned off by default. RCON runs far fewer commands than the in-game set, because most Starbound commands act through a character standing in the world, and RCON has none. These work reliably:

  • help list what this console can run
  • ban, unbanip, unbanuuid, kick
  • say send a message to every player
  • whereis return the world a player is on
  • timewarp
  • serverreload reload assets and mods without a restart
  • stop stop the server cleanly

Note: the leading slash isn't needed over RCON.

Running a server

Setting all of this up yourself means a Steam licence, a JSON file that silently reverts if you mistype it, and mod files that overwrite each other. Starbound dedicated server hosting from Survival Servers handles all of it, with admin accounts and RCON set up in the Command Center.