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 important notes:
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.
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.)
README.mdfile explaining what the plugin does and how to use it. You can find a template here.
You can submit a web portal theme. The folder structure for a theme includes:
imagesfolder with the theme images needed by the portal. You can supply all, any, or none of the images.
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.