mirror of
https://github.com/NathanHandley/mod-ah-bot-plus.git
synced 2026-02-07 12:51:10 +00:00
added chat commands documentation
This commit is contained in:
11
README.md
11
README.md
@@ -29,6 +29,17 @@ Notes:
|
|||||||
- All price multpliers (along with the advanced pricing, see config) are applied multiplicative. Example: A Category of 1.5x, Quality of 2x, and CategoryQuality of 1.4x would make the multiplier 4.2 (1.5 x 2 x 1.4). The advanced pricing would then multiply that value further. Using item level price multpliers, which create a multiplier of itemlevel x value, is also multiplicitive along with the others. You cannot use item level price multipliers and advanced pricing, as advanced pricing will take priority between the two.
|
- All price multpliers (along with the advanced pricing, see config) are applied multiplicative. Example: A Category of 1.5x, Quality of 2x, and CategoryQuality of 1.4x would make the multiplier 4.2 (1.5 x 2 x 1.4). The advanced pricing would then multiply that value further. Using item level price multpliers, which create a multiplier of itemlevel x value, is also multiplicitive along with the others. You cannot use item level price multipliers and advanced pricing, as advanced pricing will take priority between the two.
|
||||||
- Bot-listed prices will not exceed 100k gold buyout
|
- Bot-listed prices will not exceed 100k gold buyout
|
||||||
|
|
||||||
|
### In-Game Commands
|
||||||
|
|
||||||
|
The AuctionHouseBot module adds the following in-game commands (for GMs only):
|
||||||
|
|
||||||
|
| Command | Description |
|
||||||
|
|----------|--------------|
|
||||||
|
| `.ahbot reload` | Reloads the AuctionHouseBot configuration file and updates settings. |
|
||||||
|
| `.ahbot empty` | Removes all auctions from all auction houses. Use with caution! |
|
||||||
|
| `.ahbot update` | Forces the bot to refresh or repopulate auction listings immediately.<br>Note: If you have multiple minutes configured between Buy/Sell cycles, you may have to run this additional times before you see results. |
|
||||||
|
|
||||||
|
|
||||||
## Buying Bot Behavior
|
## Buying Bot Behavior
|
||||||
|
|
||||||
1. **Determining Items to Buy:** Every minute the buyer bot will select (BuyCandidatesPerBuyCycle) items currently up for auction which are listed by players as potential purchase items.
|
1. **Determining Items to Buy:** Every minute the buyer bot will select (BuyCandidatesPerBuyCycle) items currently up for auction which are listed by players as potential purchase items.
|
||||||
|
|||||||
@@ -1,5 +1,14 @@
|
|||||||
[worldserver]
|
[worldserver]
|
||||||
|
|
||||||
|
###################################################################################################
|
||||||
|
# AUCTION HOUSE BOT IN-GAME COMMANDS
|
||||||
|
#
|
||||||
|
# Available GM commands:
|
||||||
|
# .ahbot reload - Reloads AuctionHouseBot configuration
|
||||||
|
# .ahbot empty - Clears all auctions from all auction houses
|
||||||
|
# .ahbot update - Forces an immediate update cycle
|
||||||
|
###################################################################################################
|
||||||
|
|
||||||
###############################################################################
|
###############################################################################
|
||||||
# AUCTION HOUSE BOT SETTINGS
|
# AUCTION HOUSE BOT SETTINGS
|
||||||
# AuctionHouseBot.DEBUG
|
# AuctionHouseBot.DEBUG
|
||||||
|
|||||||
@@ -129,7 +129,8 @@ public:
|
|||||||
static Acore::ChatCommands::ChatCommandTable AHBotCommandTable = {
|
static Acore::ChatCommands::ChatCommandTable AHBotCommandTable = {
|
||||||
{"update", HandleAHBotUpdateCommand, SEC_GAMEMASTER, Acore::ChatCommands::Console::Yes},
|
{"update", HandleAHBotUpdateCommand, SEC_GAMEMASTER, Acore::ChatCommands::Console::Yes},
|
||||||
{"reload", HandleAHBotReloadCommand, SEC_GAMEMASTER, Acore::ChatCommands::Console::Yes},
|
{"reload", HandleAHBotReloadCommand, SEC_GAMEMASTER, Acore::ChatCommands::Console::Yes},
|
||||||
{"empty", HandleAHBotEmptyCommand, SEC_GAMEMASTER, Acore::ChatCommands::Console::Yes}
|
{"empty", HandleAHBotEmptyCommand, SEC_GAMEMASTER, Acore::ChatCommands::Console::Yes},
|
||||||
|
{"help", HandleAHBotHelpCommand, SEC_GAMEMASTER, Acore::ChatCommands::Console::Yes}
|
||||||
};
|
};
|
||||||
|
|
||||||
static Acore::ChatCommands::ChatCommandTable commandTable = {
|
static Acore::ChatCommands::ChatCommandTable commandTable = {
|
||||||
@@ -166,6 +167,15 @@ public:
|
|||||||
AuctionHouseBot::instance()->EmptyAuctionHouses();
|
AuctionHouseBot::instance()->EmptyAuctionHouses();
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
static bool HandleAHBotHelpCommand(ChatHandler* handler, char const* /*args*/)
|
||||||
|
{
|
||||||
|
handler->PSendSysMessage("AuctionHouseBot commands:");
|
||||||
|
handler->PSendSysMessage(" .ahbot reload - Reloads configuration");
|
||||||
|
handler->PSendSysMessage(" .ahbot empty - Removes all auctions");
|
||||||
|
handler->PSendSysMessage(" .ahbot update - Runs an update cycle");
|
||||||
|
return true;
|
||||||
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
void AddAHBotScripts()
|
void AddAHBotScripts()
|
||||||
|
|||||||
Reference in New Issue
Block a user