“Extras” are various things that are not part of the main Ares release: themes, plugins, and other tidbits. Some extras are created by the community, others are just extra things that are not included by default.
Table of Contents
You can find most extras in the Ares Extras repository in GitHub. The main README will direct you to what plugins are available.
Each plugin or theme will contain its own README file with instructions on how you use it.
You can install a plugin directly from the game using plugin/install <github url>. For example: plugin/install https://github.com/AresMUSH/ares-prefs-plugin.
You can easily install new themes for your web portal by using theme/install <github url>. For example: theme/install https://github.com/AresMUSH/ares-dark-theme.
To restore to the default theme, use theme/install default.
As long as you haven’t modified the plugin’s source code, you can upgrade it just by using the plugin/install <github url> 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. You could even make your own ‘fork’ of the extra repo to manage your code changes and take advantage of GitHub’s merging features. Feel free to ask for help.
Unfortunately due to the way the database code works, uninstalling a plugin is not as straightforward as installing one. You have to manually:
unload <plugin name>.plugins.yml config file.If you’re not sure how to do this and need help, just ask.
See Submitting Contributions if you want to contribute your own extras or plugins.