dreadnought/README.md

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

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

Installation
----------

1. Click on the `releases` button above and download the latest `Source Code (zip)` file for the latest Dreadnought release.
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.
Added initial files Still need to update the documentation... 2016-01-12 16:04:18 -05:00			`Dreadnought`
			`===========`

v1.0 Everything is now feature complete. It's done! 2016-02-04 23:00:23 -05:00			`An automated aetherhunting system for Lusternia, written in Lua for the Mudlet client.`
Added initial files Still need to update the documentation... 2016-01-12 16:04:18 -05:00
v1.0 Everything is now feature complete. It's done! 2016-02-04 23:00:23 -05:00			`Installation`
Added initial files Still need to update the documentation... 2016-01-12 16:04:18 -05:00			`----------`

Numerous Empathing and Siphoning enhancements Siphoners will now call out a maximum of 5 times that they’re exhausted, rather than spamming the hell out of the ship. Also, as long as the empath is able to cast Clarity, whenever the ship is shockwaved, the empath will now clarity the chair so they can make their escape. Plus, several documentation fixes and additions, such as clarifying the README a bit and adding in the Collector documentation. 2016-02-17 01:10:07 -05:00			1. Click on the `releases` button above and download the latest `Source Code (zip)` file for the latest Dreadnought release.
			`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.
v2.0 Lots and lots of changes in this release! The Combateer subsystem has been totally fixed, with the proper parameters actually being passed to the fireTurret() function. Various bug fixes all around as well, especially pertaining to gathering Aethercraft skills and the like. The big breaking change is the removal of the GM alias from the Empathing subsystem. Empaths now should use GR, for "Grid Repair". GR will, by default, only repair modules that are occupied. GR ALL to repair all modules on the ship. 2016-03-01 23:38:00 -05:00			`6. Restart Mudlet to make sure all variables are instantiated properly.`
Added initial files Still need to update the documentation... 2016-01-12 16:04:18 -05:00
			`Updating`
			`--------`

v1.0 Everything is now feature complete. It's done! 2016-02-04 23:00:23 -05:00			`1. Open up Mudlet's Package Manager.`
Numerous Empathing and Siphoning enhancements Siphoners will now call out a maximum of 5 times that they’re exhausted, rather than spamming the hell out of the ship. Also, as long as the empath is able to cast Clarity, whenever the ship is shockwaved, the empath will now clarity the chair so they can make their escape. Plus, several documentation fixes and additions, such as clarifying the README a bit and adding in the Collector documentation. 2016-02-17 01:10:07 -05:00			2. Select the `Dreadnought` package and click `Uninstall`.
v2.0 Lots and lots of changes in this release! The Combateer subsystem has been totally fixed, with the proper parameters actually being passed to the fireTurret() function. Various bug fixes all around as well, especially pertaining to gathering Aethercraft skills and the like. The big breaking change is the removal of the GM alias from the Empathing subsystem. Empaths now should use GR, for "Grid Repair". GR will, by default, only repair modules that are occupied. GR ALL to repair all modules on the ship. 2016-03-01 23:38:00 -05:00			`3. Restart Mudlet to clear out all existing variables.`
			`4. See the above Installation instructions.`
Added initial files Still need to update the documentation... 2016-01-12 16:04:18 -05:00
			`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.`