diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 8275ac8b0740..7c75f0eef805 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -33,7 +33,7 @@ jobs: name: Upload development build with: name: "Development Build" - path: versions/1.8.9/build/libs/*.jar + path: build/libs/*.jar - name: Test with Gradle run: ./gradlew test - uses: actions/upload-artifact@v3 diff --git a/.github/workflows/check_dependencies.yml b/.github/workflows/check_dependencies.yml index 50f3641ae03c..0d79d26abfd2 100644 --- a/.github/workflows/check_dependencies.yml +++ b/.github/workflows/check_dependencies.yml @@ -1,11 +1,9 @@ name: Check PR Dependencies +# TODO: Run when other pr gets merged on: pull_request_target: types: [ opened, edited ] - push: - branches: - - beta jobs: check-dependencies: diff --git a/.idea/dictionaries/default_user.xml b/.idea/dictionaries/default_user.xml index b166e60d38fd..cb91301718f0 100644 --- a/.idea/dictionaries/default_user.xml +++ b/.idea/dictionaries/default_user.xml @@ -81,6 +81,7 @@ explosivity ezpz fairylosopher + fels fermento firedust firesale @@ -100,6 +101,7 @@ hideparticles hoppity hoppity's + hoppitys horsezooka hotbar hotm @@ -145,6 +147,7 @@ millenia minecart mineman + mineshafts miniboss mirrorverse misclick diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 57f22f2e2583..fc0f2d5c4f90 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -30,8 +30,54 @@ We use [IntelliJ](https://www.jetbrains.com/idea/) as an example. ### Setting up IntelliJ -SkyHanni's Gradle configuration is very similar to the one used in **NotEnoughUpdates**, just -follow [their guide](https://github.com/NotEnoughUpdates/NotEnoughUpdates/blob/master/CONTRIBUTING.md). +Once your project is imported into IntelliJ from the previous step, all dependencies like Minecraft, NEU, and so on should be automatically +downloaded. If not, you might need to link the Gradle project in the Gradle tab (little elephant) on the right. + +
+🖼️Show Gradle tab image + +![Gradle tab with Link Project and Gradle Settings highlighted](docs/gradle-tab.jpg) + +
+ +If importing fails, make sure the Gradle JVM (found in the settings wheel in the Gradle tab, or by searching Ctrl + Shift + A +for "Gradle JVM") is set to a Java 21 JDK. While this is not the version of Java Minecraft 1.8.9 uses, we need this version for some of our +build tools. + +
+🖼️Show Gradle JVM image + +![Gradle settings showing Java 21 being selected as JVM](docs/gradle-settings.png) + +
+ +After all importing is done (which might take a few minutes the first time you download the project), you should find a new IntelliJ run +configuration. + +
+🖼️Show run configuration selection image + +![Where to select the run configuration](docs/minecraft-client.webp) + +
+ +That task might work out of the box, but very likely it will not. We will need to adjust the used Java version. Since Minecraft 1.8.9 uses +Java 1.8, we will need to adjust the used JDK for running our Mod, as well as potentially changing the argument passing style. + +So select an appropriate Java 1.8 JDK (preferably [DCEVM](#hot-swap), but any Java 1.8 JDK or even JRE will do) and select None as the +argument passing style. + +
+🖼️Show run configuration image + +![Run configuration settings](docs/run-configuration-settings.avif) + +
+ +Now that we are done with that, you should be able to launch your game from your IDE with that run configuration. + +SkyHanni's Gradle configuration is very similar to the one used in **NotEnoughUpdates**, so if you want to look at another guide, check +out [their guide](https://github.com/NotEnoughUpdates/NotEnoughUpdates/blob/master/CONTRIBUTING.md). ## Creating a Pull Request diff --git a/README.md b/README.md index a7c00b495c57..07bf336a172c 100644 --- a/README.md +++ b/README.md @@ -14,19 +14,19 @@ ## What it does -SkyHanni is a Forge mod for Minecraft 1.8.9 that adds many useful features to Hypixel SkyBlock. With SkyHanni, you'll get: +SkyHanni is a Forge mod for Minecraft 1.8.9 that adds many useful features to [Hypixel SkyBlock](https://wiki.hypixel.net/Main_Page). With SkyHanni you have access to: -* **Helpful GUIs:** Access important information at a glance. -* **Extra Chat Messages:** Receive reminders and helpful tips. -* **Message Hiders:** Control which messages you see in chat. -* **Entity/Item Highlighters:** Focus on important mobs or items in the world/your inventory. -* **[And much more!](docs/FEATURES.md)** +* **Helpful GUIs:** View important information at a glance. +* **Extra Chat Messages:** Receive reminders and tips at the right moment. +* **Object Highlighters:** Focus on important items in inventories or highlight mobs in the world. +* **Highly Customizeable Displays:** Personalise your Scoreboard, Tab List or chat format. +* [And **much** more!](docs/FEATURES.md) -SkyHanni is especially helpful when doing activities like farming, slayers, Bingo, Diana, fishing, or Rift. +SkyHanni is especially useful when doing farming, slayers, Bingo, Diana, fishing, Rift or mining. ## Getting Started -1. **Install:** Check out the [installation guide](docs/INSTALLING.md). +1. **Install:** Follow the [installation guide](docs/INSTALLING.md). 2. **Set Up:** Type `/sh` or `/skyhanni` in-game to configure your settings. 3. **Explore:** See all the features [here](docs/FEATURES.md). @@ -34,17 +34,17 @@ SkyHanni is especially helpful when doing activities like farming, slayers, Bing Give feedback or just chat with others on our community Discord! -* **Bug Reports:** Use the `#bug-reports` channel. -* **Feature Suggestions:** Use the `#suggestions` channel. -* **General Chat:** Chat with other SkyHanni users in `#skyblock-general` channel. +* **Bug Reports:** Use the `#bug-reports` channel when you find broken features (please check out `#faq` and `#known-bugs`). +* **Quick Help** Ask in `#support` for questions and problems with the the mod or Minecraft in general. +* **Feature Suggestions:** Feel fre to tell your ideas in `#suggestions` channel for new features and improvements to the mod. (Don't copy from existing mods or break Hypixel rules). +* **General Chat:** Chat with other SkyHanni users in `#skyblock-general` channel about the game. -[Join the Discord](https://discord.gg/skyhanni-997079228510117908) +**[Join the Discord!](https://discord.gg/skyhanni-997079228510117908)** ## Contributing -Interested in writing your own SkyHanni feature or fixing that one annoying bug yourself? Check out our [contributing guide](CONTRIBUTING.md) for more information. +Are you interested in writing your own SkyHanni feature? Do you want to fix that one annoying bug yourself? Check out our [contributing guide](CONTRIBUTING.md) for more information! --- -**SkyHanni is part of an active modding community. Explore other useful mods [here](https://sbmw.ca/mod-lists/skyblock-mod-list/) to -complete your SkyBlock setup!** +**SkyHanni is part of an active modding community. Explore other useful mods [here](https://sbmw.ca/mod-lists/skyblock-mod-list/) for even more SkyBlock features!** diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index b287d2b74708..0d26050da8b3 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -1,6 +1,300 @@ # SkyHanni - Change Log -## Version 0.26 (In Beta) +## Version 0.27 (in Beta) + +### New Features + +#### Garden Features + ++ Added No Pests Chat Filter. - saga (https://github.com/hannibal002/SkyHanni/pull/1957) + + Removed the chat message "There are no Pests on your Garden!". ++ Added No Pests Title. - saga (https://github.com/hannibal002/SkyHanni/pull/1957) + + Shows a title when you use the Pest Tracker without any pests to clear. + +#### Mining Features + ++ Added a "Get from Sack" button in the forge recipe menu to retrieve ingredients. - minhperry (https://github.com/hannibal002/SkyHanni/pull/2106) + +#### Rift Features + ++ Added Motes per Session. - Empa (https://github.com/hannibal002/SkyHanni/pull/2323) ++ Added Crafting Room Helper. - HiZe (https://github.com/hannibal002/SkyHanni/pull/2178) + + Shows a holographic mob at the location where the mob is present in the real room inside the Mirrorverse in Rift. ++ Added Rift Time Real-Time Nametag Format. - Empa (https://github.com/hannibal002/SkyHanni/pull/2015) + +#### Dungeon Features + ++ Added highlight for starred dungeon mobs. - Thunderblade73 (https://github.com/hannibal002/SkyHanni/pull/1558) ++ Added highlight for Fel skulls. - Thunderblade73 (https://github.com/hannibal002/SkyHanni/pull/1558) + + Optionally draws a line to them as well. ++ Added a Secret Chime for Dungeons with adjustable pitch and sound. - Ovi_1 (https://github.com/hannibal002/SkyHanni/pull/2478) + + The sound and pitch of chimes in dungeons are customizable. + +#### Scoreboard Features + ++ Added Soulflow to the Custom Scoreboard. - Empa (https://github.com/hannibal002/SkyHanni/pull/1837) + + Requires Soulflow to be enabled in Hypixel settings: /tab -> Profile Widget -> Show Soulflow. + +#### Hoppity Features + ++ Added Hoppity Hunt event summary. - Daveed (https://github.com/hannibal002/SkyHanni/pull/2311) + + Use /shhoppitystats for live stats. ++ Added optional warning when Hoppity calls you with a rabbit to sell. - Daveed (https://github.com/hannibal002/SkyHanni/pull/2272) ++ Added hotkey for picking up Abiphone calls from Hoppity. - Daveed (https://github.com/hannibal002/SkyHanni/pull/2272) + +#### GUI Features + ++ Added Editable XP Bar. - Thunderblade73 (https://github.com/hannibal002/SkyHanni/pull/1944) + + Enabled moving and scaling of the XP bar in the SkyHanni GUI Editor. ++ Added Display Tab Widgets. - Thunderblade73 (https://github.com/hannibal002/SkyHanni/pull/1276) + + Allows the display of information from the Tab (e.g., Bestiary info). + +#### Inventory Features + ++ Added a warning when opening the Experimentation Table without a Guardian pet. - martimavocado (https://github.com/hannibal002/SkyHanni/pull/2127) ++ Added Enchanting Experience as Stack Size in Experimentation Table. - saga (https://github.com/hannibal002/SkyHanni/pull/1988) + + Added to the Item Number list. ++ Show dye hex code as the actual color in the item lore. - nopo (https://github.com/hannibal002/SkyHanni/pull/2321) ++ Added Display for Bits on Cookie buy. - Thunderblade73 (https://github.com/hannibal002/SkyHanni/pull/2265) + + Shows the Bits you would gain. + + Can show the change for the available Bits. + + Also shows the time more clearly (or adds it if not present). ++ Added Compact Experimentation Table chat rewards. - ILike2WatchMemes (https://github.com/hannibal002/SkyHanni/pull/2209) + + Uses a compact chat message of rewards gained from Add-ons/Experiments. ++ Added Personal Compactor/Deletor Overlay. - Empa (https://github.com/hannibal002/SkyHanni/pull/1869) + + Shows what items are currently inside the personal compactor/deletor, and whether the accessory is turned on or off. ++ Added Accessory magical power display as stack size. - minhperry (https://github.com/hannibal002/SkyHanni/pull/2243) + + Only works inside the Accessory Bag and Auction House. + +#### Chat Features + ++ Added `/shcolors` command. - minhperry (https://github.com/hannibal002/SkyHanni/pull/2216) + + Prints a list of all Minecraft color and formatting codes in chat. ++ Added Remind command. - ThatGravyBoat & Zickles (https://github.com/hannibal002/SkyHanni/pull/1708) + + Use `/shremind