The Command Console

The Console Interface

The command console was designed to be a middle ground between accessibility and usability, so you may need some time to get use to it.

Here is what each section does:

1. The search bar with your fellow MonKey! You do not need to click on the search bar: as soon as you open the console you can start typing
2. The type of command: the speech bubble icon indicates that the command is parametric, and that you will have to enter some parameter to execute it. If the command has default values defined, pressing CTRL + ENTER will execute it with the default parameters. If you have activated the Menu Items, they will also show up here with a Unity icon (by default set to true, see Settings)
3. The Quick Name: Used to quickly find a command. Entering a Quick Name in the search bar will also find the associated command. The quick names are as close as possible to initials of the commands. However, due to the amount of commands available you will find exceptions (See Commands for all Quick Names , or Settings on how to override existing Quick Names)
4. The name of the command: the letters matching your search will be highlighted in orange here. Names are made to be as concise as possible: for more info on what the command does you have the help right under!
5. The help of the command: describes what the command does in ways that the name does not specify: when writing your commands the help can be as long as necessary, however we recommend not exceeding one line if possible to not make the command search harder
6. Some Commands will have some conditions to be executed, like requiring some objects to be selected, or the editor to be in play mode for instance. In that case, they will display the reason why they are unavailable this way.
7. The Hot Keys for the command: pressing them will execute the command without the need to open the console. If the command is parametric, hitting the Hot Keys will directly open the parameter interface.
8. In case of conflict between hotkeys, the conflicting Hot Keys will be written this way. Hovering over the command will display the name on the conflicting commands. In case the conflict comes from a menu item external to MonKey, the name of the menu item will be displayed here as well, no matter if you include menu items in the search or not (see Settings).
9. The Help Panel: will simply display contextual help for the command

Sleeping MonKey

If you use MonKey docked, it will show this way in the inspector when you are not currently using it. The look of it was designed to not be intrusive which is why the colors are dimmed down.

Simply use the Hot Key or click on the panel to bring up the console. Pressing Hot Keys for a command will of course also work while MonKey is sleeping.

By default, clicking elsewhere in the Editor will also put MonKey to sleep. It will not however reset your current search.

If you would prefer MonKey to stay awake even when you click elsewhere, you can activate this option in the Settings.

Note: We prefer to use MonKey as always awake ourselves, as it makes it convenient to select objects and apply commands on the fly. We however decided to not make it the default option as it can be intrusive: When focused, monkey prevents you front entering any text or from using any unity's hotkeys, which means that sometimes you leave it open unintentionally and can be confused as of why cannot you rename your object.

Finding A Command

To find a command, enter the name or the quick name of the command in the search field.

The search field also allows you to enter few key words, this way you do not have to enter the full name of the command you are looking for. The key words you are entering do not need to be in the order of the words in the command's name.

For instance, entering "Bet Spre" will fin the "Spread And Align Between" command.

Navigating The Commands

To select a command, you can either mouse over the command you which to execute, or presse the DOWN or UP arrow to go up or down the list of found commands. You can also scroll the view with the mouse scroll.

Once you selected a command, click on it or press ENTER to execute it.

Closing the Console

You can close the console by pressing ESCAPE, or by executing the current command by pressing ENTER, TAB, or CTRL+ENTER if the selected command is parametric.