Jump to content

Admin Commands: Difference between revisions

From Byrd Station Wiki
← Older editNewer edit →

LukeZurg22 (talk | contribs)

3 user groups
18 edits
VisualWikitext
mNo edit summary
Whew. Done.
Line 1: Line 1:
== Admin Commands ==
== Notation Guide ==
This list is by no means exhaustive. There are many missing.
----
 
=== Notation Guide ===
- **Action Intended**


- **Command Syntax**
* Action Intended
 
* Command Syntax
- **Additive Descriptors**
* 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 ===
=== Add Game Rule / Start Game Event ===
<code>addgamerule <id></code>
<code>addgamerule <id></code>
 
----
---


=== Add Hands ===
=== Add Hands ===
Line 24: Line 20:


<code>addhand LeftHandCybernetic</code>
<code>addhand LeftHandCybernetic</code>
----


```
=== Add Inventory ===
Add an <code>InventoryComponent</code>


<nowiki>##</nowiki> add inventory
Use VV and edit TemplateIdVV, and set inventory type to any definition. (<code>human</code> is default)


- add `Inventory` Component
The following adds an invisible (untouchable) backpack: <code>self do "equipto $ID ClothingBackpackDuffelGman true"</code>
----


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


The following adds an invisible (untouchable) backpack: `self do "equipto $ID ClothingBackpackDuffelGman true"`
* 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:


---
{| class="wikitable"
|+
!configurators:
<nowiki>*</nowiki> invalid
|}


<nowiki>##</nowiki> mapping
=== Mapping Commands ===


<nowiki>**</nowiki>TIP:** Before mapping, ensure you are in admin ghost form.  
==== Create Map ====


<nowiki>**</nowiki>TIP:** Follow the Wizden Guide for Mapmaking.  
* [https://docs.spacestation14.com/en/space-station-14/mapping/guides/general-guide.html Wizden's Checklist]
* [https://hackmd.io/@Peptide90/MapPublishChecklist Peptide's Checklist]


<nowiki>**</nowiki>TIP:** Roles are defined in map prototypes; ensure spawn counts match (unless `-1`).  
<code>mapping <map id> <saved map/grid location></code>


<nowiki>**</nowiki>TIP:** Remove the following from `.yml` or risk crashes:
''Without save'' ''file path, this will create a blank map.''


```yml
===== Setup Mapping Client Actions =====
<code>mappingclientsidesetup</code>


configurators:
===== Fix Atmospherics =====
<code>fixgridatmos <grid ID></code>


- invalid
=== View Variables ===
<code>vv <grid ID></code>


```
* Add <code>BecomesStation</code> to Server Variables  
* Set Component ID to prototype ID (case-sensitive)


<nowiki>###</nowiki> Create Map
=== Save Map ===
<code>savemap <map id> <filename.yml></code>


Wizden's Checklist: <nowiki>https://docs.spacestation14.com/en/space-station-14/mapping/guides/general-guide.html</nowiki><nowiki><br/></nowiki>
''Ensure <code>.yml</code> extension.''
----


Peptide's Checklist: <nowiki>https://hackmd.io/@Peptide90/MapPublishChecklist</nowiki>
==== Color Pipe Network ====
<code>colornetwork <entity id> Pipe <hex color></code>


---
Colors pipes. Mainly used in mapping.


```
'''Standard Colors:'''


mapping <map id> <saved map/grid location>
* Waste  <code>#990000</code>
* Distro  <code>#0055cc</code>
* Air        <code>#03fcd3</code>
* Mix      <code>#947507</code>


```
----


- Without save location: creates blank map
=== Change Admin OOC Chat Colour ===
<code>setadminooc <</code><code>#XXYYZZ></code>


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


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


mappingclientsidesetup
=== 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> Fix Atmospherics
----


```
=== Link Two Lockers/Crates/Containers as Teleporters ===
<code>linkbluespacelocker <true|false> <entry id> <exit id></code>


fixgridatmos <grid ID>
* <code>true</code> = two-way  
* <code>false</code> = one-way  


```
'''Notes:'''


<nowiki>###</nowiki> View Variables
* Typically used for mercenary shuttle portals.
* Delete one locker to break link.


```
----


vv <grid ID>
=== Adjust Entity Size ===
<code>scale <entity id> <scale></code>


```
* Default: <code>1</code>


- Add `BecomesStation` to Server Variables  
* Use values above <code>2</code> with caution.


- Set Component ID to prototype ID (case-sensitive)
----


<nowiki>###</nowiki> Save Map
=== 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>''
----


savemap <map id> <filename.yml>
=== Arm Nuclear Device Instantly ===
<code>nukearm <seconds> <nuke id></code>
----


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


- Ensure `.yml` extension
=== Replace Prototypes w. Other Prototypes ===
<code>entities prototyped OriginalPrototype replace NewPrototype</code>
----


---
=== List Player Antagonist Objectives ===
<code>lsobjectives <username></code>


<nowiki>##</nowiki> colornetwork
''Lists all objectives for a user's current character if they have any.''
----


Color pipes during mapping.
=== Play Sound File In-Round ===
<code>playglobalsound <file path> <volume> <usernames></code>


<nowiki>**</nowiki>Standard Colors:**
'''Example(s):'''


- Waste: `#990000`
* Audio/_Null/Meme/meme_barbaree.ogg


