Skip to content

Commit

Permalink
Building-with-IntelliJ: update pluginhub instructions (#127)
Browse files Browse the repository at this point in the history
  • Loading branch information
swirle13 authored Oct 25, 2024
1 parent 00d0d19 commit 8762e38
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion Building-with-IntelliJ-IDEA.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,9 @@ If you've followed all instructions correctly, try deleting the `%TEMP%/cache-16

## Pluginhub failing to load

This happens because the development versions are snapshot versions, whereas we only provide builds of pluginhub plugins for stable releases of RuneLite. Usually you can pass `-Drunelite.pluginhub.version=<current RL version>` as a VM option to load the plugins built against the release into your build, which will work if there are no ABI changes. If there are ABI changes, build the plugins yourself and place them into the `sideloaded-plugins` directory when running in developer mode.
Hub plugins are not available by default when developing with snapshot versions, as they are only built for stable releases of RuneLite. Usually you can pass `-Drunelite.pluginhub.version=<current RL version>` as a VM option (to enable VM Options, follow the guide in [[Using the client developer tools]]) to load the plugins built against the release into your build, which will work if there are no [Application Binary Interface](https://en.wikipedia.org/wiki/Application_binary_interface) (ABI) changes.

How can you tell if there are ABI changes? If some existing core API changes or is removed e.g. if we remove some `Client` method which a hub plugin uses, the RuneLite client will crash when a hub plugin loaded this way tries to run it. If there are ABI changes, build the plugins yourself and place them into the `sideloaded-plugins` directory when running in developer mode.

## Client failing to start

Expand Down

0 comments on commit 8762e38

Please sign in to comment.