Creating new plugins with IntelliJ IDEA - open-osrs/runelite GitHub Wiki

OpenOSRS Plugins

This guide requires you to have built the OpenOSRS Client already, if not, please follow these guides: Building with IntelliJ-IDEA and Building the plugins with IntelliJ IDEA

Warning: This guide is not setup to be used with GitHub as I don't personally use it, if someone wishes to edit the guide to please feel free to do so.

  1. Down the test folder from https://github.com/open-osrs/example-external-plugin.

  2. Open IntelliJ IDEA and you will be presented with the Welcome to IntelliJ IDEA welcome screen, select OpenOSRS.

2.

  1. Wait for the Project to load. Once loaded, open the Project tab on the left side, and right click plugins [OpenOSRS Plugins] select Show in explorer.

3.

  1. This will open the folder where your plugins project is saved. Open the plugins folder and paste the test folder into it.

  2. Open IntelliJ IDEA, and in the Project folder on the left side, you should see test had now been included in the OpenOSRS plugins list.

5.

  1. In the same list, scroll down and open the file settings.gradle.kts.

  2. Scroll down to the bottom until you find the last include (which is probably zalcano). Paste include(":test") below, should you now see this. (You can paste it in the alphabetical order if you wish.)

7.

  1. Open the Gradle tab on the right, expand OpenOSRS > Tasks > build and right click on the build tab, select `Run 'runelite [build]'
  2. In the Building the plugins with IntelliJ IDEA guide when you replaced release with your path of choice in the build.gradle.kts file, that's where the .jar files will be located for the test plugin. Copy the test-x.x.x.jar file into your .runelite/externalmanager/ folder and start a new OpenOSRS Client (inside of IntelliJ IDEA or by running the OpenOSRS.exe).
  3. Open the OpenOSRS Plugin tab in the client and scroll down to find your new plugin, Test Plugin. 10.10a