Using my Sidebar Reordering Changes For Testing

I provide two methods: one is a bit more involved but allows you be in control and build the package yourself, the other is more straightforward but you run a compiled .jar file that I built, which means you do have to trust I didn't put anything malevolent in the file

• I didn't add anything malevolant. I'm not a java dev, I had a hard enough time changing things to make an icon and drag it. I just want everyone to be able to try out these changes as easily as possible, regardless of technical skill. The code is built from my repo that you can view publicly. You can even compare what changes have been brought in by browsing the current Pull Request for my changes.

The Right Way

1. Follow Runelite's documentation for installing Java, installing Intellij code editor, and configuring the project to build: https://github.com/runelite/runelite/wiki/Building-with-IntelliJ-IDEA
   1. In "Getting started", click the link they provide for JDK 11. Download and install for your platform, accepting defaults.
      1. If on Windows, log out and log back in to allow Windows to properly apply the new Java to the system variables.
      2. Make sure your java command can be found by running java --version and checking it outputs its version information. If it says something like "unable to find java", you'll need to ensure Java is on your PATH. google this for answers specific to your platform/OS.
   2. When following the "Importing the Project" step, instead of copying Runelite's url, you need to copy mine with the Sidebar Changes in it, https://github.com/swirle13/runelite.git
      1. Once you've cloned my repo, you need to change the branch from "master" to "reorder-sidebar-testing" to switch to the branch with the sidebar reordering features in it by clicking the top bar that says "master" and click "Remote" scroll down and select "reorder-sidebar-testing" and choose "Checkout"
      2. Check the "Run/Debug Configurations" dropdown in the top right. It will say "Current File" by default. Switch to "RuneLite". If you don't see "RuneLite" in the dropdown menu, close and reopen Intellij so Intellij can find it.
   3. In "Configuring the project", instead of downloading a duplicate JDK, you can select the JDK we installed earlier, Eclipse Temurin, under "Detected SDKs"
   4. When you get to "Building the project", if you want to use an account that uses a Jagex account, please follow Runelite's guide before building: https://github.com/runelite/runelite/wiki/Using-Jagex-Accounts
2. Once you've successfully built Runelite once, you now have ensured you have everything set up properly to build the standalone .jar to use
3. Create the standalone file that contains the sidebar reordering changes

   1. Open a terminal, if not already open

      

   2. At the root of the project folder, run ./gradlew shadowJar

      1. This generates the standalone .jar file that you can use to run without needing Intellij open/running.
      2. It will be created at runelite-client/build/libs/client-1.12.21-SNAPSHOT-shaded.jar
      3. If you desire an easier location to run the .jar from, copy it to wherever you prefer
      4. You can now run this file with the java terminal command
4. Run the new .jar file
   1. Run the .jar file, updating the command with the path to your shaded jar
      1. To copy the path from within Intellij, right click the file > "Copy Path/Reference" > Absolute Path (to make things easier when running from anywhere else)
   2. Windows:
      1. Run java -jar -D"runelite.pluginhub.version=1.12.20" -ea /PATH/TO/YOUR/CLIENT/SHADED.jar
   3. Mac:
      1. Run java -jar -Drunelite.pluginhub.version=1.12.20 -ea /PATH/TO/YOUR/CLIENT/SHADED.jar

Enjoy your plugins and your Jagex account loading in with the new sidebar reordering functionality!

Tip

You can make the script easier to run by creating a shortcut that runs the above command. See Creating a Shortcut.

The Easy Way

1. Install Java 11, via Runelite's suggested link: https://adoptium.net/temurin/releases/?version=11
   1. If on Windows, log out and log back in to allow Windows to properly apply the new Java to the system variables.
   2. Make sure your java command can be found by running java --version and checking it outputs its version information. If it says something like "unable to find java", you'll need to ensure Java is on your PATH. You can google this for answers specific to your platform/OS.
2. If you want to use your Jagex-account backed runescape account with this, you need to follow RuneLite's official instructions: https://github.com/runelite/runelite/wiki/Using-Jagex-Accounts
3. You need to get my code locally

   1. If you have git installed and know how to use it

      1. Run

         git clone https://github.com/swirle13/runelite.git
         git checkout reorder-sidebar-testing

   2. If you don't have git or just want to make things easier

      1. Open https://github.com/swirle13/runelite/tree/reorder-sidebar-testing in your browser
      2. Make sure the blue dropdown list on the left side says "reorder-sidebar-testing"
      3. Click green "Code" button
      4. Click "Download ZIP"
      5. Extract the folder wherever you'd like
4. Run the pre-compiled .jar file
   1. I have built and provided the jar file that the steps in The Right Way would generate for you. It can be found at runelite/client-1.12.21-SNAPSHOT-shaded.jar
   2. Run the .jar file, updating the command with the path to your shaded jar
      1. To copy the path from within Intellij, right click the file > "Copy Path/Reference" > Absolute Path (to make things easier when running from anywhere else)
      2. Windows:
         1. Run java -jar -D"runelite.pluginhub.version=1.12.20" -ea /PATH/TO/YOUR/runelite/client-1.12.21-SNAPSHOT-shaded.jar
      3. Mac:
         1. Run java -jar -Drunelite.pluginhub.version=1.12.20 -ea /PATH/TO/YOUR/runelite/client-1.12.21-SNAPSHOT-shaded.jar

Enjoy your plugins and your Jagex account loading in with the new sidebar reordering functionality!

Tip

You can make the script easier to run by creating a shortcut that runs the above command. See Creating a Shortcut.

Creating a Shortcut

You can make the script easier to run by creating a shortcut that runs the above command.

1. Windows
   1. Right-click on an empty area of your desktop.
   2. Select New > Shortcut from the context menu.
   3. In the "Type the location of the item" field, enter the following command
      1. %ComSpec% /c java -jar -D"runelite.pluginhub.version=1.12.20" -ea /PATH/TO/YOUR/CLIENT/SHADED.jar
      2. This opens Command Prompt (%ComSpec%), sets a flag to close the window when Runelite closes (/c), and runs the java command from above.
   4. Set the name to whatever you want, like "runelite_sidebar"
   5. Double click the file to run
2. Mac
   1. In Intellij terminal run cd ~/Desktop to change terminal location to your desktop
   2. Run nano runelite_sidebar.command to create a new script file and open it
   3. Paste into the editor your command from above: java -jar -Drunelite.pluginhub.version=1.12.20 -ea /PATH/TO/YOUR/CLIENT/SHADED.jar
   4. Press Ctrl+O to save the file (not Cmd+O)
   5. Press Enter to confirm the file name
   6. Press Ctrl+X to exit (not Cmd+X)
   7. Give the file permissions to run: chmod +x runelite_sidebar.command
   8. Run the script by double clicking on the file on your desktop or by running the command ./runelite_sidebar.command