- Joined
- Jul 22, 2014
- Messages
- 5,624
- Reaction score
- 5,104
- First Language
- English
- Primarily Uses
- RMVXA
Description of the Feature:
All "Description" fields for plugins should be Scrollable, allowing plugin makers to provide game designers with finer guidance than the mere two lines that are currently allowed.
This includes the Description fields in the following places:
Additionally, if feasible, in order to accommodate this change, a way to enter descriptions (@desc and @plugindesc) on multiple lines should be offered to plugin makers. While writing one ultra-long line would still work in a technical sense, it visually screws up the plugin's text file for anyone who wants to read it, and many plugin makers like making readable code. Perhaps multiple consecutive lines that start with @desc could be interpreted as one line by RPG Maker, or similar.
Mockup:
This shows a mockup of what a scrollable Description field would look like on the Parameter window that is part of the Plugin Settings window.
Why do we need this feature?
It makes no sense to put a stringent limit on the amount of information that a plugin designer can provide to players in places where they may need it (such as a free text entry for a specific Parameter). Just a few of the things that a plugin maker may want to communicate include:
Possible issues with this feature?
None whatsoever. There are no drawbacks for the Plugin Maker nor the Game Designer. Plugin Makers who prefer laconic descriptions can continue to write them. The technical risk for adding this feature is minimal.
All "Description" fields for plugins should be Scrollable, allowing plugin makers to provide game designers with finer guidance than the mere two lines that are currently allowed.
This includes the Description fields in the following places:
- General Settings area in the Plugin Manager's "Plugin Settings" window
- Parameter window in the Plugin Manager's "Plugin Settings" window
- Main "Plugin Command" window on the Event Editor
- Parameter window on the Event Editor
Additionally, if feasible, in order to accommodate this change, a way to enter descriptions (@desc and @plugindesc) on multiple lines should be offered to plugin makers. While writing one ultra-long line would still work in a technical sense, it visually screws up the plugin's text file for anyone who wants to read it, and many plugin makers like making readable code. Perhaps multiple consecutive lines that start with @desc could be interpreted as one line by RPG Maker, or similar.
Mockup:
This shows a mockup of what a scrollable Description field would look like on the Parameter window that is part of the Plugin Settings window.
Why do we need this feature?
It makes no sense to put a stringent limit on the amount of information that a plugin designer can provide to players in places where they may need it (such as a free text entry for a specific Parameter). Just a few of the things that a plugin maker may want to communicate include:
- The clear definition of a hard-to-understand field
- Examples of correct entries
- What values are (or aren't) valid in a numeric or text entry field, such as 0
- What values mean (e.g. what entering "true" or "false" will do)
- Valid formatting and syntax in text entry fields
- Shortcut values in, for example, the entry of Formulas
- Whether Plugin Settings values can be changed mid-game (and how to do so)
- A little extra information in the Plugin Description, without resorting to the Help File field
- Any other helpful guidance or advice
Possible issues with this feature?
None whatsoever. There are no drawbacks for the Plugin Maker nor the Game Designer. Plugin Makers who prefer laconic descriptions can continue to write them. The technical risk for adding this feature is minimal.
