Finally fixed the Clarity spam bug

Hopefully for good this time!

Dreadnought/config.lua

@@ -1 +0,0 @@
-mpackage = "Dreadnought"

README.md

@@ -1,22 +1,26 @@
 Dreadnought
 ===========
 
-An automated aetherhunting system for the Mudlet MUD client, specifically for the game Lusternia.
+An automated aetherhunting system for Lusternia, written in Lua for the Mudlet client.
 
-Synopsis
---------
-
-Dreadnought is a spiritual successor to the popular Windmills aetherhunting system, seeking to be as compatible as possible (while only breaking compatibility when necessary). As much as possible, Dreadnought tries to automate automate tasks in such a way as not to require someone calling out for commands.
-
-Installing
+Installation
 ----------
 
-Download the latest Release ZIP file and install it through Mudlet's Package window. Unzip it, then navigate to the top-level of the repository. Zip up the included `Dreadnought` directory, then install that ZIP file through Mudlet's Package window.
+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
 --------
 
-Unfortunately, because Mudlet doesn't make updating packages easy, you'll have to uninstall the previous version of Dreadnought before installing the updated version.
+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
 -------------

docs/Collector.md

@@ -0,0 +1,9 @@
+Collector
+=========
+
+The collector has the easiest set of commands to use: there's only one! The collector can be toggled between two modes: `Auto`, which will automatically siphon from a vortex should one appear in view; and `Call` which will siphon once for every time someone announced `"Siphon"` on the ship aether.
+
+Commands
+--------
+
+- `smode <call|auto|off>` - Toggles the siphoning mode, or turns siphoning off completely.

docs/Combateer.md

@@ -0,0 +1,14 @@
+Combateer
+=========
+
+The combateer has two different modes: callout and auto, with the difference being how the system acquires targets. In callout mode, the Captain will automatically call out the target and the system will pick it up. Auto mode, on the other hand, will automatically acquire and fire upon targets.
+
+Once you lock into the turret, the turretting mode is automatically set to `call`ing mode. See below for the exact commands to switch turretting modes.
+
+It's important to note that the combateer system will automatically target karibideans when they arrive.
+
+Commands
+--------
+
+- `tmode <call|auto|off>` - Toggles the current targetting mode, or turns targetting off completely.
+- `ttar <target>` - Manually target an aetherbeast.

docs/Empath.md

@@ -0,0 +1,16 @@
+Empath
+======
+
+Much of the magic behind the empathing system takes place automatically, without any intervention needed from the user. However, the core functionality is still accessible through user commands.
+
+Commands
+--------
+
+ - `gr [all|reset]` - By default, will check and repair any damaged modules as long as they're occupied by someone. Passing in the `all` parameter will repair all modules on the ship, regardless if they're occupied.
+ - `gsliv` - Will check for any slivven infecting the ship and announce their presence upon the ship's aether.
+ - `gc` - Will clarity the command chair at the next available opportunity.
+ 
+ Crew Commands
+ -------------
+ 
+ If you're a crew-member, you can trigger the Empath to repair the entire ship by calling out `Repair` on the Ship Aether.

docs/Pilot.md

@@ -0,0 +1,48 @@
+Pilot
+=====
+
+The signature feature of Dreadnought's piloting capabilities is its autopilot system, which allows the user to create a custom path for the aethership to follow. No longer are you required to place shockwaves East and Northeast of the Vortex; you can put them anywhere, and the autopilot will be able to handle it!
+
+Commands
+--------
+
+ - `pauto <on|off>` - Toggles the autopilot on and off
+ - `pcall <on|off>` - Toggles siphon callout on or off. If enabled, the pilot will call out to siphon when sailing over a vortex.
+ - `ppath <dir1> <dir2> <dir3>` - Creates the path that the autopilot will follow when hunting.
+
+Pathing
+-------
+
+While it can be a bit confusing to think about at first, the autopilot's pathing command is fairly easy to understand. Say you have your shockwaves arranged in the following fashion:
+
+```
+      [*]
+    /  |
+[O] - [*]
+```
+
+where the 'O' is the vortex and the *'s are the shockwaves. Each tile has its own position number: the vortex is ALWAYS Position 1, followed by the first shockwave being Position 2 (in this case, the northeast shockwave), and Position 3 is the east shockwave. When summoning aetherbeasts, you want to travel northeast to Position 2, then south to Position 3. Thus, type the following command: `ppath ne s w`. The pathing system will automatically figure out how to travel back-and-forth between Positions 2 and 3, with the final direction entered being how to get back to Position 1 from Position 3.
+
+Movement
+--------
+
+Steering is as simple as entering `n`, `ne`, etc, just as you normally do when walking. Gliding is that same directional command, just repeated. So to glide north you would enter `nn`, northeast would be `nene`, etc. 
+
+If you ever manually steer the ship, autopilot will automatically be disabled. This is helpful should you ever need to escape from an enemy ship or aetherbeat.
+
+Clarity
+-------
+
+`pc` to call out for a Clarity, `pce` to call out for an Emergency Clarity.
+
+What's the difference? Functionally, nothing. A clarity's a clarity! But how it's placed in the Empath's queue is an entirely different story. An Emergency Clarity should only be for that: an emergency. If you're stuck and have to get away, etc. Otherwise, a regular clarity will do just fine!
+
+Calling Targets
+---------------
+
+Sometimes you want to call out to your Combateers that there's a rogue aetherbeast flying around that needs to die. Easy! `ptar <target>`, and you'll announce on the ship's aether to target whichever beast you called out for.
+
+Other Commands
+--------------
+
+All of the relevant commands can be found within the `Aliases` section of the scripting interface. There are too many to list here, so you'll have to figure the rest of them out for yourself!