Merge branch 'development' of https://github.com/SkyblockAddons/SkyblockAddons into development

� Conflicts:
�	src/main/java/codes/biscuit/skyblockaddons/tweaker/SkyblockAddonsTransformer.java

Author: biscuut

.github/docs/CONTRIBUTING.md

@@ -0,0 +1,79 @@
+Contributor's Guide
+------
+
+Please make sure to make your pull requests off the `development` branch if you're adding new features. If there's
+an important bug fix, still make your PR on development, but put it in a separate commit so I can cherry-pick it
+into `master` branch. Thank you!
+```shell script
+# Not recommended
+git checkout -b development --track origin/development
+```
+
+### Requirements
+- **IDE** (One of them)
+  - [IntelliJ IDEA](https://www.jetbrains.com/idea/) **(Recommended)**
+  - [Eclipse](https://www.eclipse.org/)
+- **(Plugin) Lombok** to help with things such as not having to manually create Getters and Setters.
+  - [IntelliJ IDEA](https://plugins.jetbrains.com/plugin/6317-lombok)
+    - **After installing the plugin**
+      - Go to `Preferences`
+      - Go to `Build, Execution, Deployment`
+      - Go to `Compiler`
+      - Go to `Annotation Processors`
+      - Check ☑ `Enable annotation processing`.
+  - [Eclipse](https://projectlombok.org/setup/eclipse)
+
+### Getting started
+**Note:** You can use `gradle` instead of using gradle wrapper `./gradlew`.
+
+1. Clone the repository
+2. Setup the development environment
+    ```shell script
+    ./gradlew setupDecompWorkspace
+    ```
+3. Integrate the development environment with your IDE
+    - IntelliJ IDEA
+    ```shell script
+    ./gradlew idea genIntellijRuns
+    ```
+    - Eclipse **(doesn't generate debug configuration)**
+    ```shell script
+    ./gradlew eclipse
+    ```
+    - (Eclipse) Change **Text File Encoding** from `Default` to `UTF-8`
+      - Go to `Window` -> `Preferences` -> `General` -> `Workspace`
+      - Change `Text File Encoding` from `Default` to `UTF-8`
+
+4. Make sure to add the **VM** argument to your debug configuration
+    ```text
+    -Dfml.coreMods.load=codes.biscuit.skyblockaddons.tweaker.SkyblockAddonsLoadingPlugin
+    ```
+5. Include your **Minecraft** username and password as arguments in the **debug configuration**.
+   In order, to login into [Hypixel](https://hypixel.net) by your account.
+    ```text
+    --username "<username>" --password "<password>"
+    ```
+   > **Note:** Don't share your password with **anyone**.
+   > **We aren't going to ask you about your password!**
+6. **You are now ready to build the mod!**
+
+### How to build
+1. Build the mod
+    ```shell script
+    ./gradlew build
+    ```
+    > **Note**
+    > 
+    > If your jar **build** is **failing** because the code is trying to access private methods or fields,
+    > this may be because someone added some new access transformers.
+    >
+    > You may want to re-run the gradle task
+    > ```shell script
+    > ./gradlew setupDecompWorkspace
+    > ```
+    > so the access transformers are applied to the source code!
+    > 
+2. (Optional) Run **Minecraft Forge** client
+    ```shell script
+    ./gradlew runClient
+    ```

.github/docs/OPEN_SOURCE_SOFTWARE.md

@@ -8,6 +8,7 @@ Software | License
 [Discord IPC](https://github.com/jagrosh/DiscordIPC) | [Apache 2.0](licenses/APACHE_2.0.txt)
 [Gson](https://github.com/google/gson) | [Apache 2.0](licenses/APACHE_2.0.txt)
 [Guava](https://github.com/google/guava) | [Apache 2.0](licenses/APACHE_2.0.txt)
+[JUnit 5](https://junit.org/) | [Eclipse Public License 2.0](https://github.com/junit-team/junit5/blob/main/LICENSE.md)
 [junixsocket](https://github.com/kohlschutter/junixsocket) | [Apache 2.0](licenses/APACHE_2.0.txt)
 [Log4j](https://logging.apache.org/log4j/2.x/) | [Apache 2.0](licenses/APACHE_2.0.txt)
 [Minecraft Forge](https://github.com/MinecraftForge/MinecraftForge/tree/1.8.9) | [Minecraft Forge License](https://github.com/MinecraftForge/MinecraftForge/blob/1.8.9/MinecraftForge-License.txt)

CONTRIBUTING.md

@@ -58,30 +58,6 @@ Thanks to Open Source Software
 ------
 Big thanks to all the open source software we use in this project! They are all listed [here](/.github/docs/OPEN_SOURCE_SOFTWARE.md).
 
-
 For Contributors
 ------
-
-Please make sure to make your pull requests off the development branch if you're adding new features. If there's
-an important bug fix, still make your PR on development, but put it in a separate commit so I can cherry-pick it
-into master branch. Thank you!
-
-1. Make sure to add this VM argument to your debug configuration or your IDE's equivalent, so that all the transformers
-are applied properly in your dev environment!
-```-Dfml.coreMods.load=codes.biscuit.skyblockaddons.tweaker.SkyblockAddonsLoadingPlugin```
-2. This project uses Lombok, which helps with things such as not having to manually create Getters and 
-Setters. If you are using IntelliJ, please download the plugin called Lombok either in your IDE or by 
-[visiting this link](https://plugins.jetbrains.com/plugin/6317-lombok) so that everything works correctly. 
-If you are using Eclipse, [you can read this page here.](https://projectlombok.org/setup/eclipse)
-3. After installing the plugin in IntelliJ, go to `File` → `Settings` → `Build` → 
-`Execution, Deployment, Compiler` → `Annotation Processors`, and check ☑ 
-`Enable annotation processing` on the top right. This will allow you to debug properly.
-4. If you are using the Gradle builder (you can check in `File` → `Settings` → `Build, Execution, Deployment`
- → `Gradle` → `Build and run using`), set the Gradle task ```processResourcesDev``` to run every time before 
- launching the Minecraft client from your dev environment. This is required for the mod assets to load properly
- in the dev environment.
-
-Note: If your jar build is failing because the code is trying to access private methods or fields,
-this may be because someone added some new access transformers. 
-You may want to re-run the gradle tasks `setupDecompWorkspace` and `setupDevWorkspace` so 
-the access transformers are applied to the source code!
+Please read the [contributor's guide](/.github/docs/CONTRIBUTING.md) for instructions.

README.md

@@ -15,6 +15,22 @@ sourceCompatibility = JavaVersion.VERSION_1_8
 targetCompatibility = JavaVersion.VERSION_1_8
 compileJava.options.encoding = 'UTF-8'
 
+repositories {
+    mavenCentral()
+    maven {
+        name 'JitPack'
+        url 'https://jitpack.io'
+    }
+}
+
+dependencies {
+    // Discord RPC for Java https://github.com/jagrosh/DiscordIPC
+    implementation('com.github.jagrosh:DiscordIPC:e29d6d8') {
+        exclude module: 'log4j'
+    }
+    testImplementation('org.junit.jupiter:junit-jupiter:5.6.2')
+}
+
 sourceSets {
     main {
         output.resourcesDir = java.outputDir
@@ -35,20 +51,6 @@ minecraft {
     replaceIn("${project.modName}.java")
 }
 
-repositories {
-    maven {
-        name 'JitPack'
-        url 'https://jitpack.io'
-    }
-}
-
-dependencies {
-    // Discord RPC for Java https://github.com/jagrosh/DiscordIPC
-    implementation('com.github.jagrosh:DiscordIPC:e29d6d8') {
-        exclude module: 'log4j'
-    }
-}
-
 jar {
     // Set the archive name here instead of in shadowJar because ForgeGradle needs it when re-obfuscating the jar.
     archiveName = project.modName + "-" + version + "-for-MC-1.8.9.jar"
@@ -95,4 +97,8 @@ processResources {
     }
 }
 
+test {
+    useJUnitPlatform()
+}
+
 tasks.reobfJar.dependsOn(tasks.shadowJar)

build.gradle

@@ -77,7 +77,7 @@ public static void main(String[] args) {
             UIManager.setLookAndFeel(UIManager.getSystemLookAndFeelClassName());
             SkyblockAddonsInstallerFrame frame = new SkyblockAddonsInstallerFrame();
             frame.centerFrame(frame);
-            frame.show();
+            frame.setVisible(true);
 
         } catch (Exception ex) {
             showErrorPopup(ex);

src/main/java/SkyblockAddonsInstallerFrame.java

@@ -6,7 +6,7 @@
 import codes.biscuit.skyblockaddons.features.backpacks.Backpack;
 import codes.biscuit.skyblockaddons.features.backpacks.BackpackColor;
 import codes.biscuit.skyblockaddons.features.craftingpatterns.CraftingPattern;
-import codes.biscuit.skyblockaddons.tweaker.SkyblockAddonsTransformer;
+import codes.biscuit.skyblockaddons.tweaker.SkyblockAddonsSetup;
 import codes.biscuit.skyblockaddons.utils.EnumUtils;
 import codes.biscuit.skyblockaddons.utils.ColorCode;
 import codes.biscuit.skyblockaddons.utils.objects.FloatPairString;
@@ -294,7 +294,7 @@ public static void drawSlot(GuiContainer guiContainer, Slot slot) {
     private static Method drawGradientRect = null;
 
     private static void drawRightGradientRect(GuiContainer guiContainer, int left, int top, int right, int bottom, int startColor, int endColor) {
-        if (SkyblockAddonsTransformer.isLabymodClient()) { // There are no access transformers in labymod.
+        if (SkyblockAddonsSetup.isUsingLabyModClient()) { // There are no access transformers in labymod.
             try {
                 if (drawGradientRect == null) {
                     drawGradientRect = guiContainer.getClass().getSuperclass().getSuperclass().getDeclaredMethod("a", int.class, int.class, int.class, int.class, int.class, int.class);
@@ -364,7 +364,7 @@ public static void handleMouseClick(Slot slotIn, int slotId, int clickedButton,
     private static Field zLevel = null;
 
     private static void setZLevel(Gui gui, int zLevelToSet) {
-        if (SkyblockAddonsTransformer.isLabymodClient()) { // There are no access transformers in labymod.
+        if (SkyblockAddonsSetup.isUsingLabyModClient()) { // There are no access transformers in labymod.
             try {
                 if (zLevel == null) {
                     zLevel = gui.getClass().getDeclaredField("e");
@@ -384,7 +384,7 @@ private static void setZLevel(Gui gui, int zLevelToSet) {
     private static Method drawHoveringText = null;
 
     private static void drawHoveringText(GuiContainer guiContainer, List<String> text, int x, int y) {
-        if (SkyblockAddonsTransformer.isLabymodClient()) { // There are no access transformers in labymod.
+        if (SkyblockAddonsSetup.isUsingLabyModClient()) { // There are no access transformers in labymod.
             try {
                 if (drawHoveringText == null) {
                     drawHoveringText = guiContainer.getClass().getSuperclass().getDeclaredMethod("a",

src/main/java/codes/biscuit/skyblockaddons/asm/hooks/GuiContainerHook.java

@@ -1,7 +1,7 @@
 package codes.biscuit.skyblockaddons.asm.hooks;
 
 import codes.biscuit.skyblockaddons.SkyblockAddons;
-import codes.biscuit.skyblockaddons.tweaker.SkyblockAddonsTransformer;
+import codes.biscuit.skyblockaddons.tweaker.SkyblockAddonsSetup;
 import net.minecraft.client.Minecraft;
 import net.minecraft.command.ICommandSender;
 import net.minecraft.util.IChatComponent;
@@ -11,7 +11,7 @@ public class GuiNewChatHook {
     public static String getUnformattedText(IChatComponent iChatComponent) {
         SkyblockAddons main = SkyblockAddons.getInstance();
         ICommandSender player = Minecraft.getMinecraft().thePlayer;
-        if (main != null && SkyblockAddonsTransformer.isDeobfuscated() || (player != null && player.getName().equals("Biscut"))) {
+        if (main != null && SkyblockAddonsSetup.isDeobfuscatedEnvironment() || (player != null && player.getName().equals("Biscut"))) {
             return iChatComponent.getFormattedText(); // makes it easier for debugging
         }
         return iChatComponent.getUnformattedText();

src/main/java/codes/biscuit/skyblockaddons/asm/hooks/GuiNewChatHook.java

@@ -9,7 +9,6 @@
 import codes.biscuit.skyblockaddons.features.craftingpatterns.CraftingPattern;
 import codes.biscuit.skyblockaddons.features.craftingpatterns.CraftingPatternResult;
 import codes.biscuit.skyblockaddons.utils.*;
-import codes.biscuit.skyblockaddons.utils.ItemUtils;
 import net.minecraft.block.Block;
 import net.minecraft.client.Minecraft;
 import net.minecraft.entity.player.EntityPlayer;

src/main/java/codes/biscuit/skyblockaddons/asm/hooks/PlayerControllerMPHook.java

@@ -1,7 +1,7 @@
 package codes.biscuit.skyblockaddons.asm.hooks;
 
 import codes.biscuit.skyblockaddons.SkyblockAddons;
-import codes.biscuit.skyblockaddons.tweaker.SkyblockAddonsTransformer;
+import codes.biscuit.skyblockaddons.tweaker.SkyblockAddonsSetup;
 import net.minecraft.client.audio.ISound;
 import net.minecraft.client.audio.SoundCategory;
 import net.minecraft.client.audio.SoundManager;
@@ -19,7 +19,7 @@ public static float getNormalizedVolume(SoundManager soundManager, ISound sound,
         if (main != null && main.getUtils() != null && main.getUtils().isPlayingSound()) {
             return 1;
         } else {
-            if (SkyblockAddonsTransformer.isLabymodClient()) { // There are no access transformers in labymod.
+            if (SkyblockAddonsSetup.isUsingLabyModClient()) { // There are no access transformers in LabyMod.
                 try {
                     if (getNormalizedVolume == null) {
                         getNormalizedVolume = soundManager.getClass().getDeclaredMethod("a", ISound.class, SoundPoolEntry.class, SoundCategory.class);