├── .gitignore ├── README.md ├── build.gradle ├── gradle.properties ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── settings.gradle └── src └── main ├── java └── com │ └── example │ ├── AddonExample.java │ └── commands │ └── AddonCommand.java └── resources └── addon.json /.gitignore: -------------------------------------------------------------------------------- 1 | # eclipse 2 | eclipse 3 | bin 4 | *.launch 5 | .settings 6 | .metadata 7 | .classpath 8 | .project 9 | 10 | # idea 11 | out 12 | classes 13 | *.ipr 14 | *.iws 15 | *.iml 16 | .idea 17 | 18 | # gradle 19 | build 20 | .gradle 21 | 22 | #Netbeans 23 | .nb-gradle 24 | .nb-gradle-properties 25 | 26 | # other 27 | run 28 | .DS_Store 29 | Thumbs.db -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ## Hyperium Addon Workspace 2 | 3 | Hyperium uses a system called addons, which allow you to add whatever you'd like to the client. 4 | 5 | ### Getting Started 6 | 7 | To get started, first you want to either clone or download the addon workspace from here, 8 | open it in an IDE that supports Java or Kotlin (preferably [IntelliJ](https://www.jetbrains.com/idea/)), and import the `build.gradle` file. 9 | 10 | Likely, at first you won't have access to the decompiled Minecraft code. To fix this, all you have to do 11 | is open the Gradle tab on the right side of your screen. Open the dropdown menu, `Tasks`, `forgegradle`, and run `setupDecompWorkspace`. 12 | 13 | After this, refresh your gradle deps using the button that looks like two arrows spinning around eachother. 14 | Once you've done that, you can open `Tasks`, `forgegradle`, and run `genIntellijRuns`. This is going to create the base for 15 | running the client once you're ready to test something. 16 | 17 | Test to see if it setup properly by going into the top right and seeing a dropdown menu saying `Minecraft Client`, beside that is a green arrow. 18 | Press the arrow, if it starts up, you're all good, otherwise, click on the dropdown menu, and where it says `Use classpath of module: %WORKSPACE_NAME%`, 19 | you will want to change that to be `%WORKSPACE_NAME%.main`. An example of this would be `ExampleAddon.main`. 20 | 21 | At this point, you should be good to go. 22 | 23 | If you wish to login to your account to test something on a server, open the dropdown menu saying Minecraft Client, and insert 24 | `--username (username/email) --password (password)` then run the client. 25 | 26 | ### Addon Manifests 27 | 28 | All of your addon information will go into `resources/addon.json`. 29 | 30 | Listed below is all of the manifest information, and an example provided. 31 | 32 | * **name**: The name of your addon. **ExampleAddon** 33 | * **version**: The version of your addon. **1.0** 34 | * **mainClass**: The path to the main class of your addon. **com.example.AddonExample** 35 | * **desc**: A description of your addon. **This is an addon that is made for an example.** 36 | * **versionCode**: MUST match up to the client's versionCode. **The current versionCode is available in `AddonMinecraftBootstrap#VERSION_CODE`** 37 | 38 | 39 | ### Examples 40 | 41 | An example of a completed addon.json file is below. 42 | 43 | ```json 44 | { 45 | "name":"Addon Example", 46 | "version":"1.0", 47 | "mainClass":"com.example.AddonExample", 48 | "desc":"Hyperium Addon Example", 49 | "versionCode": "1.0" 50 | } 51 | ``` 52 | 53 | An example of a basic addon is below. 54 | 55 | ```java 56 | // All addons must implement IAddon 57 | public class AddonExample implements IAddon { 58 | 59 | /** 60 | * Invoked once the plugin has successfully loaded 61 | * {@link cc.hyperium.internal.addons.AddonMinecraftBootstrap#init} 62 | */ 63 | @Override 64 | public void onLoad() { 65 | // Log that the addon has loaded 66 | Hyperium.LOGGER.info("Successfully loaded Addon!"); 67 | 68 | // Register the class to the EventBus 69 | EventBus.INSTANCE.register(this); 70 | } 71 | 72 | @InvokeEvent 73 | public void onInitialization(InitializationEvent event) { 74 | // Register a command on initialization 75 | Hyperium.INSTANCE.getHandlers().getCommandHandler().registerCommand(new AddonCommand()); 76 | } 77 | 78 | @InvokeEvent 79 | public void onChatMessage(ChatEvent event) { 80 | // If any chat message contains "secret message!" 81 | if (event.getChat().getUnformattedText().contains("secret message!")) { 82 | //Toggle fullscreen 83 | Minecraft.getMinecraft().toggleFullscreen(); 84 | } 85 | } 86 | 87 | /** 88 | * Invoked once the game has been closed 89 | * this is executed at the start of {@link net.minecraft.client.Minecraft#shutdown} 90 | */ 91 | @Override 92 | public void onClose() { 93 | // Log that the addon is being closed 94 | Hyperium.LOGGER.info("Closing..."); 95 | } 96 | 97 | /** 98 | * Invoked on debug call. Can be used to add things into crash reports 99 | *