- Distro: `#0055cc`
----


- Air: `#03fcd3`
=== Show Rules Panel to User ===
<code>showrules <username></code>


- Mix: `#947507`
''This is also an Admin Smite.''
----


```
=== Hold Custom Vote ===
<code>customvote <title> <option1> ... <option9></code>


colornetwork <entity id> Pipe <hex color>
''You can add as many options as the engine will allow.''
----


```
=== 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> setadminooc
=== Add Playtime ===
''WARNING: This is largely antiquated to call manually. The Time Transfer Panel calls this on its own with a convenient UI.''


Change admin OOC chat color.
'''Overall:''' <code>playtime_addoverall <username> <minutes></code>


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


setadminooc <hex colour>
=== Add User to Whitelist ===
<code>whitelistadd <username></code>


```
''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> stations:list
''Allow a user to play a whitelist-only role.''


List all stations and their IDs.
* ➡ <code>jobwhitelistremove <username> <role></code>


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


<nowiki>###</nowiki> setalertlevel
=== Spawn Currency as a Ghost ===
<code>spawnrefund <amount></code>


Change station alert level manually.
''Note: May be antiquated, or reserved for space-forks, such as Frontier.''
----


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


setalertlevel <alert level> <true|false>
''Randomizes blast, steel, and other types of tiles that have multiple variants.''
----


```
=== Count Tiles In a Grid ===
<code>gettilecount <grid id></code>


- Must be on station grid  
''WARNING: Not implemented in Byrd. Source is from the Null Sector repository. This is here for nostalgia.''
----


- Supports: delta, gamma, epsilon  
=== Create Planet ===
<code>planetdv <map id> <template></code>


---
* Default template: Snow  
* Uses pandora.yml example map  


<nowiki>###</nowiki> linkbluespacelocker
''WARNING: Not (probably) implemented in Byrd. Source is from the Null Sector repository. This is here for nostalgia and future reference to return-to.''
----


Link two lockers/crates as teleporters.
=== Allow a Player VPN Connection ===
<code>ban_exemption_update <player name> Datacenter</code>


```
''Allows a player to connect using a VPN. For our friends in countries such as the Russian Federation, and the Republic of Türkiye.''
 
----
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 |
 
|----|------|
 
| JobSecurityOfficer | deputy |
 
| JobSeniorOfficer | sergeant |
 
| JobWarden | bailiff |
 
| JobHeadOfSecurity | sheriff |
 
| JobHeadOfPersonnel | colonial liaison |
 
| JobPassenger | contractor |
 
| JobBorg | cyborg |
 
| JobSecurityCadet | cadet |
 
| JobPilot | pilot |
 
| JobMercenary | mercenary |
 
| JobDirectorOfCare | director of care |
 
| JobStc | station traffic control |
 
| JobLawyer | public affairs liaison |
 
| JobBrigMedic | brig medic |
 
---
 
<nowiki>##</nowiki> whitelistadd
 
Add a user to whitelist.
 
```
 
whitelistadd <username>
 
```
 
> Remember to add a permanent admin note.
 
<nowiki>###</nowiki> jobwhitelistadd <username> <role>
 
Allow a user to play a whitelist-only role.
 
<nowiki>###</nowiki> jobwhitelistremove <username> <role>
 
Remove a user from being able to play a whitelist-only role.
 
---
 
<nowiki>##</nowiki> spawnrefund
 
Spawn currency as a ghost.
 
```
 
spawnrefund <amount>
 
```
 
---
 
<nowiki>##</nowiki> variantize
 
Randomize blasted tiles.
 
```
 
variantize <id>
 
```
 
---
 
<nowiki>##</nowiki> gettilecount
 
Count tiles in a grid.
 
```
 
gettilecount <grid id>
 
```
 
---
 
<nowiki>##</nowiki> planetdv
 
```
 
planetdv <map id> <template>
 
```
 
- Default template: `Snow`  
 
- Uses `pandora.yml` example map  
 
---
 
<nowiki>##</nowiki> ban_exemption_update
 
```
 
ban_exemption_update <player name> Datacenter
 
```
 
Allow a player to connect using a VPN. For our friends in the Russian Federation, and the Republic of Türkiye.
 
---
 
<nowiki>##</nowiki> Rendering A Map Screenshot
 
```
 
mapping <id>
 
loadgrid <id> <map>.yml
 
savemap <id> /<map>.yml
 
```
 
<nowiki>**</nowiki>If shuttle map:**
 
- Add `BecomesStation` to prototype
 
<nowiki>###</nowiki> Render Command
 
```
 
dotnet run --project Content.MapRenderer --no-build <becomes-station ID>


```
=== Rendering A Map Screenshot ===


---
# <code>mapping <id></code>
# <code>loadgrid <id> <map>.yml</code>
# <code>savemap <id> /<map>.yml</code>


'''If shuttle map:'''


---
* Add BecomesStation to prototype


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

Revision as of 15:41, 19 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 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>

View Variables

vv <grid ID>

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

Save Map

savemap <map id> <filename.yml>

Ensure .yml extension.

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

scale <entity id> <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

List Player Antagonist Objectives

lsobjectives <username>

Lists all objectives for a user's current character if they have any.

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=41"