Commands

From Starbounder - Starbound Wiki
Jump to: navigation, search

In admin mode, commands can be used by typing a / followed by the keyword for the command. Admin mode can be toggled on and off using the command /admin. Admin mode is only required for admin and debugging commands - basic commands can be used even without admin privileges.

On multiplayer servers there are several settings that can block players from gaining admin privileges. They are discussed here.

Basic Commands

Command /help Text Description Example
/help Use /help commandName to get detailed documentation. Shows a list of commands. Typing a valid command afterwards displays how that command works. /help OR /help spawnitem
/admin Usage /admin. Enables or disables admin mode, which enables all crafting recipes, prevents damage or energy loss, and allows access to admin-only commands. Same as /help Text. For full details see: Admin Command /admin
/reload Usage /reload. Reloads your local, client side assets. Will cause lag as they are reparsed. Useful when testing a mod as it will reload the assets without requiring to exit the game. Same as /help Text. /reload
/whoami Usage /whoami. Display your local username and admin status. Same as /help Text. /whoami
/serverwhoami Usage /serverwhoami. Display your server username and admin status. Same as /help Text. /serverwhoami
/whereami Usage /whereami. Display the celestial coordinate of your current location. Same as /help Text. /whereami
/pvp Usage /pvp. Enable or disable your Player vs. Player mode. Toggle your Player VS Player mode if possible. /pvp
/played Usage /played. Displays the total play time of the current character. Displays how long you've played this character. /played
/deaths Usage /deaths. Displays the total death count of the current character. Same as /help Text. /deaths
/suicide Usage /suicide. Kills the current character, incurring all normal death penalties (including permadeath!). This can be used as a last resort if you are irreversibly stuck. Same as /help Text. /suicide
/naked Usage /naked. Remove all gear. Useful in macros to give a character new gear replacing the existing gear, or you know, for fun. Same as /help Text. Many bed-type objects do this to characters while in use. /naked

Admin Commands

Command /help Text Description Example
/warp Usage /warp warpAction. Warps player to a world and/or position. Valid warp action formats include: OwnShip, OrbitedWorld, CelestialWorld:celestialcoordinates, InstanceWorld:worldid:<uuid>:<level>, ClientShipWorld:playeruuid, Player:playeruuid, Nowhere (current world). Most warp actions can have =xcoordinate.ycoordinate added to specify a position within that world. Teleports the user to a location on a planet or within an instanced area such as a Mission or the Outpost. Arguments contained within <>s are optional. /warp Nowhere=0.1100

or /warp OrbitedWorld or /warp InstanceWorld:Outpost

/timewarp Usage /timewarp time. Warp universe time ahead by the specified number of seconds. Modifies the server time by the specified number of seconds, causing day-night cycles on planets and Outpost merchants to update accordingly. Both positive and negative values are accepted. /timewarp 30
/settileprotection Usage /settileprotection dungeonId isProtected. Set protection for blocks with the specified dungeonId to be true (unbreakable) or false (breakable). Sets the isProtected property of the instanced area specified by dungeonId to the specified value. IsProtected is a boolean property and thus can be either true or false. You can see the dungeon ID in /debug mode. /settileprotection floranmission1 false
/setspawnpoint Usage /setspawnpoint. Sets the default spawn point on the current world to your character's position. Same as /help Text. The default spawn point is where people who beam down to a given world will appear. /setspawnpoint
/spawnitem Usage /spawnitem itemName [count] [parameters]. Spawn the specified item at the mouse cursor. If the item does not exist it will spawn a perfectly generic item. Count should be an integer and defaults to 1. Parameters should be specified as a JSON object enclosed by single quotes. Same as /help Text. Arguments in brackets are usually optional; however, if you are filling in parameters, you must also fill in count in order for the command to work correctly.
  • To find an item's spawn name you can look here, or at the bottom of its wiki page, or unpack the assets.
  • To spawn a codex type itemName-codex, e.g., esthersjournal (itemName) becomes /spawnitem esthersjournal-codex.
  • When using the color index or JSON parameters below, the count is required. When not using them, you can leave off the count and get 1 item.

Items can be spawned in different colors using the color index like so: /spawnitem florantier6mhead 1 '{"colorIndex":4}'