100 | * This does not need to be overriden if it's not needed 101 | */ 102 | @Override 103 | public void sendDebugInfo() { 104 | } 105 | } 106 | ``` 107 | 108 | An example of a basic addon command is below. 109 | 110 | ```java 111 | public class AddonCommand implements BaseCommand { 112 | 113 | /** 114 | * Gets the name of the command 115 | */ 116 | @Override 117 | public String getName() { 118 | return "addon_example"; 119 | } 120 | 121 | /** 122 | * Gets the usage string for the command. 123 | */ 124 | @Override 125 | public String getUsage() { 126 | return "/" + getName(); 127 | } 128 | 129 | /** 130 | * Callback when the command is invoked 131 | * 132 | * @param args 133 | * @throws CommandException for errors inside the command, these errors 134 | * will log directly to the players chat (without a prefix) 135 | */ 136 | @Override 137 | public void onExecute(String[] args) throws CommandException { 138 | Minecraft.getMinecraft().toggleFullscreen(); 139 | } 140 | } 141 | ``` -------------------------------------------------------------------------------- /build.gradle: -------------------------------------------------------------------------------- 1 | group 'com.example' 2 | version '1.0-SNAPSHOT' 3 | 4 | buildscript { 5 | repositories { 6 | mavenCentral() 7 | jcenter() 8 | maven { 9 | name = "forge" 10 | url = "http://files.minecraftforge.net/maven" 11 | } 12 | maven { url "https://plugins.gradle.org/m2/" } 13 | } 14 | dependencies { 15 | classpath 'net.minecraftforge.gradle:ForgeGradle:2.1-SNAPSHOT' 16 | } 17 | } 18 | 19 | apply plugin: 'net.minecraftforge.gradle.tweaker-client' 20 | apply plugin: 'java' 21 | 22 | sourceCompatibility = targetCompatibility = 1.8 23 | compileJava.options.encoding = 'UTF-8' 24 | 25 | minecraft { 26 | version = "1.8.9" 27 | tweakClass = "cc.hyperium.launch.HyperiumTweaker" 28 | mappings = "stable_22" 29 | runDir = 'run' 30 | makeObfSourceJar = false 31 | } 32 | 33 | repositories { 34 | maven { url 'https://jitpack.io' } 35 | } 36 | 37 | dependencies { 38 | compile 'com.github.HyperiumClient:Hyperium:master-SNAPSHOT' 39 | } 40 | -------------------------------------------------------------------------------- /gradle.properties: -------------------------------------------------------------------------------- 1 | org.gradle.daemon=true 2 | org.gradle.parallel=true 3 | org.gradle.configureoncommand=true 4 | org.gradle.parallel.threads=4 5 | org.gradle.jvmargs=-Xmx2G -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HyperiumClient/Addon-Workspace/962f8df0045b3810525d4f3dfb04dab65c8dfd07/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | #Fri Jun 08 18:20:37 IST 2018 2 | distributionBase=GRADLE_USER_HOME 3 | distributionPath=wrapper/dists 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | distributionUrl=https\://services.gradle.org/distributions/gradle-4.10.3-bin.zip 7 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | ############################################################################## 4 | ## 5 | ## Gradle start up script for UN*X 6 | ## 7 | ############################################################################## 8 | 9 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 10 | DEFAULT_JVM_OPTS="" 11 | 12 | APP_NAME="Gradle" 13 | APP_BASE_NAME=`basename "$0"` 14 | 15 | # Use the maximum available, or set MAX_FD != -1 to use that value. 16 | MAX_FD="maximum" 17 | 18 | warn ( ) { 19 | echo "$*" 20 | } 21 | 22 | die ( ) { 23 | echo 24 | echo "$*" 25 | echo 26 | exit 1 27 | } 28 | 29 | # OS specific support (must be 'true' or 'false'). 30 | cygwin=false 31 | msys=false 32 | darwin=false 33 | case "`uname`" in 34 | CYGWIN* ) 35 | cygwin=true 36 | ;; 37 | Darwin* ) 38 | darwin=true 39 | ;; 40 | MINGW* ) 41 | msys=true 42 | ;; 43 | esac 44 | 45 | # Attempt to set APP_HOME 46 | # Resolve links: $0 may be a link 47 | PRG="$0" 48 | # Need this for relative symlinks. 49 | while [ -h "$PRG" ] ; do 50 | ls=`ls -ld "$PRG"` 51 | link=`expr "$ls" : '.*-> \(.*\)$'` 52 | if expr "$link" : '/.*' > /dev/null; then 53 | PRG="$link" 54 | else 55 | PRG=`dirname "$PRG"`"/$link" 56 | fi 57 | done 58 | SAVED="`pwd`" 59 | cd "`dirname \"$PRG\"`/" >&- 60 | APP_HOME="`pwd -P`" 61 | cd "$SAVED" >&- 62 | 63 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 64 | 65 | # Determine the Java command to use to start the JVM. 66 | if [ -n "$JAVA_HOME" ] ; then 67 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 68 | # IBM's JDK on AIX uses strange locations for the executables 69 | JAVACMD="$JAVA_HOME/jre/sh/java" 70 | else 71 | JAVACMD="$JAVA_HOME/bin/java" 72 | fi 73 | if [ ! -x "$JAVACMD" ] ; then 74 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 75 | 76 | Please set the JAVA_HOME variable in your environment to match the 77 | location of your Java installation." 78 | fi 79 | else 80 | JAVACMD="java" 81 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 82 | 83 | Please set the JAVA_HOME variable in your environment to match the 84 | location of your Java installation." 85 | fi 86 | 87 | # Increase the maximum file descriptors if we can. 88 | if [ "$cygwin" = "false" -a "$darwin" = "false" ] ; then 89 | MAX_FD_LIMIT=`ulimit -H -n` 90 | if [ $? -eq 0 ] ; then 91 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then 92 | MAX_FD="$MAX_FD_LIMIT" 93 | fi 94 | ulimit -n $MAX_FD 95 | if [ $? -ne 0 ] ; then 96 | warn "Could not set maximum file descriptor limit: $MAX_FD" 97 | fi 98 | else 99 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 100 | fi 101 | fi 102 | 103 | # For Darwin, add options to specify how the application appears in the dock 104 | if $darwin; then 105 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 106 | fi 107 | 108 | # For Cygwin, switch paths to Windows format before running java 109 | if $cygwin ; then 110 | APP_HOME=`cygpath --path --mixed "$APP_HOME"` 111 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` 112 | JAVACMD=`cygpath --unix "$JAVACMD"` 113 | 114 | # We build the pattern for arguments to be converted via cygpath 115 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` 116 | SEP="" 117 | for dir in $ROOTDIRSRAW ; do 118 | ROOTDIRS="$ROOTDIRS$SEP$dir" 119 | SEP="|" 120 | done 121 | OURCYGPATTERN="(^($ROOTDIRS))" 122 | # Add a user-defined pattern to the cygpath arguments 123 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then 124 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" 125 | fi 126 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 127 | i=0 128 | for arg in "$@" ; do 129 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` 130 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option 131 | 132 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition 133 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` 134 | else 135 | eval `echo args$i`="\"$arg\"" 136 | fi 137 | i=$((i+1)) 138 | done 139 | case $i in 140 | (0) set -- ;; 141 | (1) set -- "$args0" ;; 142 | (2) set -- "$args0" "$args1" ;; 143 | (3) set -- "$args0" "$args1" "$args2" ;; 144 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;; 145 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; 146 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; 147 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; 148 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; 149 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; 150 | esac 151 | fi 152 | 153 | # Split up the JVM_OPTS And GRADLE_OPTS values into an array, following the shell quoting and substitution rules 154 | function splitJvmOpts() { 155 | JVM_OPTS=("$@") 156 | } 157 | eval splitJvmOpts $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS 158 | JVM_OPTS[${#JVM_OPTS[*]}]="-Dorg.gradle.appname=$APP_BASE_NAME" 159 | 160 | exec "$JAVACMD" "${JVM_OPTS[@]}" -classpath "$CLASSPATH" org.gradle.wrapper.GradleWrapperMain "$@" 161 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @if "%DEBUG%" == "" @echo off 2 | @rem ########################################################################## 3 | @rem 4 | @rem Gradle startup script for Windows 5 | @rem 6 | @rem ########################################################################## 7 | 8 | @rem Set local scope for the variables with windows NT shell 9 | if "%OS%"=="Windows_NT" setlocal 10 | 11 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 12 | set DEFAULT_JVM_OPTS= 13 | 14 | set DIRNAME=%~dp0 15 | if "%DIRNAME%" == "" set DIRNAME=. 16 | set APP_BASE_NAME=%~n0 17 | set APP_HOME=%DIRNAME% 18 | 19 | @rem Find java.exe 20 | if defined JAVA_HOME goto findJavaFromJavaHome 21 | 22 | set JAVA_EXE=java.exe 23 | %JAVA_EXE% -version >NUL 2>&1 24 | if "%ERRORLEVEL%" == "0" goto init 25 | 26 | echo. 27 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 28 | echo. 29 | echo Please set the JAVA_HOME variable in your environment to match the 30 | echo location of your Java installation. 31 | 32 | goto fail 33 | 34 | :findJavaFromJavaHome 35 | set JAVA_HOME=%JAVA_HOME:"=% 36 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 37 | 38 | if exist "%JAVA_EXE%" goto init 39 | 40 | echo. 41 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 42 | echo. 43 | echo Please set the JAVA_HOME variable in your environment to match the 44 | echo location of your Java installation. 45 | 46 | goto fail 47 | 48 | :init 49 | @rem Get command-line arguments, handling Windowz variants 50 | 51 | if not "%OS%" == "Windows_NT" goto win9xME_args 52 | if "%@eval[2+2]" == "4" goto 4NT_args 53 | 54 | :win9xME_args 55 | @rem Slurp the command line arguments. 56 | set CMD_LINE_ARGS= 57 | set _SKIP=2 58 | 59 | :win9xME_args_slurp 60 | if "x%~1" == "x" goto execute 61 | 62 | set CMD_LINE_ARGS=%* 63 | goto execute 64 | 65 | :4NT_args 66 | @rem Get arguments from the 4NT Shell from JP Software 67 | set CMD_LINE_ARGS=%$ 68 | 69 | :execute 70 | @rem Setup the command line 71 | 72 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 73 | 74 | @rem Execute Gradle 75 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% 76 | 77 | :end 78 | @rem End local scope for the variables with windows NT shell 79 | if "%ERRORLEVEL%"=="0" goto mainEnd 80 | 81 | :fail 82 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 83 | rem the _cmd.exe /c_ return code! 84 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 85 | exit /b 1 86 | 87 | :mainEnd 88 | if "%OS%"=="Windows_NT" endlocal 89 | 90 | :omega 91 | -------------------------------------------------------------------------------- /settings.gradle: -------------------------------------------------------------------------------- 1 | rootProject.name = 'ExampleAddon' 2 | 3 | -------------------------------------------------------------------------------- /src/main/java/com/example/AddonExample.java: -------------------------------------------------------------------------------- 1 | package com.example; 2 | 3 | import cc.hyperium.Hyperium; 4 | import cc.hyperium.event.EventBus; 5 | import cc.hyperium.event.InvokeEvent; 6 | import cc.hyperium.event.client.InitializationEvent; 7 | import cc.hyperium.event.network.chat.ChatEvent; 8 | import cc.hyperium.internal.addons.IAddon; 9 | import com.example.commands.AddonCommand; 10 | import net.minecraft.client.Minecraft; 11 | 12 | // All addons must implement IAddon 13 | public class AddonExample implements IAddon { 14 | 15 | /** 16 | * Invoked once the plugin has successfully loaded 17 | * {@link cc.hyperium.internal.addons.AddonMinecraftBootstrap#init} 18 | */ 19 | @Override 20 | public void onLoad() { 21 | // Log that the addon has loaded 22 | Hyperium.LOGGER.info("Successfully loaded Addon!"); 23 | 24 | // Register the class to the EventBus 25 | EventBus.INSTANCE.register(this); 26 | } 27 | 28 | @InvokeEvent 29 | public void onInitialization(InitializationEvent event) { 30 | // Register a command on initialization 31 | Hyperium.INSTANCE.getHandlers().getCommandHandler().registerCommand(new AddonCommand()); 32 | } 33 | 34 | @InvokeEvent 35 | public void onChatMessage(ChatEvent event) { 36 | // If any chat message contains "secret message!" 37 | if (event.getChat().getUnformattedText().contains("secret message!")) { 38 | //Toggle fullscreen 39 | Minecraft.getMinecraft().toggleFullscreen(); 40 | } 41 | } 42 | 43 | /** 44 | * Invoked once the game has been closed 45 | * this is executed at the start of {@link net.minecraft.client.Minecraft#shutdown} 46 | */ 47 | @Override 48 | public void onClose() { 49 | // Log that the addon is being closed 50 | Hyperium.LOGGER.info("Closing..."); 51 | } 52 | 53 | /** 54 | * Invoked on debug call. Can be used to add things into crash reports 55 | *

