Quantcast

Added Readme

Kevin Lyles [12-11-10 - 15:43]
Added Readme
Filename
Readme
diff --git a/Readme b/Readme
new file mode 100644
index 0000000..756e974
--- /dev/null
+++ b/Readme
@@ -0,0 +1,23 @@
+NOTE: the first few scans will take significantly longer to complete than subsequent scans.  ItemScanner only assumes a very few items are invalid and will try everything else at least once.  Once an item is determined to be invalid, it will be scanned only occasionally to ensure it is still invalid.  Valid items take a minimum of 0.025 seconds, versus 10 full seconds for each invalid item.
+
+NOTE: it is recommended to enable ItemScanner for max-level characters only, to ensure that the data can be used by other parts of the addon and the developer-specific portions of WeightsWatcher.
+
+In-game commands start with /is or /itemscanner, and there is help in-game (add "help" to the command you want help for)
+
+ItemScanner will automatically (re-)start when you log into a character that has it enabled, and will advance to the next section if it has finished the current one.  This means you have to do less babysitting in-game, but you must remember to do the outside of the game parts every time you log out or reloadui.  If you can set up an auto-pull script similar to auto-pull.sh, forgetting becomes less of a problem.  If you run Linux and set up ItemScanner in a git repository, you can probably use auto-pull.sh with minimal changes.  Note that auto-pull.sh harcodes the filename (which will probably need to be changed for your use).
+
+Normal usage of ItemScanner (the parts outside of the game):
+	If you aren't using auto-pull.sh, whenever you reload the ui or log out, run:
+		lua get-live-data.lua <path to your ItemScanner SavedVariables file>
+			The file is usually WTF/Account/<account>/SavedVariables/ItemScanner.lua inside your WoW folder.
+		If you're using source control of any sort, you'll probably want to commit here as well
+	(Optional) When happy with the data, run:
+		lua splice-item-info.lua
+			This will give you a single file with all item data called full-item-info.lua
+			It will be sorted, but only by the text of the item links (read as not in numerical order).
+		lua create-gem-ids-file.lua
+			This will give you a file with the gem ids (as in the item hyperlink once the gem is socketed) mapped to the gem stats.
+		lua find-inconsistent-gems.lua
+			This will let you catch Blizzard failing to update old gems/patterns to all match each other when the name is the same
+			This is probably not very useful now that the Cata beta is over, and most (if not all) of the discrepancies are due to gems/patterns that can no longer be obtained
+		NOTE: update-generated-files.sh will do all of the optional bits if you have a Bash-compatible shell.
\ No newline at end of file