From 9c7c1f317a5740bd5778533bfcbaa9527228f291 Mon Sep 17 00:00:00 2001 From: Emagi Date: Thu, 15 May 2025 09:41:55 -0400 Subject: [PATCH] More slash commands documented in markdown --- docs/slash_commands/auction.md | 2 +- docs/slash_commands/hide_illusions.md | 13 +++++++++++++ docs/slash_commands/house.md | 13 +++++++++++++ docs/slash_commands/house_deposit.md | 15 +++++++++++++++ docs/slash_commands/house_ui.md | 13 +++++++++++++ docs/slash_commands/ignore_add.md | 13 +++++++++++++ docs/slash_commands/ignore_remove.md | 13 +++++++++++++ docs/slash_commands/ignores.md | 13 +++++++++++++ docs/slash_commands/kick.md | 13 +++++++++++++ docs/slash_commands/kickfromgroup.md | 13 +++++++++++++ docs/slash_commands/kickfromraid.md | 13 +++++++++++++ docs/slash_commands/kill.md | 16 ++++++++++++++++ docs/slash_commands/knowledgewindow_sort.md | 20 ++++++++++++++++++++ docs/slash_commands/languages.md | 14 ++++++++++++++ docs/slash_commands/lastname.md | 13 +++++++++++++ docs/slash_commands/leavegroup.md | 13 +++++++++++++ 16 files changed, 209 insertions(+), 1 deletion(-) create mode 100644 docs/slash_commands/hide_illusions.md create mode 100644 docs/slash_commands/house.md create mode 100644 docs/slash_commands/house_deposit.md create mode 100644 docs/slash_commands/house_ui.md create mode 100644 docs/slash_commands/ignore_add.md create mode 100644 docs/slash_commands/ignore_remove.md create mode 100644 docs/slash_commands/ignores.md create mode 100644 docs/slash_commands/kick.md create mode 100644 docs/slash_commands/kickfromgroup.md create mode 100644 docs/slash_commands/kickfromraid.md create mode 100644 docs/slash_commands/kill.md create mode 100644 docs/slash_commands/knowledgewindow_sort.md create mode 100644 docs/slash_commands/languages.md create mode 100644 docs/slash_commands/lastname.md create mode 100644 docs/slash_commands/leavegroup.md diff --git a/docs/slash_commands/auction.md b/docs/slash_commands/auction.md index 67fe482..56ab6ab 100644 --- a/docs/slash_commands/auction.md +++ b/docs/slash_commands/auction.md @@ -13,4 +13,4 @@ - ` /auction {message}");` **Notes:** -- Sends a mesasge to the auction channel. \ No newline at end of file +- Sends a message to the auction channel. \ No newline at end of file diff --git a/docs/slash_commands/hide_illusions.md b/docs/slash_commands/hide_illusions.md new file mode 100644 index 0000000..0cc4214 --- /dev/null +++ b/docs/slash_commands/hide_illusions.md @@ -0,0 +1,13 @@ +### Command: /hide_illusions + +**Handler Macro:** COMMAND_TOGGLE_ILLUSIONS + +**Handler Value:** 158 + +**Required Status:** 0 + +**Arguments:** +None + +**Notes:** +- Toggles on or off the illusion model being used for the player. \ No newline at end of file diff --git a/docs/slash_commands/house.md b/docs/slash_commands/house.md new file mode 100644 index 0000000..786260f --- /dev/null +++ b/docs/slash_commands/house.md @@ -0,0 +1,13 @@ +### Command: /house spawn_id + +**Handler Macro:** COMMAND_HOUSE + +**Handler Value:** 515 + +**Required Status:** 0 + +**Arguments:** +- `arg[0]`: `int spawn_id` + +**Notes:** +- Provides the house UI display window, if outside a instance you will need to use /house {spawn_id} where spawn_id is the Spawn offering the House (Door or Spawn as examples). When in an instance like a personal house instance, it will display your in-house UI window. \ No newline at end of file diff --git a/docs/slash_commands/house_deposit.md b/docs/slash_commands/house_deposit.md new file mode 100644 index 0000000..a38df82 --- /dev/null +++ b/docs/slash_commands/house_deposit.md @@ -0,0 +1,15 @@ +### Command: /house_deposit spawn_id deposit_copper deposit_status + +**Handler Macro:** COMMAND_HOUSE_DEPOSIT + +**Handler Value:** 518 + +**Required Status:** 0 + +**Arguments:** +- `arg[0]`: `int spawn_id` +- `arg[1]`: `string deposit_copper` +- `arg[2]`: `string deposit_status` + +**Notes:** +- If outside an instance the spawn_id needs to be set to provide the correct Spawn/Door providing the House. Otherwise inside the player instance the spawn_id is optional (provide 0 for arg[0]). Deposit_copper will only allow player inventory coin, not bank coin. \ No newline at end of file diff --git a/docs/slash_commands/house_ui.md b/docs/slash_commands/house_ui.md new file mode 100644 index 0000000..52d2309 --- /dev/null +++ b/docs/slash_commands/house_ui.md @@ -0,0 +1,13 @@ +### Command: /house_ui unique_id + +**Handler Macro:** COMMAND_HOUSE_UI + +**Handler Value:** 514 + +**Required Status:** 0 + +**Arguments:** +- `arg[0]`: `int unique_id` + +**Notes:** +- Provides the player house UI window based on the database unique_id. \ No newline at end of file diff --git a/docs/slash_commands/ignore_add.md b/docs/slash_commands/ignore_add.md new file mode 100644 index 0000000..8c6935d --- /dev/null +++ b/docs/slash_commands/ignore_add.md @@ -0,0 +1,13 @@ +### Command: /ignore_add name + +**Handler Macro:** COMMAND_IGNORE_ADD + +**Handler Value:** 111 + +**Required Status:** 0 + +**Arguments:** +- `arg[0]`: `string name` + +**Notes:** +- Adds `name` to your ignore list. You will not receive tells or see messages from this character. \ No newline at end of file diff --git a/docs/slash_commands/ignore_remove.md b/docs/slash_commands/ignore_remove.md new file mode 100644 index 0000000..8555cf9 --- /dev/null +++ b/docs/slash_commands/ignore_remove.md @@ -0,0 +1,13 @@ +### Command: /ignore_remove name + +**Handler Macro:** COMMAND_IGNORE_REMOVE + +**Handler Value:** 112 + +**Required Status:** 0 + +**Arguments:** +- `arg[0]`: `string name` + +**Notes:** +- Removes `name` from your ignore list. \ No newline at end of file diff --git a/docs/slash_commands/ignores.md b/docs/slash_commands/ignores.md new file mode 100644 index 0000000..798da99 --- /dev/null +++ b/docs/slash_commands/ignores.md @@ -0,0 +1,13 @@ +### Command: /ignores + +**Handler Macro:** COMMAND_IGNORES + +**Handler Value:** 113 + +**Required Status:** 0 + +**Arguments:** +None + +**Notes:** +- Displays character names that are ignored (not implemented). \ No newline at end of file diff --git a/docs/slash_commands/kick.md b/docs/slash_commands/kick.md new file mode 100644 index 0000000..994c560 --- /dev/null +++ b/docs/slash_commands/kick.md @@ -0,0 +1,13 @@ +### Command: /kick name + +**Handler Macro:** COMMAND_KICK + +**Handler Value:** 22 + +**Required Status:** 100 + +**Arguments:** +- `arg[0]`: `string name` + +**Notes:** +- Kicks the `name` character out of the zone they are in and forces a logout. \ No newline at end of file diff --git a/docs/slash_commands/kickfromgroup.md b/docs/slash_commands/kickfromgroup.md new file mode 100644 index 0000000..06477f7 --- /dev/null +++ b/docs/slash_commands/kickfromgroup.md @@ -0,0 +1,13 @@ +### Command: /kickfromgroup name + +**Handler Macro:** COMMAND_KICKFROMGROUP + +**Handler Value:** 543 + +**Required Status:** 0 + +**Arguments:** +- `arg[0]`: `string name` + +**Notes:** +- Removes `name` from the current group if current player is leader. `name` is optional, you can alternatively target the player to remove from the group. diff --git a/docs/slash_commands/kickfromraid.md b/docs/slash_commands/kickfromraid.md new file mode 100644 index 0000000..d3e6792 --- /dev/null +++ b/docs/slash_commands/kickfromraid.md @@ -0,0 +1,13 @@ +### Command: /kickfromraid name + +**Handler Macro:** COMMAND_KICKFROMRAID + +**Handler Value:** 544 + +**Required Status:** 0 + +**Arguments:** +- `arg[0]`: `string name` + +**Notes:** +- Removes `name` from the current group if current player is leader. `name` is optional, you can alternatively target the player to remove from the group. diff --git a/docs/slash_commands/kill.md b/docs/slash_commands/kill.md new file mode 100644 index 0000000..defc4d8 --- /dev/null +++ b/docs/slash_commands/kill.md @@ -0,0 +1,16 @@ +### Command: /kill [self] + +**Handler Macro:** COMMAND_KILL + +**Handler Value:** 54 + +**Required Status:** 10 + +**Arguments:** +- `arg[0]`: `string self` + +**Usage Examples:** +- ` /kill [self]");` + +**Notes:** +- Test/GM command. The `self` is an optional parameter to kill yourself, just type `/kill self`. Otherwise it will attempt to kill your target, Player's are exempt and you can only kill yourself with this command. \ No newline at end of file diff --git a/docs/slash_commands/knowledgewindow_sort.md b/docs/slash_commands/knowledgewindow_sort.md new file mode 100644 index 0000000..c0b461d --- /dev/null +++ b/docs/slash_commands/knowledgewindow_sort.md @@ -0,0 +1,20 @@ +### Command: /knowledgewindow_sort book sort_by order pattern + +**Handler Macro:** COMMAND_KNOWLEDGEWINDOWSORT + +**Handler Value:** 511 + +**Required Status:** 0 + +**Arguments:** +- `arg[0]`: `int book` +- `arg[1]`: `int sort_by` +- `arg[2]`: `int order` +- `arg[3]`: `int pattern` + +**Notes:** +- Sorts the spell book based on the options provided. A minimum of 3 arguments is required for KoS and earlier client versions (561), later versions will require all 4 arguments. +- book: 0 - spells, 1 - combat, 2 - abilities, 3 - tradeskill +- sort_by: 0 - alpha, 1 - level, 2 - category +- order: 0 - ascending, 1 - descending +- pattern: 0 - zigzag, 1 - down, 2 - across \ No newline at end of file diff --git a/docs/slash_commands/languages.md b/docs/slash_commands/languages.md new file mode 100644 index 0000000..8b4f8f9 --- /dev/null +++ b/docs/slash_commands/languages.md @@ -0,0 +1,14 @@ +### Command: /languages + +**Handler Macro:** COMMAND_LANGUAGES + +**Handler Value:** 290 + +**Required Status:** 0 + +**Arguments:** +None + +**Notes:** +- Lists out the known languages for the Player with the line "You know the following languages:" followed by the language name. +- See https://github.com/emagi/eq2emu/blob/main/docs/data_types/skills.md and https://github.com/emagi/eq2emu/blob/main/docs/data_types/languages.md for the language lists. \ No newline at end of file diff --git a/docs/slash_commands/lastname.md b/docs/slash_commands/lastname.md new file mode 100644 index 0000000..9f64965 --- /dev/null +++ b/docs/slash_commands/lastname.md @@ -0,0 +1,13 @@ +### Command: /lastname name + +**Handler Macro:** COMMAND_LASTNAME + +**Handler Value:** 28 + +**Required Status:** 0 + +**Arguments:** +- `arg[0]`: `string name` + +**Notes:** +- Sets lastname of your character to `name`. Must pass the Zone RuleSet and/or Global RuleSet for minimum level [R_Player, MinLastNameLevel] = 20 (default), minimum last name character length [R_Player, MinLastNameLength] = 4 (default) and maximum last name character length [R_Player, MaxLastNameLength] = 20 (default). \ No newline at end of file diff --git a/docs/slash_commands/leavegroup.md b/docs/slash_commands/leavegroup.md new file mode 100644 index 0000000..9852fcd --- /dev/null +++ b/docs/slash_commands/leavegroup.md @@ -0,0 +1,13 @@ +### Command: /leavegroup + +**Handler Macro:** COMMAND_GROUP_LEAVE + +**Handler Value:** 105 + +**Required Status:** 0 + +**Arguments:** +None + +**Notes:** +- Leaves your current group and notifies members of your group of the departure. \ No newline at end of file