- Joined
- Mar 22, 2020
- Messages
- 277
- Reaction score
- 276
- First Language
- English
- Primarily Uses
- RMMV
And/or script call list. Specifically, for a plugin that has a lot of commands/script calls, many of which may require more than a couple lines of explanation for usage. As a plugin USER (not creator), please choose any and all characteristics of such plugins' help sections that you feel grant optimal 1) readability, and 2) ease of finding commands/script calls for particular needs.
Discussion is also welcome and encouraged!
Explanation of Options:

Thanks for participating!!
Discussion is also welcome and encouraged!
Explanation of Options:
- Organized by similar function - For example, data-changing (e.g. "set" or "clear") functions are grouped together vs. data-retrieving (e.g. "get") functions, vs. direct effect (e.g. screen effects, animations, changing opacity, etc.) functions, etc.
- Organized by similar feature - For example, all data-changing, data-retrieving, direct effect, and other functions pertaining to a plugin's calendar feature are grouped together vs. all functions pertaining to its clock feature.
- Organized by usefulness - Plugin commands/script calls deemed less potentially useful are listed toward the bottom or in an other/miscellaneous section, regardless of groupings as described above.
- Extensive explanations alongside command - Entire explanation is provided with its respective plugin command/script call, regardless of how long or in-depth it is.
- Extensive explanations elsewhere in help section - Especially long or in-depth plugin command/script call explanations are provided in a separate subsection from the master list (latter of which may still include brief descriptions).
- Extensive explanations elaborated in separate help file or webpage - Especially long or in-depth plugin command/script call explanations are elaborated upon somewhere outside of the plugin/RPG Maker (master list in plugin help section may still include brief descriptions).
- Examples alongside command - Examples of usage are provided alongside the plugin command/script call and description.
- Examples elsewhere - Examples of plugin command/script call usage are provided either elsewhere in the help section, or in a separate instructional/help file or webpage.
- More compact - Less negative space in formatting (e.g. indents, line breaks, dividers, etc.), making it faster to scroll through and scan more information at once, but possibly decreasing readability.
- More spaced - More negative space in formatting, making it easier to read and identify information at a glance, but possibly visually bloating the help section.
Thanks for participating!!