AresMUSH
A New Breed of MUSH Server

Extras

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

“Extras” are various things that are not part of the main Ares release. There are tinker snippets, community-authored plugins, and other tidbits.

Finding Extras

You can find extras in the Ares Extras repository in GitHub. The main README will direct you to what plugins are available.

Each plugin will contain its own README file with instructions on how you use it.

Installing Plugins

You can install a plugin directly from the game using plugin/install <name>.

Installing Themes

You can easily install new themes for your web portal by using theme/install <theme name>. To restore to the default theme, use theme/install default.

Updating Plugins

As long as you haven’t modified the plugin’s source code, you can upgrade it just by using the plugin/install <name> script again. This will replace the code files with the newest ones. Your configuration will not be affected. The release notes will tell you if you need to make any additional config or code changes by hand after the upgrade.

Warning: Do not attempt to run the upgrade script if you’ve got custom code modifications. You’ll have to do the upgrade by hand. GitHub’s version compare tools can help you figure out what changed. Feel free to ask for help.

Uninstalling Plugins

Unfortunately due to the way the database code works, uninstalling a plugin is not as straightforward as installing one. You have to:

  1. Remove the database fields and any associated database objects.
  2. Unload the plugin using the in-game command unload <plugin name>.
  3. Remove the code files. You may remove the config files too, but you don’t have to.
  4. Remove the plugin from the extras list in the plugins.yml config file.

If you’re not sure how to do this and need help, just ask.

Contributions

See Submitting Contributions if you want to contribute your own extras or community plugins.