The Ares Extras repository in GitHub contains various things that are not part of the main Ares release. This article tells you how to contribute your own extras.
Extras may include:
There are two ways to make a submission.
Some guidelines for the code itself:
All extras must be submitted under the AresMUSH code license.
If you have any questions, just ask for help.
Many extras will be entire plugins. In order to be compatible with the automated plugin install, the plugin must follow a particular folder structure.
Note: The automated install just copies the plugin’s files into place. If your plugin requires changes to other plugins (for example, adding steps to the Chargen config or Chargen web portal screen), you should include instructions for adding that in your README.
The folder structure for a plugin includes:
pluginfolder containing files organized into sub-folders matching the Plugin Folder Conventions (help, locales, etc.)
webportalfolder containing files organized into sub-folders matching the web portal’s
appfolder (templates, components, etc.)
gamefolder containing files organized into sub-folders matching the aresmush
gamefolder (config, text, etc.)
Note: All folders are optional, so just omit any that don’t apply to your plugin.
Coders may also submit patches to the main Ares codebase for bugfixes and/or new features. However, be advised that Faraday is pretty picky about what code goes into the main repository. Most new features are probably better off as extras.