dreadnought/README.md
Zach Dziura f3d2c96f36 v1.0
Everything is now feature complete. It's done!
2016-02-04 23:00:23 -05:00

28 lines
No EOL
859 B
Markdown

Dreadnought
===========
An automated aetherhunting system for Lusternia, written in Lua for the Mudlet client.
Installation
----------
1. Download the latest release and extract it somewhere in your computer.
2. Within the project's root directory, create a ZIP archive of the included `Dreadnought` directory.
3. Open Mudlet and import the newly created ZIP archive using the built-in package manager.
Updating
--------
1. Open up Mudlet's Package Manager.
2. Select the `Dreadnought` package and click Uninstall.
3. 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.