Jump to content

Admin Commands: Difference between revisions

From Byrd Station Wiki

LukeZurg22 (talk | contribs)

3 user groups
18 edits
VisualWikitext
Plopped my notes here.
 
 
(8 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<nowiki>#</nowiki> Admin Commands
== Notation Guide ==


This list is by no means exhaustive. There are many missing.
* Action Intended
 
* Command Syntax
---
* Additive Descriptors
 
<nowiki>##</nowiki> Notation Guide
 
- **Action Intended**
 
- **Command Syntax**
 
- **Additive Descriptors**
 
---


ToC not provided.
ToC not provided.
== Admin Commands ==
This list is by no means exhaustive. There are many missing.
----


---
=== Add Game Rule / Start Game Event ===
 
<code>addgamerule <id></code>
<nowiki>##</nowiki> addgamerule
----
 
```
 
addgamerule <UnknownShuttleZenith | UnknownShuttleRazor>
 
```
 
---
 
<nowiki>##</nowiki> add hands to entity
 
`self comp:ensure ComplexInteraction comp:ensure Hands` or `ent <net ID> comp:ensure ComplexInteraction comp:ensure Hands`
 
```
 
addhand RightHandCybernetic
 
addhand LeftHandCybernetic
 
```
 
<nowiki>##</nowiki> add inventory
 
- add `Inventory` Component
 
- Use VV and edit TemplateIdVV, and set inventory type to any definition. (`human` is default)
 
The following adds an invisible (untouchable) backpack: `self do "equipto $ID ClothingBackpackDuffelGman true"`
 
---
 
<nowiki>##</nowiki> mapping
 
<nowiki>**</nowiki>TIP:** Before mapping, ensure you are in admin ghost form.  
 
<nowiki>**</nowiki>TIP:** Follow the Wizden Guide for Mapmaking.  
 
<nowiki>**</nowiki>TIP:** Roles are defined in map prototypes; ensure spawn counts match (unless `-1`).  
 
<nowiki>**</nowiki>TIP:** Remove the following from `.yml` or risk crashes:
 
```yml
 
configurators:
 
- invalid
 
```
 
<nowiki>###</nowiki> Create Map
 
Wizden's Checklist: <nowiki>https://docs.spacestation14.com/en/space-station-14/mapping/guides/general-guide.html</nowiki><nowiki><br/></nowiki>
 
Peptide's Checklist: <nowiki>https://hackmd.io/@Peptide90/MapPublishChecklist</nowiki>
 
---
 
```
 
mapping <map id> <saved map/grid location>
 
```
 
- Without save location: creates blank map
 
<nowiki>###</nowiki> Client Setup
 
```
 
mappingclientsidesetup
 
```
 
<nowiki>###</nowiki> Fix Atmospherics
 
```
 
fixgridatmos <grid ID>
 
```
 
<nowiki>###</nowiki> View Variables
 
```
 
vv <grid ID>
 
```
 
- Add `BecomesStation` to Server Variables  
 
- Set Component ID to prototype ID (case-sensitive)
 
<nowiki>###</nowiki> Save Map
 
```
 
savemap <map id> <filename.yml>
 
```
 
- Ensure `.yml` extension
 
---
 
<nowiki>##</nowiki> colornetwork
 
Color pipes during mapping.
 
<nowiki>**</nowiki>Standard Colors:**
 
- Waste: `#990000`
 
- Distro: `#0055cc`
 
- Air: `#03fcd3`
 
- Mix: `#947507`
 
```
 
colornetwork <entity id> Pipe <hex color>
 
```
 
---
 
<nowiki>##</nowiki> setadminooc
 
Change admin OOC chat color.
 
```
 
setadminooc <hex colour>
 
```
 
---
 
<nowiki>##</nowiki> stations:list
 
List all stations and their IDs.
 
---
 
<nowiki>###</nowiki> setalertlevel
 
Change station alert level manually.
 
```
 
setalertlevel <alert level> <true|false>
 
```
 
- Must be on station grid  
 
- Supports: delta, gamma, epsilon  
 
---
 
<nowiki>###</nowiki> linkbluespacelocker
 
Link two lockers/crates as teleporters.
 
```
 
linkbluespacelocker <true|false> <entry id> <exit id>
 
```
 
- `true` = two-way  
 
- `false` = one-way  
 
<nowiki>**</nowiki>Notes:**
 
- Used for merc shuttle portals  
 
- Delete one locker to break link  
 
---
 
<nowiki>###</nowiki> scale
 
Adjust entity size.
 
```
 
scale <entity id> <scale>
 
```
 
- Default: `1`  
 
- Use caution above `2`
 
---
 
<nowiki>##</nowiki> rename
 
Rename any entity or grid.
 
`rename <entity id> "<new name>"`
 
Optionally, one can rename entities in bulk: `entities prototyped <proto. ID> do "rename $ID \"<name>\""`
 
---
 
<nowiki>##</nowiki> nukearm
 
Arm a nuke instantly.
 
```
 
nukearm <seconds> <nuke id>
 
```
 
---
 
<nowiki>##</nowiki> nukecodes
 
Send nuke codes via fax.
 
```
 
nukecodes <nuke id>
 
```
 
---
 
<nowiki>##</nowiki> replace prototypes
 
`entities prototyped OriginalPrototype replace NewPrototype`
 
---
 
<nowiki>##</nowiki> list objectives
 
```
 
lsobjectives <username>
 
```
 
Lists all objectives for a user's current character if they have any.
 
---
 
<nowiki>##</nowiki> playglobalsound
 
Play a server sound.
 
```
 
playglobalsound <file path> <volume> <usernames>
 
```
 
<nowiki>**</nowiki>Example:**
 
```
 
Audio/_Null/Meme/meme_barbaree.ogg
 
```
 
---
 
<nowiki>##</nowiki> showrules
 
Show rules panel to a user.
 
```
 
showrules <username>
 
```
 
---
 
<nowiki>##</nowiki> customvote
 
```
 
customvote <title> <option1> ... <option9>
 
```
 
---
 
<nowiki>##</nowiki> ent <> jobs:job <> jobs:adjust <>
 
```
 
ent <nowiki><A> jobs:job <B> jobs:adjust <C></nowiki>
 
```
 
_Add / remove job slots to / from a station._
 
Adjust job **B** (dropdown list provided) by **C** amount for station ID **A**.
 
---
 
<nowiki>##</nowiki> playtime_add<x>
 
<nowiki>###</nowiki> Overall
 
```
 
playtime_addoverall <username> <minutes>
 
```
 
<nowiki>###</nowiki> Role
 
```
 
playtime_addrole <username> <role> <minutes>
 
```
 
---
 
<nowiki>###</nowiki> Useful Role IDs


| ID | Role |
=== Add Hands ===
<code>self comp:ensure ComplexInteraction comp:ensure Hands</code> or <code>ent <net ID> comp:ensure ComplexInteraction comp:ensure Hands</code>


|----|------|
<code>addhand RightHandCybernetic</code>


| JobSecurityOfficer | deputy |
<code>addhand LeftHandCybernetic</code>
----


| JobSeniorOfficer | sergeant |
=== Add / Remove / List Antagonist Objectives ===
<code>addobjective</code> <code><player> <id></code> ''Adds an objective to the player.''


| JobWarden | bailiff |
<code>rmobjective <player> <id></code> ''Removes an objective from the player.''


| JobHeadOfSecurity | sheriff |
<code>lsobjectives <player></code> ''Lists all objectives for a user's current character if they have any.''


| JobHeadOfPersonnel | colonial liaison |
''Autocomplete dropdown lists are provided during use.''
----


| JobPassenger | contractor |
=== Add Inventory ===
Add an <code>InventoryComponent</code>


| JobBorg | cyborg |
Use VV and edit TemplateIdVV, and set inventory type to any definition. (<code>human</code> is default)


| JobSecurityCadet | cadet |
The following adds an invisible (untouchable) backpack: <code>self do "equipto $ID ClothingBackpackDuffelGman true"</code>
----


| JobPilot | pilot |
=== Mapping ===


| JobMercenary | mercenary |
* TIP: Before mapping, ensure you are in admin ghost form.  
* TIP: Follow the Wizden Guide for Mapmaking.  
* TIP: Roles are defined in map prototypes; ensure spawn counts match (unless -1).  
* TIP: Remove the following from <code>.yml</code> or risk crashes:


| JobDirectorOfCare | director of care |
{| class="wikitable"
|+
!configurators:
<nowiki>*</nowiki> invalid
|}


| JobStc | station traffic control |
==== Mapping Commands ====


| JobLawyer | public affairs liaison |
===== Create Map =====


| JobBrigMedic | brig medic |
* [https://docs.spacestation14.com/en/space-station-14/mapping/guides/general-guide.html Wizden's Checklist]
* [https://hackmd.io/@Peptide90/MapPublishChecklist Peptide's Checklist]


---
<code>mapping <map id> <saved map/grid location></code>


<nowiki>##</nowiki> whitelistadd
''Without save'' ''file path, this will create a blank map.''


Add a user to whitelist.
===== Setup Mapping Client Actions =====
<code>mappingclientsidesetup</code>


```
===== Fix Atmospherics =====
<code>fixgridatmos <grid ID></code>


whitelistadd <username>
==== Save Map ====
<code>savemap <map id> <filename.yml></code>


```
''Ensure <code>.yml</code> extension.''
----


> Remember to add a permanent admin note.
==== View Variables ====
<code>vv <grid ID></code>


<nowiki>###</nowiki> jobwhitelistadd <username> <role>
* Add <code>BecomesStation</code> to Server Variables  
* Set Component ID to prototype ID (case-sensitive)


Allow a user to play a whitelist-only role.
==== Color Pipe Network ====
<code>colornetwork <entity id> Pipe <hex color></code>


<nowiki>###</nowiki> jobwhitelistremove <username> <role>
Colors pipes. Mainly used in mapping.


Remove a user from being able to play a whitelist-only role.
'''Standard Colors:'''


---
* Waste  <code>#990000</code>
* Distro  <code>#0055cc</code>
* Air        <code>#03fcd3</code>
* Mix      <code>#947507</code>


<nowiki>##</nowiki> spawnrefund
----


Spawn currency as a ghost.
=== Change Admin OOC Chat Colour ===
<code>setadminooc <</code><code>#XXYYZZ></code>


```
''#XXYYZZ is a valid six-byte 0x<u>HEX</u>h code.''
----


spawnrefund <amount>
=== List all Stations and their IDs. ===
<code>stations:list</code>
----


```
=== Change Station Alert Level ===
<code>setalertlevel <alert level> <true|false></code>


---
* Must be on station grid  
* Supports: <code>delta</code>, <code>gamma</code>, <code>epsilon</code>  


<nowiki>##</nowiki> variantize
----


Randomize blasted tiles.
=== Link Two Lockers/Crates/Containers as Teleporters ===
<code>linkbluespacelocker <true|false> <entry id> <exit id></code>


```
* <code>true</code> = two-way  
* <code>false</code> = one-way  


variantize <id>
'''Notes:'''


```
* Typically used for mercenary shuttle portals.
* Delete one locker to break link.


---
----


<nowiki>##</nowiki> gettilecount
=== Adjust Entity Size ===
<code>ent <entity id> scale:set <scale></code>


Count tiles in a grid.
* Default: <code>1</code>


```
* Use values above <code>2</code> with caution.


gettilecount <grid id>
----


```
=== Rename any Entity / Grid ===
<code>rename <entity id> "<new name>"</code>


---
''Optionally, one can rename entities in bulk: <code>entities prototyped <proto. ID> do rename $ID "<name>"</code>''
----


<nowiki>##</nowiki> planetdv
=== Arm Nuclear Device Instantly ===
<code>nukearm <seconds> <nuke id></code>
----


```
=== Fax Nuclear Codes ===
<code>nukecodes <nuke id></code>
----


planetdv <map id> <template>
=== Replace Prototypes w. Other Prototypes ===
<code>entities prototyped OriginalPrototype replace NewPrototype</code>
----


```
=== Play Sound File In-Round ===
<code>playglobalsound <file path> <volume> <usernames></code>


- Default template: `Snow`  
'''Example(s):'''


- Uses `pandora.yml` example map  
* Audio/_Null/Meme/meme_barbaree.ogg


---
----


<nowiki>##</nowiki> ban_exemption_update
=== Show Rules Panel to User ===
<code>showrules <username></code>


```
''This is also an Admin Smite.''
----


ban_exemption_update <player name> Datacenter
=== Hold Custom Vote ===
<code>customvote <title> <option1> ... <option9></code>


```
''You can add as many options as the engine will allow.''
----


Allow a player to connect using a VPN. For our friends in the Russian Federation, and the Republic of Türkiye.
=== Adjust Job Slots ===
<code>ent <nowiki><A> jobs:job <B> jobs:adjust <C></nowiki></code>


---
''Add / remove job slots to / from a station. Adjusts job B (dropdown list provided) by C amount for station ID A.''
----


<nowiki>##</nowiki> Rendering A Map Screenshot
=== Add Playtime ===
''WARNING: This is largely antiquated to call manually. The Time Transfer Panel calls this on its own with a convenient UI.''


```
'''Overall:''' <code>playtime_addoverall <username> <minutes></code>


mapping <id>
'''Role:''' <code>playtime_addrole <username> <role> <minutes></code>
----


loadgrid <id> <map>.yml
=== Add User to Whitelist ===
<code>whitelistadd <username></code>


savemap <id> /<map>.yml
''Admin's Note: It is usually a good idea to add a permanent admin note exclaiming that a user is whitelisted. It doesn't do anything, but does help with back-checking if they happen to be a problem.''


```
* ➡ <code>jobwhitelistadd <username> <role></code>


<nowiki>**</nowiki>If shuttle map:**
''Allow a user to play a whitelist-only role.''


- Add `BecomesStation` to prototype
* ➡ <code>jobwhitelistremove <username> <role></code>


<nowiki>###</nowiki> Render Command
''Remove a user from being able to play a whitelist-only role.''
----


```
=== Spawn Currency as a Ghost ===
<code>spawnrefund <amount></code>


dotnet run --project Content.MapRenderer --no-build <becomes-station ID>
''Note: May be antiquated, or reserved for space-forks, such as Frontier.''
----


```
=== Visually Randomize Tiles ===
<code>variantize <map id></code>


---
''Randomizes blast, steel, and other types of tiles that have multiple variants.''
----


<nowiki>###</nowiki> Fix Renderer Issues
=== Count Tiles In a Grid ===
<code>gettilecount <grid id></code>


<nowiki>**</nowiki>File:**  
''WARNING: Not implemented in Byrd. Source is from the Null Sector repository. This is here for nostalgia.''
----


`RobustToolbox/Robust.Shared/EntitySerialization/EntityDeserializer.cs`
=== Create Planet ===
<code>planetdv <map id> <template></code>


Comment out:
* Default template: Snow  
* Uses pandora.yml example map  


- Lines 864-865  
''WARNING: Not (probably) implemented in Byrd. Source is from the Null Sector repository. This is here for nostalgia and future reference to return-to.''
----


- Lines 1154-1167  
=== Allow a Player VPN Connection ===
<code>ban_exemption_update <player name> Datacenter</code>


- Line 1172  
''Allows a player to connect using a VPN. For our friends in countries such as the Russian Federation, and the Republic of Türkiye.''
----


<nowiki>**</nowiki>File:**  
=== Rendering A Map Screenshot ===


`RobustToolbox/Robust.Shared/EntitySerialization/Systems/MapLoaderSystem.Load.cs`
# <code>mapping <id></code>
# <code>loadgrid <id> <map>.yml</code>
# <code>savemap <id> /<map>.yml</code>


Comment out:
'''If shuttle map:'''


- Lines 103-109  
* Add BecomesStation to prototype


---
==== Render Command ====
<code>dotnet run --project Content.MapRenderer --no-build <becomes-station ID></code>
-----LZ22

Latest revision as of 05:24, 22 July 2026

Notation Guide

  • Action Intended
  • Command Syntax
  • Additive Descriptors

ToC not provided.

Admin Commands

This list is by no means exhaustive. There are many missing.

Add Game Rule / Start Game Event

addgamerule <id>

Add Hands

self comp:ensure ComplexInteraction comp:ensure Hands or ent <net ID> comp:ensure ComplexInteraction comp:ensure Hands

addhand RightHandCybernetic

addhand LeftHandCybernetic

Add / Remove / List Antagonist Objectives

addobjective <player> <id> Adds an objective to the player.

rmobjective <player> <id> Removes an objective from the player.

lsobjectives <player> Lists all objectives for a user's current character if they have any.

Autocomplete dropdown lists are provided during use.

Add Inventory

Add an InventoryComponent

Use VV and edit TemplateIdVV, and set inventory type to any definition. (human is default)

The following adds an invisible (untouchable) backpack: self do "equipto $ID ClothingBackpackDuffelGman true"

Mapping

  • TIP: Before mapping, ensure you are in admin ghost form.  
  • TIP: Follow the Wizden Guide for Mapmaking.  
  • TIP: Roles are defined in map prototypes; ensure spawn counts match (unless -1).  
  • TIP: Remove the following from .yml or risk crashes:
configurators:

* invalid

Mapping Commands

Create Map

mapping <map id> <saved map/grid location>

Without save file path, this will create a blank map.

Setup Mapping Client Actions

mappingclientsidesetup

Fix Atmospherics

fixgridatmos <grid ID>

Save Map

savemap <map id> <filename.yml>

Ensure .yml extension.

View Variables

vv <grid ID>

  • Add BecomesStation to Server Variables  
  • Set Component ID to prototype ID (case-sensitive)

Color Pipe Network

colornetwork <entity id> Pipe <hex color>

Colors pipes. Mainly used in mapping.

Standard Colors:

  • Waste #990000
  • Distro #0055cc
  • Air #03fcd3
  • Mix #947507

Change Admin OOC Chat Colour

setadminooc <#XXYYZZ>

#XXYYZZ is a valid six-byte 0xHEXh code.

List all Stations and their IDs.

stations:list

Change Station Alert Level

setalertlevel <alert level> <true|false>

  • Must be on station grid  
  • Supports: delta, gamma, epsilon  

linkbluespacelocker <true|false> <entry id> <exit id>

  • true = two-way  
  • false = one-way  

Notes:

  • Typically used for mercenary shuttle portals.
  • Delete one locker to break link.

Adjust Entity Size

ent <entity id> scale:set <scale>

  • Default: 1
  • Use values above 2 with caution.

Rename any Entity / Grid

rename <entity id> "<new name>"

Optionally, one can rename entities in bulk: entities prototyped <proto. ID> do rename $ID "<name>"

Arm Nuclear Device Instantly

nukearm <seconds> <nuke id>

Fax Nuclear Codes

nukecodes <nuke id>

Replace Prototypes w. Other Prototypes

entities prototyped OriginalPrototype replace NewPrototype

Play Sound File In-Round

playglobalsound <file path> <volume> <usernames>

Example(s):

  • Audio/_Null/Meme/meme_barbaree.ogg

Show Rules Panel to User

showrules <username>

This is also an Admin Smite.

Hold Custom Vote

customvote <title> <option1> ... <option9>

You can add as many options as the engine will allow.

Adjust Job Slots

ent <A> jobs:job <B> jobs:adjust <C>

Add / remove job slots to / from a station. Adjusts job B (dropdown list provided) by C amount for station ID A.

Add Playtime

WARNING: This is largely antiquated to call manually. The Time Transfer Panel calls this on its own with a convenient UI.

Overall: playtime_addoverall <username> <minutes>

Role: playtime_addrole <username> <role> <minutes>

Add User to Whitelist

whitelistadd <username>

Admin's Note: It is usually a good idea to add a permanent admin note exclaiming that a user is whitelisted. It doesn't do anything, but does help with back-checking if they happen to be a problem.

  • ➡ jobwhitelistadd <username> <role>

Allow a user to play a whitelist-only role.

  • ➡ jobwhitelistremove <username> <role>

Remove a user from being able to play a whitelist-only role.

Spawn Currency as a Ghost

spawnrefund <amount>

Note: May be antiquated, or reserved for space-forks, such as Frontier.

Visually Randomize Tiles

variantize <map id>

Randomizes blast, steel, and other types of tiles that have multiple variants.

Count Tiles In a Grid

gettilecount <grid id>

WARNING: Not implemented in Byrd. Source is from the Null Sector repository. This is here for nostalgia.

Create Planet

planetdv <map id> <template>

  • Default template: Snow  
  • Uses pandora.yml example map  

WARNING: Not (probably) implemented in Byrd. Source is from the Null Sector repository. This is here for nostalgia and future reference to return-to.

Allow a Player VPN Connection

ban_exemption_update <player name> Datacenter

Allows a player to connect using a VPN. For our friends in countries such as the Russian Federation, and the Republic of Türkiye.

Rendering A Map Screenshot

  1. mapping <id>
  2. loadgrid <id> <map>.yml
  3. savemap <id> /<map>.yml

If shuttle map:

  • Add BecomesStation to prototype

Render Command

dotnet run --project Content.MapRenderer --no-build <becomes-station ID>

LZ22

Retrieved from "https://wiki.byrdstation.space/index.php?title=Admin_Commands&oldid=50"