Difference between revisions of "Popmenu (Slash Command)"

Revision as of 04:36, 12 June 2009

SlashCommand

/popmenu menuname

This command opens a custom pop-up menu by menuname at the current cursor's location.

Directory

Custom pop-up menu files are read from the following directory:

<COH_INSTALL_DIRECTORY>\data\texts\<LANGUAGE>\Menus\

<LANGUAGE> may be one of the following and needs to match the language of the version of City of Heroes that is installed:

• ChineseTraditional
• English
• French
• German
• Japanese
• Korean
• uk

City of Heroes looks in this directory for files with the .mnu file extension. If none are found, it uses the internal default quickchat menu. If there is a customized quickchat.mnu file found, that will be used in place of the internal default when you click the "Quick Chat" button. You can place multiple files with the extension .mnu in this directory and they will be available for use with the popmenu command.

Syntax

MNU files can be edited in any text editor. Menus have the following general structure:

Menu MenuName
{
    Title TitleName
    Option OptionName Command
    Divider
    Title TitleName
    Option OptionName Command
    Menu SubMenuName
    {
        Title SubMenuTitleName
        Option OptionName Command
        Divider
        Option OptionName Command
    }
}

• Menu defines a group of Options. Menus can be nested, but each sub-menu requires its own pair of curly braces.
  • MenuName is the name of the menu opened by the /popmenu menu name slash command.
  • To create a menu name of more than one word with spaces between them, enclose it in quotes.
• Option is a selectable command within a menu.
  • One letter in OptionName can be designated as a hotkey by prefixing an ampersand (&).
  • To create an option name of more than one word with spaces between them, enclose it in quotes.
  • Command is one or more slash commands (separated by $$).
• Title is an optional element.
  • TitleName labels a menu, or a section of a menu. Titles are not selectable.
  • Menus can have more than one Title.
• Divider places a horizontal line in the menu.

Notes

• The popmenu command is called using the top-level "Menu" name inside the Menu (.mnu) file and NOT the name of the Menu (.mnu) file itself. The filename does not matter and does not even have to match the "Menu" name as long as it has the .mnu file extension.
• MNU files allow comments. Use a double forward slash (//) anywhere on a line to force the client to ignore anything between the double slash and the line return.
• IMPORTANT: MNU files must have at least one line containing a carriage-return at the end of the line above the first "Menu" entry. It can be blank, a full comment, or just the comment tag (//) or any number of those lines otherwise it will not function.
• Changes to custom menus require you to exit the client in order for the changes to take effect.
• Custom menus are accessible by all characters on the same machine. By extension, you can send custom menu files to other people so that they can use them as well.
• Option and its parameters must be on one line. Otherwise, the menu will not function.
  • Inspiration and power names with spaces can be used in commands by replacing the spaces with an underscore (for example, Catch_a_Breath). You can also enclose the entire Command portion in quotation marks.
  • Multiple Commands can be executed by one Option by joining them with $$, just as they would be on the client command line.

This article is based on Fleeting_Whisper's excellent player's guide on the forums.