aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 12 insertions, 11 deletions
diff --git a/README.md b/README.md
index 21bebb7..091bc4c 100644
--- a/README.md
+++ b/README.md
@@ -4,22 +4,23 @@ QOL changes that enhances your Hypixel Skyblock experience. Created to add featu
## Current features
- Guild party desktop notifications (toggleable)
- Coordinate and angle display (toggleable)
-- Slayer item tracker
-- Slayer API command
-- Skill API command
+- Slayer item tracker (with GUI display)
+- API commands
## Commands
-- /toggle [gparty/coords/list] - Toggles features. /toggle list returns values of every toggle.
-- /setkey [key] - Sets API key.
+- /dhelp - Returns this message in-game.
+- /toggle <gparty/coords/list> - Toggles features. /toggle list returns values of every toggle.
+- /setkey <key> - Sets API key.
- /getkey - Returns key set with /setkey.
-- /loot [zombie/spider/wolf] - Returns loot received from the slayer quest.
-- /display [zombie/spider/wolf/off] - Text display for slayer tracker.
-- /move [coords/display] [x] [y] - Moves text display to specified X and Y coordinates.
-- /slayer <name> - Uses API to get slayer xp of a person. If no name is provided, it checks yours.
-- /skills <name> - Uses API to get skill levlels of a person. If no name is provided, it checks yours.
+- /loot <zombie/spider/wolf> - Returns loot received from slayer quests.
+- /display <zombie/spider/wolf/off> - Text display for slayer tracker.
+- /move <coords/display> <x> <y> - Moves text display to specified X and Y coordinates.
+- /slayer [name] - Uses API to get slayer xp of a person. If no name is provided, it checks yours.
+- /skills [name] - Uses API to get skill levels of a person. If no name is provided, it checks yours.
+- /guildof [name] - Uses API to get guild name and guild master of a person. If no name is provided, it checks yours.
### Notes
- Slayer tracker for token drops and 20% chance drops uses a 12x12x12 bounding box centered on the player to detect the drops. If you are out of the range of the item drop, it will not count on the tracker.
- API commands may take a while depending on your internet connection.
-- API commands send one request to Mojang and two requests to the Hypixel API. This means doing more than 60 API commands/minute will get you rate-limited. If you have an unlimited Hypixel API key, this is changed to 600 API commands/10 minutes.
+- If you use too many API commands too fast, you can and will get rate-limited.
- An incorrect API key will result in an HTTP error code of 402.