Mods that add custom chat commands allow you to affect the game, trigger mod features, toggle settings, and more depending on the mod. This page contains information on how chat commands work as a mod user, how to get help information for commands, and what commands come built-in with TR Tools.
To enter a chat command, press ‘/’ on your keyboard. This will open the chat and input a ‘/’ to start you off. After the slash you'll type the mod's chat trigger, the command, and any arguments, each separated by a space.
A chat trigger is a short (usually only a few letters) word or acronym used to trigger any commands relating to a mod. All TR Tools commands, for instance, use the chat trigger ‘tr’, and so any command contained in this mod will start with ‘/tr’.
If two mods use the same chat trigger, this can cause conflicts. If you try to use a command and are given an error, you can open the config file for the conflicting mods and change on of their trigger's to anything you want (with no spaces).
A command is a word or phrase (with no spaces) that is used to tell a mod to do something specific. What commands are available depends on the mod creators since each command needs to be created individually. There must be a space between the trigger and command. For example, one of the TR Tools commands is ‘list_licenses’ to list all custom licenses added by mods you have. To run this, you'd enter ‘/tr list_licenses’.
You can see what commands are available for a specific trigger by using the command ‘help’ after the trigger. For example, to see what commands are included in TR Tools, you'd run the command ‘/tr help'.
Some chat commands (such as the /tr list_licenses command) do not require any arguments and can be entered without them. Other commands, however, require specific arguments to work properly. In these cases, you follow the command with each argument separated by spaces. For example, the ‘unlock_license’ command for TR Tools unlocks a licenses, but it needs to know the name of the license in order to unlock it. So, you'd write it as ‘/tr unlock_license example_license_1’.
There are a few ways to get more information about chat commands; each is explained below:
| /help | Will give you general information on how to use chat commands. |
| /tr help | [Where ‘tr’ is replaced by the chat trigger you want information about.] Will give you a list of commands available for a specific chat trigger. If multiple mods use the same trigger, it will list the commands regardless of which mod added it. |
| /tr help command_name | [Where ‘tr’ is replaced by the chat trigger you want information about, and ‘command_name’ is the name of the command you want information about.] Gives you detailed information about a particular command for a particular trigger. It will give you the help description provided by the mod creator, as well as an example of the command in use with the names of each expected argument in brackets. If multiple mods use the same command and trigger, then information will provided for each mod's command. |
| /tr list_licenses | Lists the license ID for each license added by a mod that you have installed. |
| /tr unlock_license [License ID] | Unlocks the max level of any license added by a mod. The ‘License ID’ should match the ID given by the ‘/tr list_licenses’ command. |
| /tr list_items | Lists the unique custom item ID for each item added by a mod that you have installed. |
| /tr give_item [Custom Item ID] [Quantity] | Gives you any number of any item added by a mod that you have installed. The ‘Custom Item ID’ should match the ID given by the ‘/tr list_items’ command. If left blank, the ‘Quantity’ will default to 1. |
TR Tools also adds a couple changes to make using chat commands easier.