1. Black 2. Grey 3. White 4. Red 5. Orange
6. Yellow 7. Green 8. Blue 9. Purple 10. Pink 11. Brown

You can spawn in custom colors by using JSON parameters to replace the hex color values in the item's asset file like this:

/spawnitem bonusarmorchest 1 '{"directives":"?replace;6f2919=151515;a85636=383838;e0975c=555555;ffca8a=838383"}'

/spawnitem money 5
/spawntreasure Usage /spawntreasure poolName [level]. Spawns all items in a single random generation of the specified treasure pool at the mouse cursor. Level defaults to 1. Same as /help Text. If you are using treasure pools with a chance for nothing to drop, you may have to use the command multiple times before you get an item to appear. The level argument corresponds to Tier and is important mostly for generic treasure pools such as commonGun and uniqueWeapon. /spawntreasure uniqueWeapon 6
/spawnmonster Usage /spawnmonster type [level] [parameters]. Spawn a monster of the specified type at the mouse cursor. Level defaults to 1. Parameters should be specified as a JSON object enclosed by single quotes. Spawns a specified monster type at the mouse cursor. For full details see: Spawn Monster Command /spawnmonster largequadruped
/spawnnpc Usage /spawnnpc species type [level] [seed] [overrides]. Spawn an NPC of the specified species and type at the mouse cursor. Level defaults to 1. Overrides should be specified as a JSON object enclosed by single quotes. Spawns an NPC of the specified species and type at the mouse cursor. For full details see: Spawn NPC Command /spawnnpc novakid merchant
/spawnvehicle Usage /spawnvehicle type [parameters]. Spawn a vehicle of the specified type at the mouse cursor. Parameters should be specified as a JSON object enclosed by single quotes. Same as /help Text. Hoverbikes and boats spawned this way are not connected to controllers, so they cannot be desummoned or repaired normally. /spawnvehicle hoverbikered
/spawnstagehand Usage /spawnstagehand type [parameters]. Spawn a Stagehand of the specified type. Parameters should be specified as a JSON object enclosed by single quotes. Spawns a stagehand, a helper object which is mainly used for Quests and within instanced areas such as Missions. Valid stagehand types include coordinator, mailbox, messenger, objecttracker, questlocation, questmanager, radiomessage, waypoint, bossmusic, cultistbeamposition, cultistflyingslashposition, cultistidelslashposition, cultistlowerdashposition, cultistsphereposition, cultistupperdashposition, bossdooropener, bossplanner, npccombat, apexmissionbattleeffect, apexmissioncallscriptsensor, glitchmissionmanager, glitchmissionspawnpoint, and protectoratemanager /spawnstagehand bossmusic
/clearstagehand Usage /clearstagehand. Despawns any stagehands with positions close to the current cursor position. Despawns any stagehands with broadcast areas containing or positions close to the current cursor position. /clearstagehand
/spawnliquid Usage /spawnliquid liquidName [quantity]. Spawn a quantity of the specified liquid at the mouse cursor. Quantity defaults to 1. Same as /help Text. If you want to spawn liquid as an item that you loot, use /spawnitem instead. For full details see: Spawn Liquid Command /spawnliquid corelava 20
/kick Usage /kick playerSpecifier [reason]. Kick the specified player and send the reason to the player. If no reason is specified then the player's server nickname is used as the reason.", Same as /help Text. For all admin commands with a playerSpecifier field, client ID, server nickname or player UUID can be used to specify the targeted player. /kick Player Swearing
/ban Usage /ban playerSpecifier [reason] [kind] [timeInSeconds]. Kick and ban the specified player and send the reason to the player. If no reason is specified then the player's server nickname is used as the reason. Kind is specified as "uuid" or "ip" or "both" and defaults to "both". timeInSeconds defaults to forever. Bans that have a specified duration are not persistent. If you shut down the server or reload configuration, all of your temporarily banned users will be unbanned immediately.", Same as /help Text. For all admin commands with a playerSpecifier field, client ID, server nickname or player UUID can be used to specify the targeted player. A UUID ban only prevents a particular character from joining, regardless of IP address, while an IP ban prevents all users at a particular IP address from joining, regardless of their chosen character. /ban Player Griefing both
/list Usage /list. List all clients logged into the server. Format is $clientId : serverNickname : $$playerUuid. If the serverNickname contains unprintable characters the unicode escape sequence for those characters will be displayed instead. Same as /help Text. This command is useful for helping you use commands requiring a playerSpecifier field. /list
/whereis Usage /whereis playerSpecifier. Display the celestial coordinate of the specified player's current location. Same as /help Text. For all admin commands with a playerSpecifier field, client ID, server nickname or player UUID can be used to specify the targeted player. /whereis Player
/serverreload Usage /serverreload. Reloads the remote, server side assets. Will cause lag as they are reparsed. Same as /help Text. /serverreload
/enablespawning Usage /enablespawning. Enable automatic monster spawning on the current world. Same as /help Text. If the current world is unloaded, spawning will reset to its default setting when it is reloaded. /enablespawning
/disablespawning Usage /disablespawning. Disable automatic monster spawning on the current world. Same as /help Text. If the current world is unloaded, spawning will reset to its default setting when it is reloaded. /disablespawning
/placedungeon Usage /placedungeon dungeonname [position]. Place the given dungeon into the world anchored at the specified position or the player's cursor position. Positions should be specified as x,y. Ignores anchoring rules. Same as /help Text. Though the command doesn't specify it, a JSON parameter enclosed in single quotes can be added to modify the properties of the dungeon to be placed. /placedungeon evilfortress
/setuniverseflag Usage /setuniverseflag flagName. Sets the current universe flag, triggering any associated world changes. Universe Flags allow the game to know what progressive state the Universe is in (which missions have been completed). This command can be used administratively to mark missions as completed. Acceptable arguments: outpost_mission*, outpost_beakeasy (outpost_mission could be any of 1-6, they seem to need to be done in order though meaning you can't just run a single /setuniverseflag outpost_mission6 without having done the rest of them first), outpost_techscientist# (# is either 1 or 2), outpost_ursaminer, final_gate_key, vaultsopen /setuniverseflag outpost_mission1
/resetuniverseflags Usage /resetuniverseflags. Clears all universe flags, but doesn't directly revert any effects triggered by those flags. Deletes all universe flags associated with a given universe. Useful for resetting the Outpost to its initial state, though the changes won't take effect until the first time that the Outpost is loaded after using this command. /resetuniverseflags

Debugging Commands

Command /help Text Description
/debug Usage /debug. Enable debugging mode. Toggle debugging mode. This enables or disables all of the commands below.
/gravity Usage /gravity. Display the gravity at the player's position. Same as /help Text.
/boxes Usage /boxes. Toggle the display of collision debugging polygons if debug mode is enabled. Same as /help Text.
/clearboxes Usage /clearboxes. Toggle whether or not to clear boxes displayed with /boxes every frame. Useful for determining routes that enemies take, can get messy looking though. Same as /help Text.
/togglelayer Usage /togglelayer. Toggle the visibility of the specified layer. A layer is a number between 1 and 21. They are in order: Sky, Parallax, Background, Platforms, Plant, PlantDrop, Object, CursorHintedObject, ParticlesBottom, Effect, Projectile, NPC, Player, ItemDrop, Water, ParticlesMiddle, Foreground, ParticlesTop, Nametag, InfoBars. Same as /help Text.
/fullbright Usage /fullbright. Disable the lighting engine and show everything. When enabled, everything displays as if it were fully lit.
/fixedcamera Usage /fixedcamera. Toggle locking the camera's position; camera will not scroll. Sectors may not load or behave correctly when the camera is distant from the player's position. Same as /help Text.
/setgravity Usage /setgravity level. Sets your local gravity to the level specified. Negative values will make you fall up but you can't jump from your head. This change is local only, and looks pretty heinous on a server, because it screws very heavily with delta prediction. Same as /help Text.
/resetgravity Usage /resetgravity. Undoes /setgravity. Begin using server gravity again. Same as /help Text.
/eval Usage /eval <lua>. Evaluates given lua in script processor context. Only usable locally. Same as /help Text.
/entityeval Usage /entityeval <lua>. Evaluates given lua in the context of the closest scripted entity to the cursor. Only usable locally. Same as /help Text.
/radiomessage Usage /radiomessage messageId. Triggers the player to receive the radio message with the specified id. Same as /help Text. Radio messages are the messages you get from SAIL and other NPCs while out and about.
/clearradiomessages Usage /clearradiomessages. Resets all history of received unique radio messages, allowing the player to see these messages again.", Same as /help Text.
/clearcinematics Usage /clearcinematics. Resets all history of played unique cinematics, allowing the player to see these cinematics again. Same as /help Text.
/cinema Usage /cinema cinematicPath. Plays the specified cinematic for testing. Same as /help Text.
/startquest Usage /startquest questArcDescriptor. Give the player a quest with the specified quest arc descriptor, which should be a JSON string or object enclosed by single quotes. To start a quest by quest template ID, enclose the template ID in single and double quotes, e.g. /startquest '"protectorate"' Same as /help Text.
/completequest Usage /completequest questId. Force completion of a currently active quest with the given quest ID (usually the quest template ID). Same as /help Text.
/failquest Usage /failquest questId. Force failure of a currently active quest with the given quest ID (usually the quest template ID). Same as /help Text.
/previewnewquest Usage /previewnewquest questTemplateId positionInSequence questGiverSpecies. Displays the New Quest interface for the given quest without altering the player's quest state. Valid positionInSequence options are: first, last, next, solo. May break if the quest doesn't have example data configured. Same as /help Text.
/previewquestcomplete Usage /previewquestcomplete questTemplateId positionInSequence questGiverSpecies. Displays the Quest Complete interface for the given quest without altering the player's quest state. Valid positionInSequence options are: first, last, next, solo. May break if the quest doesn't have example data configured. Same as /help Text.
/previewquestfailed Usage /previewquestfailed questTemplateId positionInSequence questGiverSpecies. Displays the Quest Failed interface for the given quest without altering the player's quest state. Valid positionInSequence options are: first, last, next, solo. May break if the quest doesn't have example data configured. Same as /help Text.
/clearscannedobjects Usage /clearscannedobjects. Resets the player's record of previously scanned objects. Will not reset quest progress for object scanning quests. Same as /help Text.
/statistic Usage /statistic statName. Displays the value of the specified achievement statistic. Same as /help Text.
/resetachievements Usage /resetachievements. Resets all of the player's achievement statistics. Same as /help Text.
/enabletech Usage /enabletech techName. Unlocks the specified tech for use. Same as /help Text.
/maketechavailable Usage /maketechavailable techName. Makes the specified tech visible and available for purchase. Same as /help Text.
/giveessentialitem Usage /giveessentialitem item slotName. Sets the specified essential slot to the specified item, overwriting the existing contents. Valid slot names are: beamaxe, wiretool, painttool, inspectiontool. Same as /help Text.
/upgradeship Usage /upgradeship shipUpgrades. Applies the specified ship upgrades to the current player's ship. shipUpgrades should be specified as a JSON object enclosed by single quotes, e.g. '{"shipLevel" : 5}' Same as /help Text. All numbers from 1 to 8 are valid ship levels. Level is 1 is when SAIL has not yet been rebooted, level 2 is when the FTL drive is not yet repaired, and level 3 is the initial state after the FTL drive has been repaired. Levels 4 through 8 correspond to the various upgrade levels of the ship which normally require Upgrade Modules to attain.

Removed Commands

Command Description
/coordinate Displays the current coordinate of the world you are on or orbiting.
/itemid Displays item information in chat and the log. For full details see: Item ID Command
/showhunger Usage /showhunger. Displays your hunger bar for several seconds.
/spawngun Usage /spawngun level [kind]. Spawn a randomized gun with the given level. For full details see: Spawn Gun Command. (Removed in Nightly Glad Giraffe, can sometimes use /spawnitem now)
/spawnshield Usage /spawnshield level [kind]. Spawn a randomized shield with the given level. If kind is specified then the shield is limited to that kind (for instance, riotshield). If you want to spawn a non-randomly generated shield use /spawnitem instead.
/spawnsword Usage /spawnsword level [kind]. Spawn a randomized sword with the given level. For full details see: Spawn Sword Command. (Removed in Nightly Glad Giraffe, can sometimes use /spawnitem now)

Trivia

When you use the /timewarp command the words "It's just a jump to the left..." appear in chat. This is a reference to the time warp sequence on Rocky Horror Picture Show. When you use the /timewarp command and insert a negative value to timewarp to the words "Great Scott! We can't go back in time!" appear in chat. This is a reference to the Back to the Future film series.