port over some changes from Trinity version including one possible memory leak fix
[AHbot.git] / README.AHBOT
blobdc4201837faa02571dc8ab0ce23f7f02d0b48aa2
1 This patch modifies the core so it populates the auction houses with items. It
2 makes the game feel a bit more like official. Items and prices are chosen
3 randomly based on the parameters you define. If an auction expires, auctions
4 are deleted quietly. AHBot will not buy it's own items, and will not receive
5 mail from the AH or get returned mail.
7 ===============================================================================
8 ~~HOW TO CONFIGURE~~
9 ===============================================================================
10 Step 1.) Create a character that you are going to use as the auction house bot
11          character. This character will be the auction's owner for all the
12          items created by the bot.
13 Step 2.) Go into the realm database and note the account number for the
14          character.
15 Step 3.) Go into the characters database and note the character's GUID.
16 Step 4.) Log in at least once with this character.
17          (Do not change the configuration before this)
18 Step 5.) Tune the configuration options in the configuration file and the
19          Database.
21 #These are the settings in the configuration file:
22 AuctionHouseBot.EnableSeller = 0
23 AuctionHouseBot.EnableBuyer = 0
24 AuctionHouseBot.Account = 0
25 AuctionHouseBot.GUID = 0
26 AuctionHouseBot.VendorItems = 0
27 AuctionHouseBot.LootItems = 1
28 AuctionHouseBot.OtherItems = 0
29 AuctionHouseBot.No_Bind = 1
30 AuctionHouseBot.Bind_When_Picked_Up = 0
31 AuctionHouseBot.Bind_When_Equipped = 1
32 AuctionHouseBot.Bind_When_Use = 1
33 AuctionHouseBot.Bind_Quest_Item = 0
34 AuctionHouseBot.ItemsPerCycle = 200
35 AuctionHouseBot.UseBuyPriceForSeller = 0
36 AuctionHouseBot.UseBuyPriceForBuyer = 0
38 AuctionHouseBot.EnableSeller enables (1) or disables (0) the Seller
39 AuctionHouseBot.EnableBuyer enables (1) or disables (0) the Buyer
40 AuctionHouseBot.Account is the account number (in realmd->account table) of the player you want to run as the auction bot. Note: a value of 0 will disable the bot.
41 AuctionHouseBot.GUID is the GUID (in characters->characters table) of the player you want to run as the auction bot. Note: a value of 0 will disable the bot.
42 AuctionHouseBot.VendorItems is a boolean value (0 or 1) that indicates whether to include Vendor only items
43 AuctionHouseBot.LootItems  is a boolean value (0 or 1) that indicates whether to include Loot/Fish/Skin/etc. only items
44 AuctionHouseBot.OtherItems  is a boolean value (0 or 1) that indicates whether to include Other items not covered by the first 2
45 AuctionHouseBot.No_Bind is a boolean value (0 or 1) that indicates whether to include items with a bonding of 0
46 AuctionHouseBot.Bind_When_Picked_Up = is a boolean value (0 or 1) that indicates whether to include items with a bonding of 1
47 AuctionHouseBot.Bind_When_Equipped = is a boolean value (0 or 1) that indicates whether to include items with a bonding of 2
48 AuctionHouseBot.Bind_When_Use = is a boolean value (0 or 1) that indicates whether to include items with a bonding of 3
49 AuctionHouseBot.Bind_Quest_Item = is a boolean value (0 or 1) that indicates whether to include items with a bonding of 4
50 AuctionHouseBot.ItemsPerCycle determines how many items are added each time AHBot is run (once per minute, by default)
51 AuctionHouseBot.UseBuyPriceForSeller Use SellPrice (0) or BuyPrice (1) for determining prices
52 AuctionHouseBot.UseBuyPriceForBuyer Use SellPrice (0) or BuyPrice (1) for determining prices
54 #These are the settings in the Database:
55 #Each Auctionhouse has it's own set of these
57 MinItems = 0
58 #The Minimum number of items you want to keep in the auction houses.
59 #(default 0 - minimum will be the same as maximum).
60 #If it is higher than the value of the corresponding maxItems setting,
61 #it will be set down to match the maxItems setting.
63 MaxItems = 0
64 #The Maximum number of items you want to keep in the auction houses.
66 MinTime = 8
67 #The minimum number of hours for an auction.
69 MaxTime = 24
70 #The maximum number of hours for an auction.
72 #These must add up to 100 each one is the percentage
73 #of the auction items that should be trade goods of
74 #that quality. A value of 0 will disable.
76 PercentGreyTradeGoods = 0
77 PercentWhiteTradeGoods = 27
78 PercentGreenTradeGoods = 12
79 PercentBlueTradeGoods = 10
80 PercentPurpleTradeGoods = 1
81 PercentOrangeTradeGoods = 0
82 PercentYellowTradeGoods = 0
84 PercentGreyItems = 0
85 PercentWhiteItems = 10
86 PercentGreenItems = 30
87 PercentBlueItems = 8
88 PercentPurpleItems = 2
89 PercentOrangeItems = 0
90 PercentYellowItems = 0
92 #MinPrice(Color)    is the minimum price adjustment for items. For example the default is 150, which means 150%. So if an item vendors for 1g it would go to auction for a minimum of 1.5g.
93 #MaxPrice(Color)    is the maximum price adjustment for items.
94 #MinBidPrice(Color) these two control the starting bid as a percent of the buyout price. For example, if MinBidPrice is 30 and MaxBidPrice is 80 the starting bid for the auction will randomly be between 30-80% of the randomly chosen buyout price.
95 #MaxBidPrice(Color) these two control the starting bid as a percent of the buyout price. For example, if MinBidPrice is 30 and MaxBidPrice is 80 the starting bid for the auction will randomly be between 30-80% of the randomly chosen buyout price.
96 #MaxStack(Color)    is maximum stack size to create for this quality type. A value of zero will disable the maximum stack size for this quality allowing the bot to create stacks (of random size) of items as big as the item type allows.
98 MinPriceGrey = 100
99 MaxPriceGrey = 150
100 MinBidPriceGrey = 70
101 MaxBidPriceGrey = 100
102 MaxStackGrey = 0
103 MinPriceWhite = 150
104 MaxPriceWhite = 250
105 MinBidPriceWhite = 70
106 MaxBidPriceWhite = 100
107 MaxStackWhite = 0
108 MinPriceGreen = 800
109 MaxPriceGreen = 1400
110 MinBidPriceGreen = 80
111 MaxBidPriceGreen = 100
112 MaxStackGreen = 3
113 MinPriceBlue = 1250
114 MaxPriceBlue = 1750
115 MinBidPriceBlue = 75
116 MaxBidPriceBlue = 100
117 MaxStackBlue = 2
118 MinPricePurple = 2250
119 MaxPricePurple = 4550
120 MinBidPricePurple = 80
121 MaxBidPricePurple = 100
122 MaxStackPurple = 1
123 MinPriceOrange = 4250
124 MaxPriceOrange = 5550
125 MinBidPriceOrange = 80
126 MaxBidPriceOrange = 100
127 MaxStackOrange = 0
128 MinPriceYellow = 5250
129 MaxPriceYellow = 6550
130 MinBidPriceYellow = 80
131 MaxBidPriceYellow = 100
132 MaxStackYellow = 0
134 #These are the multipliers that are applied to the vendor price for an item, that determines if AHBot will buy it or not.
135 #1 means AHBot will pay the same as (or less than) a vendor would pay, 2 means up to twice as much, etc.
137 BuyerPriceGrey = 1
138 BuyerPriceWhite = 1
139 BuyerPriceGreen = 5
140 BuyerPriceBlue = 12
141 BuyerPricePurple = 15
142 BuyerPriceOrange = 20
143 BuyerPriceYellow = 22
145 #BuyerBiddingInterval is the time (in minutes) between bids.
146 #BuyerBidsPerInterval is the number of bids the buyer will make in a cycle
148 BuyerBiddingInterval = 1
149 BuyerBidsPerInterval = 1
153 How to use ahcommands from the console (CLI) or in game with GM level 3 players:
154 ahbotoptions - will display usage instructions
155 ahbotoptions help - will display the list of commands
157 ahexpire - will expire all the auctions in the requested auction house that were created by AHBot.
158 minitems - will set the minimum number of items in the AH before it starts being filled again.
159 maxitems - will set the maximum number of items in the AH.
160 mintime - will set the minimum time (in hours) for auctions to expire.
161 maxtime - will set the maximum time (in hours) for auctions to expire.
162 percentages - will set the percentage of each quality in the AH
163 minprice - will set the minimum price multiplier for auctions.
164 maxprice - will set the maximum price multiplier for auctions.
165 minbidprice - will set the minimum starting bid as a percent of the buyout price for auctions.
166 maxbidprice - will set the maximum starting bid as a percent of the buyout price for auctions.
167 maxstack - will set the maximum number of items in stacks for auctions. 0 will set the maximum to the maximum for that item type.
168 buyerprice - will set the bid price multiplier for auctions.
169 biddinginterval - will set the number of minutes between bids on auctions.
170 bidsperinterval - will set the number of bids to enter per cycle.
172 The auction house IDs are:
173 2 - Alliance
174 6 - Horde
175 7 - Neutral
177 AHBot Originally made by Chris K.
178 Much thanks to Chris K, grether and Dolomit6!
179 AHBot Now includes AHBuyer created by Kerbe as a derivative of AHBot, and later modified by Paradox