ScaleHackOpenSrc

<h1 align="center"><a href="https://github.com/scoliossis">scoliossis</a>/<a href="https://github.com/scoliossis/ScaleHackOpenSrc">ScaleHackV3</a></h1> <h2 align="center"> <a href="https://discord.gg/XWXVvdUGV8">Discord</a> | <a href="https://www.youtube.com/watch?v=JMErXxIYHsE">Showcase</a> | <a href="https://github.com/scoliossis/ScaleHackOpenSrc?tab=readme-ov-file#setup-in-intellij">Dev Setup</a> | <a href="https://github.com/scoliossis/ScaleHackOpenSrc?tab=readme-ov-file#rebranding">Rebranding</a> | <a href="https://github.com/scoliossis/ScaleHackOpenSrc?tab=readme-ov-file#usage">Example Module</a> </h2> <div align="center"> <img src="https://github.com/scoliossis/ScaleHackOpenSrc/blob/master/repo/gui.png?raw=true" alt="gui" /> </div>

I tried my best to give everything cute animations but Im sure people will still complain. Design is hard, make a pr with visuals <3

Feel free to create forks of the project, I won't be using much of the code myself, I don't need credit for any code used

I hope people new to Java can learn from this project, I tried my best to keep my code intuitive

---

Setup in IntelliJ

1. Clone the repo

   git clone https://github.com/scoliossis/ScaleHackOpenSrc
   

2. Open build.gradle in IntelliJ IDEA

   

3. Open Project Structure

   

   Set the SDK to any version of the Java 1.8 JDK

   

4. Use the "runClient" task to launch the game!

Rebranding

1. Change the properties in gradle.properties to your own branding

2. Refactor the mod group id (com.github.examplemod) using intellij, to be your "mod_group_id" in gradle.properties

3. Replace "examplemod" in the name of mixins.examplemod.json (src/main/rescources) with your mod id from gradle.properties

   Replace the "package" element in mixins.examplemod.json with your mod_group_id.mixins

   Replace "examplemod" in the "refmap" with your mod_id

4. Rename the "rootProject.name" in settings.gradle to whatever you want your project name to be!

5. done <3

Usage

Example Module

package com.github.examplemod.modules.impl.client;

import com.github.examplemod.modules.Category;
import com.github.examplemod.modules.Module;
import com.github.examplemod.modules.RegisterModule;
import com.github.examplemod.modules.RegisterSubModule;
import com.github.examplemod.events.SubscribeEvent;
import com.github.examplemod.events.impl.PlayerUpdateEvent;

@RegisterModule(
        name = "Module Name", 
        description = "Module Description", 
        category = Category.CLIENT,
        enabledByDefault = true
)
public class ModuleName extends Module {
    @RegisterSubModule(name = "Example Sub Module")
    public boolean exampleModule = false;

    @RegisterSubModule(
            name = "Example Sub Module with Parent", 
            parent = "Example Sub Module", 
            description = "This sub module is only shown when exampleModule is true"
    )
    public boolean exampleModuleWithParent = false;

    @RegisterSubModule(name = "Example Enum")
    public ExampleEnum exampleEnum = ExampleEnum.Mode;

   public enum ExampleEnum {
      Mode,
      Mode_2,
      Evil_Mode
   }
   
    @RegisterSubModule(
            name = "Example Slider with Enum Parent",
            parent = "Example Enum",
            modeParentString = {"Mode_2", "Evil_Mode"},
            description = "This sub module is only shown when exampleEnum is Mode_2 or Evil_Mode",
            min = 50,
            max = 500,
            increment = 25
    )
    public double exampleSlider = 0;
    
    @SubscribeEvent(priority = 1)
    public static void onPlayerUpdateEventHEAD(PlayerUpdateEvent event) {
        System.out.println("This is called first! and also only called if the module is enabled.");
    }

    @SubscribeEvent
    public static void onPlayerUpdateEvent(PlayerUpdateEvent event) {
       System.out.println("This is called middle! (default priority is 1000)");
       
       switch (exampleEnum) {
          case Mode:
              System.out.println("Example Slider is hidden right now, try changing the enum value.");
              break;
       }
    }
   
    @SubscribeEvent(priority = 9999)
    public static void onPlayerUpdateEventTAIL(PlayerUpdateEvent event) {
       System.out.println("This is called last!");
    }

    @Override protected void onEnable() {}
    @Override protected void onDisable() {}
}