diff --git a/README b/README new file mode 100644 index 0000000..fe8b6e6 --- /dev/null +++ b/README @@ -0,0 +1,133 @@ + +Summary +======= + +The aard_inventory.xml file is a MUSHclient plugin for the Aardwolf mud. +See the wiki for instructions on installing the plugin. + + +Aard Inventory Manager +====================== + +This plugin manages your inventory and gives you tools to analyze and use +items in your inventory. + +The first step you'll need to take is to find an out-of-the-way room where +you won't disturb anyone and then run "dinv build confirm". This step +will identify all items you are wearing, all items in your main inventory, +and all items in containers in your inventory. This will take roughly 5 +minutes depending on how many items are in your inventory. If you need to +halt the build simply go to sleep or go AFK. You can "refresh" your +inventory later to complete the process of identifying everything you are +carrying. + +Once you have a completed inventory table available, I recommend making a +manual backup in case something goes wrong in the future. You can restore +from the backup and avoid the long build process again. If anything in +your inventory has changed since the backup, your next refresh will simply +update it to what you currently have. To make a manual backup named +"my_first_awesome_backup" type "dinv backup create my_first_awesome_backup". +See "dinv help backup" for more details about creating, viewing, and restoring +backups. + +Type "dinv help" for all available usage options. For detailed examples of +how to use each option, simply type "dinv help