56 | * This does not need to be overriden if it's not needed 57 | */ 58 | @Override 59 | public void sendDebugInfo() { 60 | } 61 | } 62 | -------------------------------------------------------------------------------- /src/main/java/com/example/commands/AddonCommand.java: -------------------------------------------------------------------------------- 1 | package com.example.commands; 2 | 3 | import cc.hyperium.commands.BaseCommand; 4 | import cc.hyperium.commands.CommandException; 5 | import net.minecraft.client.Minecraft; 6 | 7 | public class AddonCommand implements BaseCommand { 8 | 9 | /** 10 | * Gets the name of the command 11 | */ 12 | @Override 13 | public String getName() { 14 | return "addon_example"; 15 | } 16 | 17 | /** 18 | * Gets the usage string for the command. 19 | */ 20 | @Override 21 | public String getUsage() { 22 | return "/" + getName(); 23 | } 24 | 25 | /** 26 | * Callback when the command is invoked 27 | * 28 | * @param args 29 | * @throws CommandException for errors inside the command, these errors 30 | * will log directly to the players chat (without a prefix) 31 | */ 32 | @Override 33 | public void onExecute(String[] args) throws CommandException { 34 | Minecraft.getMinecraft().toggleFullscreen(); 35 | } 36 | } 37 | -------------------------------------------------------------------------------- /src/main/resources/addon.json: -------------------------------------------------------------------------------- 1 | { 2 | "name":"Addon Example", 3 | "version":"1.0", 4 | "mainClass":"com.example.AddonExample", 5 | "desc":"Hyperium Addon Example", 6 | "versionCode": "1.0" 7 | } 8 | --------------------------------------------------------------------------------