RME
RME copied to clipboard
[RME] Serialization of commands' documentation
Definition of commands' documentation as used by Forge (or any other documentation parser)
Structures' contract which defines what should be produce by RME in order to be consumed by Forge.
Why "by forge" ? Forge is a package manager
Summing-up what has been privately discussed with @xvw:
- Commands can be nested only in one sub-level (which will furtherly be denoted as sections) under
RME::Command. It actually means the following:-
Authorized: {
RME::Command::Event,RME::Command::Map,RME::Command::Camera...} -
Unauthorized:
RME::Command::Event::Movement
-
Authorized: {
- Documentation will be generated as follow:
-
{{section_name}}.json: section's description and the list of commands declared under it -
{{section_name}}/{{command_name}}.json: directory which contains the commands nested under the section (one.jsonfile per command)
-