Merge branch 'beta' into hide-parkour-messages

.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

.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:

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.
+
+<details>
+<summary>🖼️Show Gradle tab image</summary>
+
+![Gradle tab with Link Project and Gradle Settings highlighted](docs/gradle-tab.jpg)
+
+</details>
+
+If importing fails, make sure the Gradle JVM (found in the settings wheel in the Gradle tab, or by searching <kbd>Ctrl + Shift + A</kbd>
+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.
+
+<details>
+<summary>🖼️Show Gradle JVM image</summary>
+
+![Gradle settings showing Java 21 being selected as JVM](docs/gradle-settings.png)
+
+</details>
+
+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.
+
+<details>
+<summary>🖼️Show run configuration selection image</summary>
+
+![Where to select the run configuration](docs/minecraft-client.webp)
+
+</details>
+
+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.
+
+<details>
+<summary>🖼️Show run configuration image</summary>
+
+![Run configuration settings](docs/run-configuration-settings.avif)
+
+</details>
+
+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
 

README.md

@@ -14,37 +14,37 @@
 
 ## 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).
 
 ## Discord & Support
 
 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!**