BYOND Tabletop Gaming

Command Reference

All the BTG commands are listed below in alphabetical order. Commands that target a field, sheet or player are best used by right clicking on your target in the statpanels and selecting the command from the context menu.
 
Back to the Table of Contents
 
Add chat_group player Available to: Chat group owner
Adds a player to a chat group.
 
Ban player Available to: Host & GM
Bans a player from the game server. The player is disconnected and may not reconnect until the GM unbans him or her.
 
Boot player Available to: Host & GM
Disconnects a player from the game server.
 
Channel chat_group Available to: All players
Select a chat group. The selected chat group will be used for all messages from the "say" command and from story box or image show commands.
 
Color color_value Available to: All players
Changes the player's chat text color.
Colors may be given in #RRGGBB, #RGB, or name format. For example, "color #FF0000", "color #F00", and "color red" each turn the user's text red.
 
Contents sheet Available to: All players
Opens a statpanel for the sheet so you may manipulate the properties of it's fields. See the Statpanel chapter.
 
Copy field Available to: All players
Clears the clipboard and copies the field into the clipboard. You may only copy fields that you have edit rights for.
 
Copy+ field Available to: All players
Adds a copy of the field to the clipboard, retaining any other fields that were already in the clipboard. You may only copy fields that you have edit rights for.
 
Cut field Available to: All players
Clears the clipboard, removes the field from it's current location, and moves it into the clipboard. You may only cut fields that you have edit rights for.
 
Cut+ field Available to: All players
Removes the field from it's current location, and add it to the clipboard, retaining any other fields that were already in the clipboard. You may only cut fields that you have edit rights for.
 
Delete field / chat_group Available to: All players / Chat group owner
Permenantly deletes a field (or chat group) from it's current location. You recommended to use cut for fields instead of delete, so that you may restore the field if you accidently remove it. You may only delete fields that you have edit rights for.
 
Display sheet / Workspace Available to: All players
Displays the sheet in a popup window. This is the default action if you click on a sheet or the Workspace. You may only display a sheet if you have view rights for it.
 
Emote action Available to: All players
Emotes are used to describe player actions. For example, if Tom enters the command "emote pokes the werewolf in the eye with his silver dagger.", the message "Tom pokes the werewolf in the eye with his silver dagger." will appear inside the chat box with Tom's text color.
 
Load sheet / Workspace Available to: All players
Loads a sheet from the user's computer in the targeted sheet or workspace. Saved workspaces are always loaded into the Workspace, regardless of where you attempt to load them.
 
makeGM player Available to: Host
Grants GM (GameMaster) status to the targeted player. There may only be one GM at a time in BYOND Tabletop Gaming, so making someone a GM will remove GM status from whoever had it before.
 
Members chat_group Available to: Chat group member
List the players in the chat group.
 
Mute player Available to: Host & GM
Silences a player so that they may not display messages or play sounds.
 
Name chat_group Available to: Chat group owner
Rename a chat group.
 
New field Available to: All players
Creates a new field inside the sheet that the target field belongs to, or inside the target if it is a sheet.
 
Newchannel Available to: All players
Create a new chat group.
 
Paste field Available to: All players
Pastes a copy of the clipboard contents immediately after the target field.
 
Properties field Available to: All players
Allows you to manipulate the properties of the target field. You may only edit a field if you have edit rights for it. This is the default action if you click on a field that is not a sheet.
 
Remove chat_croup player Available to: Chat group owner
Removes a player from a chat group.
 
Rename name Available to: All players
Sets your chat name.
 
roll dice_notation Available to: All players
Rolls dice. See the Dice chapter for a detailed explaination of dice notations.
 
Save sheet / Workspace Available to: All players
Saves a copy of the sheet locally on your computer.
 
Say message Available to: All players
Broadcasts your messagein the chat box to everyone in the active chat group with your text color.
 
Settings Available to: All players
Displays the current game settings. The GM may use this command to set any game setting, such as game name and description (for display on the BYOND hub), game password, and even the background color or the chat box.
 
Tell chat_group message Available to: Chat group owner
Sends the message to the members of the chat group.
 
Whisper player message Available to: All players
Sends the message privately to the targeted player.
 
Who Available to: All players
Lists all the players in the game and their current status (host, GM, mute, banned). This is the same as the Players list in the Game statpanel, but will be recorded in the log file if you are logging the chat.
For the host and GM, who also lists the player's key name and IP address.
 

BTG News | BTG Introduction | BTG Manual Table of Contents | BTG Resource Files

BYOND Shadowdarke's Realms BYOND

       
BYOND Tabletop Gaming
 
N
e
w
s
 
 
I
n
t
r
o
 
 
M
a
n
u
a
l
 
 
F
i
l
e
s