Updated README usage and release notes for v2.0019

master
Durel 7 years ago
parent b242d9264a
commit 3248cd31f9

@ -38,9 +38,9 @@ Usage
===== =====
Inventory table access Inventory table access
dinv build [confirm] dinv build confirm
dinv refresh [on | off | all] <minutes> dinv refresh [on | off | eager | all] <minutes>
dinv search [id | full] <query> dinv search [objid | full] <query>
Item management Item management
dinv get <query> dinv get <query>
@ -51,8 +51,9 @@ Usage
Equipment sets Equipment sets
dinv set [display | wear] <priority name> <level> dinv set [display | wear] <priority name> <level>
dinv weapon [next | <priority> <damType list>]
dinv snapshot [create | delete | list | display | wear] <snapshot name> dinv snapshot [create | delete | list | display | wear] <snapshot name>
dinv priority [list | display | compare] <priority name 1> <priority name 2> dinv priority [list | display | create | clone | delete | edit | copy | paste | compare] <name 1> <name 2>
Equipment analysis Equipment analysis
dinv analyze [list | create | delete | display] <priority name> <positions> dinv analyze [list | create | delete | display] <priority name> <positions>
@ -65,7 +66,7 @@ Usage
dinv reset [list | confirm] <module names | all> dinv reset [list | confirm] <module names | all>
dinv forget <query> dinv forget <query>
dinv notify [none | light | standard | all] dinv notify [none | light | standard | all]
dinv cache [reset | size] [recent | frequent | all] <# entries> dinv cache [reset | size] [recent | frequent | custom | all] <# entries>
dinv tags <names | all> [on | off] dinv tags <names | all> [on | off]
dinv reload dinv reload
@ -75,61 +76,51 @@ Usage
dinv pass <pass ID> <# of seconds> dinv pass <pass ID> <# of seconds>
Plugin info Plugin info
dinv version dinv version [check | changelog | update confirm]
dinv update confirm
dinv help <command> dinv help <command>
Release Notes Release Notes
============= =============
1) There currently is no mechanism to change stat prioritization other than manually modifying the 1) If you give an item to an enchanter to boost the item's stats, you may pull the old stats from a
plugin. This is high on the list of new features and a GUI supporting this will hopefully be
coming in the future.
2) If you give an item to an enchanter to boost the item's stats, you may pull the old stats from a
cache instead of using the new enchantments when you get the item back. In this case, you may use cache instead of using the new enchantments when you get the item back. In this case, you may use
the "dinv forget <query>" option to remove that item from your inventory table and its related caches. the "dinv forget <query>" option to remove that item from your inventory table and its related caches.
The next inventory refresh will pick up the new stats for the item. The next inventory refresh will pick up the new stats for the item.
3) Most aard operations that modify an item's stats are detected and automatically trigger a 2) Most aard operations that modify an item's stats are detected and automatically trigger a
re-identification. For example, enchantment spells, sharpening, reinforcing, tpenchanting, and wset re-identification. For example, enchantment spells, sharpening, reinforcing, tpenchanting, and wset
all are handled transparently. The one known exception is the setweight command which is not all are handled transparently. There are two known exceptions to this. First, the setweight
currently handled by aard's invitem system. Until this is changed (or until we include a trigger command does not result in an invitem update from aard's invitem system. Second, scribing a scroll
watching for setweight) you will need to use the "dinv forget <query>" option on an item that changes does not trigger an invitem update. As a result, until this is changed on aard's side of things
weight in order to "forget" the old stats and then pick up the correct weight (and other stats) on (or we manually add triggers in the plugin to watch for setweight and scribing) you will need to use
the next inventory refresh. the "dinv forget <query>" option on an item that changes weight or a scroll that is scribed. This
will cause the plugin to "forget" the existing data on the item so that the new information will be
4) Wands and staves are not re-identified as they are used. As a result, the number of charges picked up on the next inventory refresh.
3) Wands and staves are not re-identified as they are used. As a result, the number of charges
shown in the item's display may not match reality as the item is used. If this mode is not added shown in the item's display may not match reality as the item is used. If this mode is not added
to the aard invitem system, we may need to add a trigger to watch for this and update charges to the aard invitem system, we may need to add a trigger to watch for this and update charges
accordingly. accordingly.
5) The plugin does not automatically open containers that are closed. As a result, you won't be able 4) The plugin does not automatically open containers that are closed. As a result, you won't be able
to get/put items in a closed container. Keep your containers open! :) to get/put items in a closed container. Keep your containers open! :)
6) If you add a keyword to an item, drop it, and then pick it back up, the new keyword will still 5) If the plugin tags are enabled, they will echo an end tag at the conclusion of an operation. However,
be available on the item if it is still in your cache. However, this is not the case for common
consumable items. For example, we treat all duff beer potions as being identical so that you don't
need to individually identify each potion. As a result, the cached versions of those common items
won't maintain custom keywords.
7) If the plugin tags are enabled, they will echo an end tag at the conclusion of an operation. However,
if the user goes into a state that doesn't allow echoing (e.g., AFK) then the plugin cannot report the if the user goes into a state that doesn't allow echoing (e.g., AFK) then the plugin cannot report the
end tag. In this scenario, the plugin will notify the user about the end tag via a warning notification end tag. In this scenario, the plugin will notify the user about the end tag via a warning notification
instead of an echo. Triggers cannot catch notifications though so any code relying on end tags should instead of an echo. Triggers cannot catch notifications though so any code relying on end tags should
either detect when you go AFK or cleanly time out after a reasonable amount of time. either detect when you go AFK or cleanly time out after a reasonable amount of time.
6) If you add the portal wish after you have built your inventory table, you will need to either rebuild
the table (dinv build confirm) or forget/re-identify your portals (dinv forget type portal) and
(dinv refresh all).
Feature Wishlist Feature Wishlist
================ ================
1) Add a way to create and update stat prioritizations. A GUI would be a very convenient way 1) Implement a mechanism to (more) fully identify items if the identify wish is not available.
to handle this.
2) Implement a mechanism to (more) fully identify items if the identify wish is not available.
For example, we could use lore, the identify or object read spells, or Hester's identify For example, we could use lore, the identify or object read spells, or Hester's identify
service found at "runto identify". This would be a manual process to "clean up" partially service found at "runto identify". This would be a manual process to "clean up" partially
identified items. identified items.
3) Add a display option to de-duplicate potions and pills in search results

Loading…
Cancel
Save