A New Breed of MUSH Server

Submitting Contributions

  • [code]
  • [plugins]
  • [extras]

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:

  • Complete stand-alone Plugins.
  • Snippets of code and/or other files to show somebody how to implement something.
  • Theme styles for the web portal.
  • Configuration settings (e.g. a medieval FS3 setup).
  • Basically anything else you think might be useful to the Ares community.

Submitting Extras

There are two ways to make a submission.

  1. Send the files directly.
  2. Fork the Ares Extras repository and submit a GitHub Pull Request.

Some important notes:

  • Include a file with an overview of the extra and what configuration options are available. Be sure to give yourself credit in the README.
  • All extras must be submitted under the same code license as Ares itself.
  • Make your code clean and readable. Basically, if nobody can make heads or tails of your code, it won’t make the cut.

If you have any questions, just ask for help.

Submitting Plugins

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:

  • A plugin folder containing files organized into sub-folders matching the Plugin Folder Conventions (help, locales, etc.)
  • A webportal folder containing files organized into sub-folders matching the web portal’s app folder (templates, components, etc.)
  • A game folder containing files organized into sub-folders matching the aresmush game folder (config, text, etc.)
  • A file explaining what the plugin does and how to use it. You can find a template here.
  • The installer ignores any other folders, so you can use them for examples, documentation, or whatever you want.

For example:

Submitting Themes

You can submit a web portal theme. The folder structure for a theme includes:

  • A styles folder with custom_style.scss and colors.scss.
  • An optional images folder with the theme images needed by the portal. You can supply all, any, or none of the images.

Submitting Patches

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.