Console Command Documentation

[Craig]

This topic will document each console command. You can also view this documentation in the console via the help command.

Full Command List:

cls: Clear the console screen.
cmd: Execute a cmd file.
console: Adjust console settings.
exit: Exit the console.
help: Display help information.
inv: Current player inventory.
kill: Kill players or mobs.
list: List various game information.
msg: Send a text message.
notify: Add a notification.
player: Change the current player.
script: Execute an existing script or single command.
tp: Current players teleports.

[Craig]

.

[Craig]

help: Display help information.

help [command]

[command]  -- Enter a command to view full help for that command.
              Omit command to view brief help for all commands.

Examples:
help  -- display a list of all commands with a brief description of each.
help kill  -- display full help information for the kill command.

[Craig]

console: Adjust the position or size of the console window.

console -fs -o -p -s [scale] [lines] [x] [y]

-fs [scale] -- Adjust the scale used to draw the console font. 0.75 = default.

-o [lines]  -- Set how many lines of text are kept in the console output stream before they are dropped off the end. The default is 1000.

-p [x] [y]  -- Adjust the position of the console window.
               x & y is the new screen position in pixels.

-s [x] [y]  -- Adjust the size of the console window.
               x & y is the new size in columns and rows.

Examples:
console -p 20 50  -- changes the console screen position to 20 pixels across and 50 pixels down.
console -s 30 20  -- changes the console size to 30 characters wide and 20 rows high.
console -fs 0.5   -- makes the console font smaller.
console -o 500    -- set the consoles output stream size to 500 lines.

[Craig]

exit: Exit (close) the console window.

exit

[Craig]

player: Change the current player. Certain commands act on the current player.

player [name]

[name]  -- The name of the player to set as the current.
           Omit to change back to the original player who opened the console.

Examples:
player  -- changes the current player to the original player that opened the console.
player john10  -- changes the current player to john10.

[Craig]

tp: Teleport the current player or manipulate teleport points.

tp -a -r -ra [name]

-a   -- Add a teleport point for the current player (where the current player is currently standing).
-r   -- Remove the named teleport point for the current player.
-ra  -- Remove all teleport points from the current player.
[name]  -- Name of the teleport point or map marker.

Examples:
tp home  -- teleport the current player to the teleport point or map marker named 'home'.
tp -a home  -- add the teleport point 'home' to the current player.
tp -r home  -- remove the teleport point 'home' for the current player.
tp -ra  -- remove all teleport points from the current player.

[Craig]

inv: Manipulate the current players inventory.

inv -a -e -r -ra [item] [qty]

-a   -- Add the item to inventory. If [qty] is omitted, the items default stack size will be added. If no other -args are used, -a is assumed.
-e   -- Equip the item. Optional. Can be used in conjunction with -a.
-r   -- Remove the item from inventory. If [qty] is omitted, all stacks of the item will be removed.
-ra  -- Remove all items.
[item]  -- The item to add/remove/equip/list.
[qty]  -- The number of units.

Examples:
inv grass  -- add a stack of grass (-a assumed).
inv -a -e dirt 50  -- add 50 dirt and equip.
inv -e dirt  -- equip dirt if in inventory.
inv -r dirt  -- remove all stacks of dirt.
inv -r dirt 50  -- remove 50 dirt.
inv -ra  -- remove all items.

[Craig]

notify: Add a notification to top left of screen.

notify -a -c -g -l -r [message]

-a  -- Notification appears on the screen for admins.
-c  -- Notification appears on the screen for all members of the current players clan.
-g  -- Notification appears on the screen for all gamers (default).
-l  -- Notification only appears on your screen (local).
-r  -- Notification appears on the screen for all remote gamers, but not yours.
[message]  -- The notification text. Surround the message with double quotes if it contains spaces.

Example:
notify ""hello everyone""
notify -g ""hello everyone""
The notification appears on every gamers screen.

notify -a ""meeting time""
The notification appears only on admin screens.

[Craig]

script: Execute an existing script or single script command.

script -c -s [command|script]

-c  -- Run a single script command.
-s  -- Run a script (default switch, can be omitted).
[command] -- A single command to run.
[script]  -- A full script name to run, including folders.

Examples:
script Events\PlayerJoined
script -s Events\PlayerJoined
Runs the script called Events\PlayerJoined.

script -c notify [hello [gamertag]]
Runs the single script command: notify [hello [gamertag]]

[Craig]

msg: Send a text message to other players.

msg -a [player] [message]

-a  -- Send message only to players with admin permission.
[player] - Send private message to named player.
[message] - The message text. surround with double quotes for messages that contain spaces.

example:
msg ""Hello everyone""
Send the msg ""Hello everyone"" to all players in the world.

msg -a ""some important secret message""
Send the message only to admins.

example:
msg hellosailor Ahoy!
Send the message ""Ahoy!"" to the gamer named hellosailor.

[Craig]

cls: Clear the console screen and output stream.

cls

[Craig]

kill: Kill the current player, all NPCs or all NPCs of a type.

kill -a -p [npctype]

-a  -- kill all NPCs.
-p  -- kill the current player
[npctype]  -- kill all NPCs of this type.

Examples:
kill -a  -- this will kill all NPCs.
kill -p  -- this will kill the current player.
kill goblin  -- this will kill all goblins.

[Craig]

list: List various game information.

list -i -m -p -pe -s -tp -z [pattern]

-i   -- list all items in the current players inventory.
-m   -- list map markers.
-mg  -- list map grave markers.
-p   -- list all players in the world.
-pe  -- list the current players permissions.
-s   -- list scripts.
-tp  -- list the current players teleport points.
-z   -- list zones.

[pattern] -- any output that does not start with pattern is ignored.
             e.g. list -i sa  -- list all items in inventory that start with 'sa'
                  list -p j  -- list all players whose name starts with 'j'

[Craig]

cmd: Execute all the console commands in a cmd file.

cmd [name] [args]

[name] -- The name of the command file. This will be a *.cmd file residing in the maps save folder on disk. You can create these files using any text editor.
[args] -- Optional arguments that can be passed to the commands inside the command file.

Example:
cmd crates -- This will run all the console commands in the crates.cmd file found in the maps save folder.
crates -- This will also run all the console commands in the crates.cmd file found in the maps save folder.

Note: cmd is only necessary if the name of the .cmd file conflicts with an existing console command name. For crates, because there is no crates console command, you can just type crates without the preceding cmd, and the crates.cmd file will be executed.

Argument substitution is possible with cmd files, similar to MSDOS batch files. If the command in the cmd file uses %n (where n is a number starting from 1) as an argument, then the corresponding argument passed with the cmd command will be substituted for the %n argument in the cmd file.

Example:
If we have a cmd file named welcome.cmd with the following commands:
notify %1
notify %2

Then the following are examples of the output:

cmd welcome hello everyone
notify hello
notify everyone

cmd welcome hello john
notify hello
notify john

cmd welcome sup dawg
notify sup
notify dawg