From cf4c16333ec3847c0b2913829138225c90dacf08 Mon Sep 17 00:00:00 2001 From: Emagi Date: Tue, 6 May 2025 12:18:43 -0400 Subject: [PATCH] B slash commands doc --- docs/slash_commands/back_aa.md | 13 ++++++++ docs/slash_commands/ban.md | 14 +++++++++ docs/slash_commands/bank.md | 13 ++++++++ docs/slash_commands/bank_deposit.md | 13 ++++++++ docs/slash_commands/bank_withdraw.md | 13 ++++++++ docs/slash_commands/battleground.md | 10 +++++++ docs/slash_commands/begin_aa_profile.md | 13 ++++++++ docs/slash_commands/beta.md | 10 +++++++ docs/slash_commands/book.md | 15 ++++++++++ docs/slash_commands/bot.md | 31 ++++++++++++++++++++ docs/slash_commands/bot_create.md | 16 ++++++++++ docs/slash_commands/bot_customize.md | 13 ++++++++ docs/slash_commands/bot_help.md | 13 ++++++++ docs/slash_commands/bot_inv.md | 16 ++++++++++ docs/slash_commands/bot_list.md | 13 ++++++++ docs/slash_commands/bot_settings.md | 16 ++++++++++ docs/slash_commands/bot_spawn.md | 13 ++++++++ docs/slash_commands/broadcast.md | 16 ++++++++++ docs/slash_commands/buy_from_broker.md | 14 +++++++++ docs/slash_commands/buy_from_merchant.md | 15 ++++++++++ docs/slash_commands/buy_from_vendor.md | 10 +++++++ docs/slash_commands/buy_house.md | 10 +++++++ docs/slash_commands/buyback_from_merchant.md | 14 +++++++++ 23 files changed, 324 insertions(+) create mode 100644 docs/slash_commands/back_aa.md create mode 100644 docs/slash_commands/ban.md create mode 100644 docs/slash_commands/bank.md create mode 100644 docs/slash_commands/bank_deposit.md create mode 100644 docs/slash_commands/bank_withdraw.md create mode 100644 docs/slash_commands/battleground.md create mode 100644 docs/slash_commands/begin_aa_profile.md create mode 100644 docs/slash_commands/beta.md create mode 100644 docs/slash_commands/book.md create mode 100644 docs/slash_commands/bot.md create mode 100644 docs/slash_commands/bot_create.md create mode 100644 docs/slash_commands/bot_customize.md create mode 100644 docs/slash_commands/bot_help.md create mode 100644 docs/slash_commands/bot_inv.md create mode 100644 docs/slash_commands/bot_list.md create mode 100644 docs/slash_commands/bot_settings.md create mode 100644 docs/slash_commands/bot_spawn.md create mode 100644 docs/slash_commands/broadcast.md create mode 100644 docs/slash_commands/buy_from_broker.md create mode 100644 docs/slash_commands/buy_from_merchant.md create mode 100644 docs/slash_commands/buy_from_vendor.md create mode 100644 docs/slash_commands/buy_house.md create mode 100644 docs/slash_commands/buyback_from_merchant.md diff --git a/docs/slash_commands/back_aa.md b/docs/slash_commands/back_aa.md new file mode 100644 index 0000000..15401f0 --- /dev/null +++ b/docs/slash_commands/back_aa.md @@ -0,0 +1,13 @@ +### Command: /back_aa + +**Handler Macro:** UNKNOWN + +**Handler Value:** 754 + +**Required Status:** 200 + +**Arguments:** +None + +**Notes:** +- Handler assigned, however command is not implemented. \ No newline at end of file diff --git a/docs/slash_commands/ban.md b/docs/slash_commands/ban.md new file mode 100644 index 0000000..5d7b8fd --- /dev/null +++ b/docs/slash_commands/ban.md @@ -0,0 +1,14 @@ +### Command: /ban player_name [permanent:0/1] + +**Handler Macro:** COMMAND_BAN + +**Handler Value:** 23 + +**Required Status:** 10 + +**Arguments:** +- `arg[0]`: `string player_name` +- `arg[1]`: `int8 permanent` + +**Notes:** +- `Permanent` is default 0 which is suspended (Admin Status -1), when set to 1 will be set to banned (Admin Status -2). \ No newline at end of file diff --git a/docs/slash_commands/bank.md b/docs/slash_commands/bank.md new file mode 100644 index 0000000..9e2b57f --- /dev/null +++ b/docs/slash_commands/bank.md @@ -0,0 +1,13 @@ +### Command: /bank + +**Handler Macro:** COMMAND_BANK + +**Handler Value:** 70 + +**Required Status:** 0 + +**Arguments:** +None + +**Notes:** +- Opens up client bank UI. \ No newline at end of file diff --git a/docs/slash_commands/bank_deposit.md b/docs/slash_commands/bank_deposit.md new file mode 100644 index 0000000..6841478 --- /dev/null +++ b/docs/slash_commands/bank_deposit.md @@ -0,0 +1,13 @@ +### Command: /bank_deposit amount_copper + +**Handler Macro:** COMMAND_BANK_DEPOSIT + +**Handler Value:** 71 + +**Required Status:** 0 + +**Arguments:** +- `arg[0]`: `int64 amount_copper` + +**Notes:** +- If in an active banker session, will deposit `amount_copper` of coins in copper. \ No newline at end of file diff --git a/docs/slash_commands/bank_withdraw.md b/docs/slash_commands/bank_withdraw.md new file mode 100644 index 0000000..3dc5027 --- /dev/null +++ b/docs/slash_commands/bank_withdraw.md @@ -0,0 +1,13 @@ +### Command: /bank_withdraw amount_copper + +**Handler Macro:** COMMAND_BANK_WITHDRAWAL + +**Handler Value:** 72 + +**Required Status:** 0 + +**Arguments:** +- `arg[0]`: `int64 amount_copper` + +**Notes:** +- If in a banker session, this will withdrawl `amount_copper` to player's inventory. \ No newline at end of file diff --git a/docs/slash_commands/battleground.md b/docs/slash_commands/battleground.md new file mode 100644 index 0000000..fc44fb5 --- /dev/null +++ b/docs/slash_commands/battleground.md @@ -0,0 +1,10 @@ +### Command: /battleground + +**Handler Macro:** UNKNOWN + +**Handler Value:** 999 + +**Required Status:** 0 + +**Arguments:** +None diff --git a/docs/slash_commands/begin_aa_profile.md b/docs/slash_commands/begin_aa_profile.md new file mode 100644 index 0000000..f990c01 --- /dev/null +++ b/docs/slash_commands/begin_aa_profile.md @@ -0,0 +1,13 @@ +### Command: /begin_aa_profile + +**Handler Macro:** UNKNOWN + +**Handler Value:** 753 + +**Required Status:** 200 + +**Arguments:** +None + +**Notes:** +- For Sending and Displaying AA in the client. \ No newline at end of file diff --git a/docs/slash_commands/beta.md b/docs/slash_commands/beta.md new file mode 100644 index 0000000..be79369 --- /dev/null +++ b/docs/slash_commands/beta.md @@ -0,0 +1,10 @@ +### Command: /beta + +**Handler Macro:** UNKNOWN + +**Handler Value:** 999 + +**Required Status:** 0 + +**Arguments:** +None diff --git a/docs/slash_commands/book.md b/docs/slash_commands/book.md new file mode 100644 index 0000000..7aac772 --- /dev/null +++ b/docs/slash_commands/book.md @@ -0,0 +1,15 @@ +### Command: /book read item_index + +**Handler Macro:** COMMAND_READ + +**Handler Value:** 463 + +**Required Status:** 0 + +**Arguments:** +- `arg[0]`: `string action` +- `arg[1]`: `int32 item_index` + +**Notes:** +- The handler is assigned to COMMAND_READ, but the /book command is called since that is what the handler is assigned to. +- First argument is `action`, we support the value `read`. Second argument is the item index in player's item list. \ No newline at end of file diff --git a/docs/slash_commands/bot.md b/docs/slash_commands/bot.md new file mode 100644 index 0000000..fc84188 --- /dev/null +++ b/docs/slash_commands/bot.md @@ -0,0 +1,31 @@ +### Command: /bot action [id] + +**Handler Macro:** COMMAND_BOT + +**Handler Value:** 500 + +**Required Status:** 0 + +**Arguments:** +- `arg[0]`: `string action` +- `arg[1]`: `int id` +- Optional arguments for /bot create, `arg[1]` : `int race`, `arg[2]` : `int gender`, `arg[3]` : `int class`, `arg[4]` : `string name`. + +**Notes:** +- Action can be camp, attack, spells, maintank, delete, follow, stopfollow, summon, list, customize, spawn, inv, setings, help +- /bot create [race] [gender] [class] [name], creates a new bot with the specified arguments. +- /bot camp, must have bot targetted +- /bot attack, all bots in the group will attack your target +- /bot spells, lists the targetted bots spells +- /bot maintank, sets your target as the main tank for the group of all bot participants you control. +- /bot delete `id`, deletes the bot from the database +- /bot follow `id`, tells the bot by the id to follow you +- /bot stopfollow `id` +- /bot summon group, summons all your bots to your location. + +- /bot list, shows all bots you have in the database +- /bot customize, this is not supported +- /bot spawn `id`, spawns the bot with the id specified from /bot list +- /bot inv `[give/list/remove]` - manage bot equipment, for remove a slot must be provide +- /bot settings `[helm/hood/cloak/taunt] [0/1]` - Turn setting on (1) or off(0) +- /bot help \ No newline at end of file diff --git a/docs/slash_commands/bot_create.md b/docs/slash_commands/bot_create.md new file mode 100644 index 0000000..734a024 --- /dev/null +++ b/docs/slash_commands/bot_create.md @@ -0,0 +1,16 @@ +### Command: /bot create + +**Handler Macro:** COMMAND_BOT_CREATE + +**Handler Value:** 501 + +**Required Status:** 0 + +**Arguments:** +- `arg[1]`: `int race` +- `arg[2]`: `int gender` +- `arg[3]`: `int class` +- `arg[4]`: `string name`. + +**Notes:** +- /bot create [race] [gender] [class] [name], creates a new bot with the specified arguments. Use /bot list to see the created bot and /bot spawn id to spawn it. diff --git a/docs/slash_commands/bot_customize.md b/docs/slash_commands/bot_customize.md new file mode 100644 index 0000000..bdc83c6 --- /dev/null +++ b/docs/slash_commands/bot_customize.md @@ -0,0 +1,13 @@ +### Command: /bot customize + +**Handler Macro:** COMMAND_BOT_CUSTOMIZE + +**Handler Value:** 502 + +**Required Status:** 0 + +**Arguments:** +None + +**Notes:** +- /bot customize, this is not supported diff --git a/docs/slash_commands/bot_help.md b/docs/slash_commands/bot_help.md new file mode 100644 index 0000000..dab0e8e --- /dev/null +++ b/docs/slash_commands/bot_help.md @@ -0,0 +1,13 @@ +### Command: /bot help + +**Handler Macro:** COMMAND_BOT_HELP + +**Handler Value:** 507 + +**Required Status:** 0 + +**Arguments:** +None + +**Notes:** +- Returns the list of /bot commands \ No newline at end of file diff --git a/docs/slash_commands/bot_inv.md b/docs/slash_commands/bot_inv.md new file mode 100644 index 0000000..0996137 --- /dev/null +++ b/docs/slash_commands/bot_inv.md @@ -0,0 +1,16 @@ +### Command: /bot inv [action] + +**Handler Macro:** COMMAND_BOT_INV + +**Handler Value:** 505 + +**Required Status:** 0 + +**Arguments:** +- `arg[0]`: `string action` + +**Notes:** +- Action can be give, remove, or list. +- /bot give, opens a trade to give items to the bot +- /bot remove, opens a trade to removes items from the bot +- /bot list, lists items on the bot \ No newline at end of file diff --git a/docs/slash_commands/bot_list.md b/docs/slash_commands/bot_list.md new file mode 100644 index 0000000..a3e1bf3 --- /dev/null +++ b/docs/slash_commands/bot_list.md @@ -0,0 +1,13 @@ +### Command: /bot list + +**Handler Macro:** COMMAND_BOT_LIST + +**Handler Value:** 504 + +**Required Status:** 0 + +**Arguments:** +None + +**Notes:** +- Lists the available bots to the character from the database. \ No newline at end of file diff --git a/docs/slash_commands/bot_settings.md b/docs/slash_commands/bot_settings.md new file mode 100644 index 0000000..31b7f67 --- /dev/null +++ b/docs/slash_commands/bot_settings.md @@ -0,0 +1,16 @@ +### Command: /bot settings [action] [value] + +**Handler Macro:** COMMAND_BOT_SETTINGS + +**Handler Value:** 506 + +**Required Status:** 0 + +**Arguments:** +- `arg[0]`: `string action` +- `arg[1]`: `int8 value` + +**Notes:** +- `action` can be helm, hood, cloak, taunt +- `value` can be 1 to enable, 0 to disable. +- /bot settings `[helm/hood/cloak/taunt] [0/1]` - Turn setting on (1) or off(0) diff --git a/docs/slash_commands/bot_spawn.md b/docs/slash_commands/bot_spawn.md new file mode 100644 index 0000000..e7b7457 --- /dev/null +++ b/docs/slash_commands/bot_spawn.md @@ -0,0 +1,13 @@ +### Command: /bot spawn id + +**Handler Macro:** COMMAND_BOT_SPAWN + +**Handler Value:** 503 + +**Required Status:** 0 + +**Arguments:** +- `arg[0]`: `int id` + +**Notes:** +- Spawns the bot from the database, `id` is obtained from /bot list. \ No newline at end of file diff --git a/docs/slash_commands/broadcast.md b/docs/slash_commands/broadcast.md new file mode 100644 index 0000000..d0b966c --- /dev/null +++ b/docs/slash_commands/broadcast.md @@ -0,0 +1,16 @@ +### Command: /broadcast message + +**Handler Macro:** COMMAND_BROADCAST + +**Handler Value:** 145 + +**Required Status:** 10 + +**Arguments:** +- `arg[0]`: `string message` + +**Usage Examples:** +- `/broadcast {message}");` + +**Notes:** +- Sends a broadcast to player participants in the zones of the world server the GM resides on. \ No newline at end of file diff --git a/docs/slash_commands/buy_from_broker.md b/docs/slash_commands/buy_from_broker.md new file mode 100644 index 0000000..1d481a3 --- /dev/null +++ b/docs/slash_commands/buy_from_broker.md @@ -0,0 +1,14 @@ +### Command: /buy_from_broker item_id quantity + +**Handler Macro:** COMMAND_BUY_FROM_BROKER + +**Handler Value:** 95 + +**Required Status:** 0 + +**Arguments:** +- `arg[0]`: `int item_id` +- `arg[1]`: `int quantity` + +**Notes:** +- /buy_from_broker is not fully implemented, this just acts much like summon item. Supplies the player inventory with an item of `item_id` and `quantity`. \ No newline at end of file diff --git a/docs/slash_commands/buy_from_merchant.md b/docs/slash_commands/buy_from_merchant.md new file mode 100644 index 0000000..e8dfc5e --- /dev/null +++ b/docs/slash_commands/buy_from_merchant.md @@ -0,0 +1,15 @@ +### Command: /buy_from_merchant item_id quantity + +**Handler Macro:** COMMAND_MERCHANT_BUY + +**Handler Value:** 87 + +**Required Status:** 0 + +**Arguments:** +- `arg[0]`: `int item_id` +- `arg[1]`: `int quantity` + +**Notes:** +- If item_id and quantity arguments are not specified, then it displays the merchant buy window. +- If in merchant transaction, will attempt to buy from merchant the item_id and quantity if item is available and sufficient quantity. \ No newline at end of file diff --git a/docs/slash_commands/buy_from_vendor.md b/docs/slash_commands/buy_from_vendor.md new file mode 100644 index 0000000..eba9b12 --- /dev/null +++ b/docs/slash_commands/buy_from_vendor.md @@ -0,0 +1,10 @@ +### Command: /buy_from_vendor + +**Handler Macro:** UNKNOWN + +**Handler Value:** 999 + +**Required Status:** 0 + +**Arguments:** +None diff --git a/docs/slash_commands/buy_house.md b/docs/slash_commands/buy_house.md new file mode 100644 index 0000000..420a4be --- /dev/null +++ b/docs/slash_commands/buy_house.md @@ -0,0 +1,10 @@ +### Command: /buy_house + +**Handler Macro:** UNKNOWN + +**Handler Value:** 999 + +**Required Status:** 0 + +**Arguments:** +None diff --git a/docs/slash_commands/buyback_from_merchant.md b/docs/slash_commands/buyback_from_merchant.md new file mode 100644 index 0000000..41022e3 --- /dev/null +++ b/docs/slash_commands/buyback_from_merchant.md @@ -0,0 +1,14 @@ +### Command: /buyback_from_merchant id quantity + +**Handler Macro:** COMMAND_BUYBACK + +**Handler Value:** 91 + +**Required Status:** 0 + +**Arguments:** +- `arg[0]`: `int64 id` +- `arg[1]`: `int quantity` + +**Notes:** +- Used to buyback a previously sold item with a merchant. `id` is a combination of the item_id and unique_id. First 4 bytes is the item id, second 4 bytes is the unique id. \ No newline at end of file