Jump to content

Admin Commands

From Byrd Station Wiki

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>

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

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