diff --git a/README.md b/README.md index bdbe3a1..1693151 100644 --- a/README.md +++ b/README.md @@ -19,8 +19,22 @@ A 1.8.9 Minecraft Forge mod for Hypixel Skyblock.

--> + +## Usage Open the Gui with /atonaddons (or /aa). You can then set a keybind for it in the Click Gui Module. +By default all features will be disabled. +You can toggle features by left clicking on their corresponding module button in the click gui. +Right clicking that button will extend the settings for that module. +All modules have a key bind setting, which for most of them will toggle the module. +But there are a few exceptions where that key bind is used to perform the modules action if it is enabled. + +**If you need information on what the module and its settings do middle click the module button and an +advanced settings menu will open.** + +Below you can see a preview of the gui. +![Gui Preview](./resources/GuiPreview.png "Gui Preview") + ## Module List
@@ -75,4 +89,4 @@ Open the Gui with /atonaddons (or /aa). You can then set a keybind for it in the A special thank goes to [Harry282](https://github.com/Harry282), his projects allowed me to get started with making my own forge mods.
-[For the list of sources click here.](https://github.com/FloppaCoding/AtonAddons/blob/main/USEFUL_SOURCES.md "Credits") \ No newline at end of file +[For the list of sources click here.](./USEFUL_SOURCES.md "Credits") \ No newline at end of file diff --git a/resources/GuiPreview.png b/resources/GuiPreview.png new file mode 100644 index 0000000..1f0b561 Binary files /dev/null and b/resources/GuiPreview.png differ diff --git a/src/main/kotlin/atonaddons/module/impl/dungeon/LeapHighlights.kt b/src/main/kotlin/atonaddons/module/impl/dungeon/LeapHighlights.kt index ba9ebd9..2643ca9 100644 --- a/src/main/kotlin/atonaddons/module/impl/dungeon/LeapHighlights.kt +++ b/src/main/kotlin/atonaddons/module/impl/dungeon/LeapHighlights.kt @@ -31,7 +31,7 @@ object LeapHighlights : Module( private val color = ColorSetting("Highlight Color", Color(0,255,0,255), description = "Color of the highlight that is drawn behind the head of the target.") private val brTarget: SelectorSetting private val brTargetName = StringSetting("Br Target Name", description = "Name of the player you want to target during blood rush. This is only active when Custom is selected for Br target.") - private val disableAfterBr = BooleanSetting("Disable after Br", true, description = "Disables auto leap after blood was opened.") + private val disableAfterBr = BooleanSetting("Disable after Br", true, description = "Disables leap highlights after the Blood Door was opened.") private val bossTarget: SelectorSetting private val bossTargetName = StringSetting("Boss Target Name", description = "Name of the player you want to target in Boss. This is only active when Custom Boss is selected for Boss target.") diff --git a/src/main/kotlin/atonaddons/module/impl/render/DungeonMap.kt b/src/main/kotlin/atonaddons/module/impl/render/DungeonMap.kt index f509e92..f7b6201 100644 --- a/src/main/kotlin/atonaddons/module/impl/render/DungeonMap.kt +++ b/src/main/kotlin/atonaddons/module/impl/render/DungeonMap.kt @@ -18,17 +18,18 @@ import java.awt.Color object DungeonMap : Module( "Dungeon Map", category = Category.RENDER, - description = "Shows the full dungeon map." + description = "Renders the dungeon map as a HUD element." ){ val hideInBoss = BooleanSetting("Hide in Boss", true, description = "Hides the map in boss.") val showRunInformation = BooleanSetting("Show Run Info", true, description = "Shows run information under map.") val playerNameMode = SelectorSetting("Player Names", "Holding Leap", arrayListOf("Off", "Holding Leap", "Always"), description = "Show player name under player head.") - val autoScan = BooleanSetting("Map Scan", true, description = "Automatically scans when entering dungeon. Manual scan can be done with \"${MainCommand.commandAliases[0]} scan\".") + val autoScan = BooleanSetting("Map Scan", true, description = "Automatically scans when entering dungeon. Manual scan can be done with \"${MainCommand.commandAliases[0]} scan\"." + + "\nThis is required if you want to explore the map before the dungeon has started.") val mapScale = NumberSetting("Map Scale",1.25,0.1,4.0,0.02, description = "Scale of entire map.") val roomScale = NumberSetting("Dungeon Scale", 1.0,0.5,1.5, 0.01, description = "Scales the size of the displayed dungeon inside of the map HUD element.") val textScale = NumberSetting("Text Scale",0.75,0.0,2.0,0.02, description = "Scale of room names and secret counts relative to map size.") val playerHeadScale = NumberSetting("Head Scale",1.0,0.0,2.0,0.02, description = "Scale of player heads relative to map size.") - val spinnyMap = BooleanSetting("Spinny Map", false, description = "Centers the map on you and rotates it.") + val spinnyMap = BooleanSetting("Spinny Map", false, description = "Rotates the map instead of your head.") val centerOnPlayer = BooleanSetting("Center on Player", false, description = "Centers the map on your own Player Head.") val mapBackground = ColorSetting("Background", Color(0, 0, 0, 100),true, description = "Background Color for the map.") val mapBorder = ColorSetting("Border", Color(0, 0, 0, 255),true, description = "Border Color for the map.") diff --git a/src/main/kotlin/atonaddons/module/impl/render/ItemAnimations.kt b/src/main/kotlin/atonaddons/module/impl/render/ItemAnimations.kt index 2f8da76..d86c4d0 100644 --- a/src/main/kotlin/atonaddons/module/impl/render/ItemAnimations.kt +++ b/src/main/kotlin/atonaddons/module/impl/render/ItemAnimations.kt @@ -29,12 +29,12 @@ object ItemAnimations : Module( private val size = NumberSetting("Size", 0.0, -1.5, 1.5, 0.05, description = "Scales the size of your currently held item. Default: 0") private val scaleSwing = BooleanSetting("Scale Swing", true, description = "Also scale the size of the swing animation.") - private val x = NumberSetting("X", 0.0, -2.5, 1.5, 0.05, description = "Moves the held item. Default: 0") - private val y = NumberSetting("Y", 0.0, -1.5, 1.5, 0.05, description = "Moves the held item. Default: 0") - private val z = NumberSetting("Z", 0.0, -1.5, 3.0, 0.05, description = "Moves the held item. Default: 0") - private val yaw = NumberSetting("Yaw", 0.0, -180.0, 180.0, 5.0, description = "Rotates your held item. Default: 0") - private val pitch = NumberSetting("Pitch", 0.0, -180.0, 180.0, 5.0, description = "Rotates your held item. Default: 0") - private val roll = NumberSetting("Roll", 0.0, -180.0, 180.0, 5.0, description = "Rotates your held item. Default: 0") + private val x = NumberSetting("X", 0.0, -2.5, 1.5, 0.05, description = "Moves the held item left / right. Default: 0") + private val y = NumberSetting("Y", 0.0, -1.5, 1.5, 0.05, description = "Moves the held item up / down. Default: 0") + private val z = NumberSetting("Z", 0.0, -1.5, 3.0, 0.05, description = "Moves the held item away from / closer to you. Default: 0") + private val yaw = NumberSetting("Yaw", 0.0, -180.0, 180.0, 5.0, description = "Rotates the yaw of your held item. Default: 0") + private val pitch = NumberSetting("Pitch", 0.0, -180.0, 180.0, 5.0, description = "Rotates the pitch of your held item. Default: 0") + private val roll = NumberSetting("Roll", 0.0, -180.0, 180.0, 5.0, description = "Rotates the roll of your held item. Default: 0") /** * Used in the EntitiyLivingBaseMixin