diff --git a/Docs/Documentation.txt b/Docs/Documentation.txt
index f4d86c5..e52a875 100644
--- a/Docs/Documentation.txt
+++ b/Docs/Documentation.txt
@@ -3,9 +3,11 @@ Documentation.txt
Database and code documentation for Ackis Recipe List.
==Localization==
+
All the localization files are located in the "Locals" sub-directory. Feel free to edit locals in any language, make the enUS more effecient, correct typos, etc. All I would ask is if you do edit something, check in-game first to make sure the change works.
==Graphical Interface==
+
All the graphical interface functions are located in ARLFrame.lua. This file contains all the functions needed for the GUI. If you have enhancements, know how to fix an issue, etc please feel free to contribute. Just leave a detailed commit note. If it's a new feature please run it by me first before adding anything.
In the RecipeDB is a single file for each profession. Each recipe is inserted into the database via 3 functions. For example:
@@ -15,6 +17,7 @@ In the RecipeDB is a single file for each profession. Each recipe is inserted in
self:addTradeAcquire(RecipeDB, 25610, 2, 4877, 2, 1448)
==addTradeSkill==
+
This function adds the main recipe entry, including the following information:
* Spell ID
* Skill Level Learnt
@@ -26,15 +29,18 @@ From there, internal functions determine the following:
* Link determining the recipe made
==addTradeFlags==
+
This function adds a series of "flags" about the recipe. This include a fairly exhaustive look at the recipe and the item made, where is can be obtained, etc. The individual flags are documented further down.
==addTradeAcquire==
+
This function adds entries into the main database with exact instructions on how the recipe can be obtained. The details of these acquire methods are detailed further down.
==SavedVariable Structure==
+
* default values are indicated where applicable
* descriptions of values are at right
-
+<pre><nowiki>
addon.db.profile---->
sorting = ""Skill" [ | "Name" | "Acquisition" ] -- Sorting method
@@ -153,9 +159,12 @@ addon.db.profile---->
hordeexpedition = true [ | false ]
}
}
+</pre></nowiki>
==Filter Flags==
+
A recipe can be flagged with many (or even all) of the below flags. They are defined as follows:
+
===Obtain===
*1 = Alliance faction
*2 = Horde faction
@@ -287,13 +296,20 @@ Defined below is the specification for the arguments passed back into addTradeAc
Acquire Type = 8 ( Custom )
ID - Custom string
-== Reputation Level==
+== Reputation ID==
+
:0 = Neutral
:1 = Friendly
:2 = Honored
:3 = Revered
:4 = Exalted
+==Faction ID==
+
+:1 - Horde
+:2 - Alliance
+:3 - Neutral
+
==Table Structures==
===Recipe Array Structure===
@@ -311,106 +327,70 @@ Defined below is the specification for the arguments passed back into addTradeAc
}
===Rarity colours===
- 0 - poor #919191
- 1 - common #ffffff
- 2 - uncommon #00A900
- 3 - rare #0062C3
- 4 - epic #B343FF
- 5 - legendary #FA9900
- 6 - artifact #e5cc80
+:0 - poor #919191
+:1 - common #ffffff
+:2 - uncommon #00A900
+:3 - rare #0062C3
+:4 - epic #B343FF
+:5 - legendary #FA9900
+:6 - artifact #e5cc80
===Mob DB===
- self:addLookupList(MobDB, 590, L["Defias Looter"], BZONE["Westfall"], 38.52, 55.94)
- MobList
- ID = {
- Name - Mob name
- Location - Mob location (zone)
- Coordx - X coordinate
- Coordy - Y coordinate
- }
+ self:addLookupList(MobDB, 590, L["Defias Looter"], BZONE["Westfall"], 38.52, 55.94)
+MobList
+ ID = {
+ Name - Mob name
+ Location - Mob location (zone)
+ Coordx - X coordinate
+ Coordy - Y coordinate
+ }
===Quest DB===
- self:addLookupList(QuestDB, 2859, L["Wild Leather Leggings"], BZONE["Feralas"], 47.97, 67.15, 2)
- QuestList
- ID = {
- Name - Quest Name
- Location - Zone
- Coordx - X Coordinate of quest start
- Coordy - Y Coordinate of quest start
- Faction - Faction **
- }
+ self:addLookupList(QuestDB, 2859, L["Wild Leather Leggings"], BZONE["Feralas"], 47.97, 67.15, 2)
+QuestList
+ ID = {
+ Name - Quest Name
+ Location - Zone
+ Coordx - X Coordinate of quest start
+ Coordy - Y Coordinate of quest start
+ Faction - Faction **
+ }
===Reputation DB===
- self:addLookupList(RepDB, 54, BFAC["Gnomeregan Exiles"]) -- Acquire Flag:
- ReputationList
- ID = {
- Name -- translated faction
- }
+ self:addLookupList(RepDB, 54, BFAC["Gnomeregan Exiles"]) -- Acquire Flag:
+ReputationList
+ ID = {
+ Name -- translated faction
+ }
===Seasonal DB===
- self:addLookupList(SeasonDB, 3, L["Darkmoon Faire"])
- SeasonList
- ID = {
- Name -- Translated Seasonal Event name
- }
+ self:addLookupList(SeasonDB, 3, L["Darkmoon Faire"])
+SeasonList
+ ID = {
+ Name -- Translated Seasonal Event name
+ }
===Trainer DB===
- self:addLookupList(TrainerDB, 16583, L["Rohok"], BZONE["Hellfire Peninsula"], 54.62, 40.62, 2)
- TrainerList
- ID = {
- Name -- Trainer Name
- Location -- Location (zone)
- Coordx -- Trainer X coordinate
- Coordy -- Trainer Y coordinate
- Faction -- Faction ID **
- }
+ self:addLookupList(TrainerDB, 16583, L["Rohok"], BZONE["Hellfire Peninsula"], 54.62, 40.62, 2)
+TrainerList
+ ID = {
+ Name -- Trainer Name
+ Location -- Location (zone)
+ Coordx -- Trainer X coordinate
+ Coordy -- Trainer Y coordinate
+ Faction -- Faction ID **
+ }
===Vendor DB===
- self:addLookupList(VendorDB, 13433, L["Wulmort Jinglepocket"], BZONE[""], 0, 0, 0)
- VendorList
- ID = {
- Name -- Vendor Name
- Location -- Location (zone)
- Coordx -- Vendor X coordinate
- Coordy -- Vendor Y coordinate
- Faction -- Vendor Faction ID **
-
-==Faction ID===
-:1 - Horde
-:2 - Alliance
-:3 - Neutral
-
-
-
-
-
-
-Tooltip format: (acquire order : 5 7 3 4 1 2 6 8)
-
-Recipe Name
-
-Obtained from :
-Seasonal: SeasonEventName
-World Drop RarityLevel
-Mob Drop: Mob Name
-MobZone MobCoords
-Quest: QuestName
-QuestZone QuestCoords
-Trainer: TrainerName
-TrainerZone TrainerCoords
-Vendor: VendorName
-VendorZone VendorCoords
-Reputation: Faction
-FactionLevel RepVendor
-RepVendorZone RepVendorCoords
-
-Alt-Click to add this recipe to your ignore list
-Ctrl-Click to add this recipe's link to your chat
-Shift-Click to add the item crafted by this recipe's link to your chat
-
-
-
-
+ self:addLookupList(VendorDB, 13433, L["Wulmort Jinglepocket"], BZONE[""], 0, 0, 0)
+VendorList
+ ID = {
+ Name -- Vendor Name
+ Location -- Location (zone)
+ Coordx -- Vendor X coordinate
+ Coordy -- Vendor Y coordinate
+ Faction -- Vendor Faction ID **
+ }
ZJ - 10/6/08
diff --git a/Docs/Main.txt b/Docs/Main.txt
index 6c60539..bdb6e04 100644
--- a/Docs/Main.txt
+++ b/Docs/Main.txt
@@ -1,36 +1,40 @@
-== What it does ==
+==What it does==
Ackis Recipe List is an addon which will scan your trade skill recipes and print out a list of which recipes you are currently missing. It will work for all tradeskills including Runeforging.
-== Where to get it ==
+==Where to get it==
* [http://www.wowace.com/projects/arl/files/ WoW Ace] - Alpha Quality
* [http://wow.curse.com/downloads/wow-addons/details/arl.aspx Curse] - Stable release
* [http://www.wowinterface.com/downloads/info8512-AckisRecipeList.html WoWInterface] - Stable release
-== How to get it to work ==
+==How to get it to work==
You open up a trade skill window (ie: enchanting) and click on the Scan button which is attached to the trade skill window. Results will be printed out to the chat frame, or into a separate window depending on preference.
-=== Commands ===
+===Commands===
Ackis Recipe List has recently changed to use a GUI for change parameters. Type <code>/arl</code> to open up the GUI.
-== Known Issues ==
+==Known Issues==
All known issues will be kept at the [http://www.wowace.com/projects/arl/tickets/ WoW Ace] tracker.
Please use the [http://www.wowace.com/projects/arl/tickets/ WoW Ace] tracker to file bug reports.
-== Wish List ==
+==Wish List==
Please use the [http://www.wowace.com/projects/arl/tickets/ WoW Ace] tracker to add suggestions and feature requests.
-== Integration ==
+==Integration==
Ackis Recipe List strives to integrate with existing trade skill mods out there. If you have a request for integration, please submit a feature request at [http://www.wowace.com/projects/arl/tickets/ WoW Ace].
-== Bug Reporting ==
+==Bug Reporting==
Please use the [http://www.wowace.com/projects/arl/tickets/ WoW Ace] tracker to file bug reports.
-== Acknowledgments ==
+==Detailed Documentation==
+* Detailed documentation - [http://www.wowace.com/projects/arl/pages/database-documentation/]
+* API - http://www.wowace.com/projects/arl/pages/API/
+
+==Acknowledgments==
* Ideas for the mod came from FGTradeLacker (original mod no longer updated, however someone has taken over updating the recipes for it).
* Ace community for listening to my questions on the IRC channel and helping me out, and fellow mod authors for developing such great add-ons.
* Please see the X-Credits field for more Acknowledgments. Any code snippets borrowed or inspired from are credited in the code files. The main display also lists all people who are in X-Credits.
* Everyone who has helped me with localizations.
-== Wiki ==
+==Wiki==
[http://www.wowwiki.com/AckisRecipeList WoW Wiki]
\ No newline at end of file