dreadnought/README.md

Dreadnought
===========

An automated aetherhunting system for Lusternia, written in Lua for the Mudlet client.

Installation
----------

0. Make sure that the GMCP is enabled before installing. You can double-check by clicking on the `Settings` button within Mudlet, and within the `General` tab there is a checkbox to "Enable GMCP". If not checked off, check that box, click "Save", then restart Mudlet.
1. Click on the green button above labeled `Clone or download`. From the dropdown that appears, click `Download ZIP`.
2. Extract the zip file somewhere on your computer (such as your Downloads folder).
3. Open Mudlet. On the Menu Bar, click on `Package Manager`.
4. Click on `Install`, navigate to the folder where you extracted the zip file, and select the `Dreadnought.xml` file.
5. Click `OK` to close the Package Manager window.
6. Restart Mudlet to make sure all variables are instantiated properly.

Updating
--------

1. Open up Mudlet's Package Manager.
2. Select the `Dreadnought` package and click `Uninstall`.
3. Restart Mudlet to clear out all existing variables.
4. See the above Installation instructions.

Documentation
-------------

Each of the four main aetherhunting roles has its own document detailing how to use the proper commands. You can find them within the [docs/](./docs/) directory within this repository.

License
-------

Dreadnought is dual-licensed under the Unlicense/MIT licenses.