Skip to content

Running the Development Version From Source

Matthew Thornton edited this page Apr 28, 2021 · 22 revisions

If you have not done so already, please follow the Running the Plugin From Source guide first. This will walk you through setting up the basic development environment needed to run any branch of this repository from the source code.


Making Sure You're on the Correct Branch

We like to keep our master branch as stable as possible, so impending updates to the plugin will most likely be found in our development branch.

If you've just followed our guide on Running the Plugin From Source, your editor should by default be set to use the development branch.

You can check to see if you are on the correct branch in the bottom-right corner of your Intellij IDEA window. The Intellij IDEA editor has checked out the develop branch from the Github Repo.

It should be set to the develop branch.

If it is set to the master branch, simply click on master in the bottom-right corner of your window, click on develop under Local Branches, and then select Checkout and Rebase onto Current.

Image detailing how to checkout our development branch.

Setting up VM Options

By default the plugin is set to use resources from our production API. This is normally fine, but often as we make changes to our development branch it necessitates altered functionality of the API. We do not want to risk breaking the version of the latest release of the plugin on RuneLite's Plugin Hub, so we have a separate instance of the API running for developer testing. It is HIGHLY recommended that you set your development environment to utilize the developer API address to be able to have the development version of the plugin operate correctly.

Navigate to the top of your editor and find the configuration dropdown menu, which is shown below:

If you have run our plugin from source before, you can simply edit the existing configuration. If not, you will not have any preexisting configurations and will need to create one.

Hit the + button in the top-right corner of the Edit Configurations window and select Application.

On Windows, you should set your configuration options to match the ones below:

On Linux, you may want to utilize OpenJDK instead:

The most important configuration option to set is to add -DBotDetectorAPIPath=https://www.osrsbotdetector.com/dev to VM Options. If you do not see a text field for VM Options press ALT+V to have it appear.

Clone this wiki locally