Skip to content

Latest commit

 

History

History
141 lines (99 loc) · 10.4 KB

README.md

File metadata and controls

141 lines (99 loc) · 10.4 KB
Raw

plugin-hub Discord

This repository contains markers for RuneLite plugins that are not supported by the RuneLite Developers. The plugins are provided "as is"; we make no guarantees about any plugin in this repo.

Setting up the development environment

We recommend IntelliJ Idea Community Edition as well as Java 11. You can either have IntelliJ install Java (select Eclipse Temurin) or download it from https://adoptium.net/temurin/releases/.

Creating new plugins

There are two methods to create an external plugin, you can either:

  • Use this plugin template.

  • Clone this repository and run the create_new_plugin.py script. This requires you to have python3 installed

Using the template repository

  1. Generate your own repository with this link. You have to be logged in to GitHub.

  2. Name your repository something appropriate, in my case I will name it helmet-check with the description You should always wear a helmet. Make sure that your repository is set to public.

  3. In the top right, you will see a Clone or download-button. Click on it and copy the link.

  4. Open IntelliJ and choose Get from Version Control. Paste the link you just copied in the URL field and where you want to save it in the second field.

  5. In order to make sure everything works correctly, try to start the client with your external plugin enabled by running the provided test. If you don't have a run configuration yet for the test, attempt to run it by clicking Run test. This will create a run configuration and fail to run due to asserts being disabled. Add -ea to your VM options in the run configuration to enable assertions, which can be found under Run/Debug Configurations under Modify options, Add VM options, and then adding -ea into the input field which appears.

The client should now launch with your plugin enabled. If you have a Jagex account, you will be unable to login without first following this guide.

run-test

  1. Use the refactor tool to rename the package to what you want your plugin to be. Rightclick the package in the sidebar and choose Refactor > Rename. I choose to rename it to com.helmetcheck.

  2. Use the same tool, Refactor > Rename, to rename ExamplePlugin, ExampleConfig and ExamplePluginTest to HelmetCheckPlugin etc.

  3. Go to your plugin file and set its name in the PluginDescriptor, this can have spaces.

  4. Open the runelite-plugin.properties file and add info to each row.

displayName=Helmet check
author=dekvall
description=Alerts you when you have nothing equipped in your head slot
tags=hint,gear,head
plugins=com.helmetcheck.HelmetCheckPlugin

tags will make it easier to find your plugin when searching for related words. If you want to add multiple plugin files, the plugins field allows for comma separated values, but this is not usually needed.

  1. Optionally, you can add an icon to be displayed alongside with your plugin. Place a file with the name icon.png no larger than 48x72 px at the root of the repository.

  2. Write a nice README so your users can see the features of your plugin.

  3. When you have your plugin working. Commit your changes and push them to your repository.

Using the script

  1. Navigate to the folder in which you cloned the plugin-hub repository.

  2. Run the script with:

python3 create_new_plugin.py [--output_directory OUTPUT_DIRECTORY]

It will ask you a series of questions, and then generate a folder with the name of your plugin.

  1. Move the generated folder to its own git repository and open the build.gradle file in IntelliJ.

  2. In order to make sure everything works correctly, try to start the client with your external plugin enabled by running the provided test. If you don't have a run configuration yet for the test, attempt to run it by clicking Run test. This will create a run configuration and fail to run due to asserts being disabled. Add -ea to your VM options in the run configuration to enable assertions, which can be found under Run/Debug Configurations under Modify options, Add VM options, and then adding -ea into the input field which appears.

The client should now launch with your plugin enabled. If you have a Jagex account, you will be unable to login without first following this guide.

run-test

  1. Edit runelite-plugin.properties with tags. tags will make it easier to find your plugin when searching for related words. If you want to add multiple plugin files, the plugins field allows for comma separated values, but this is not usually needed.

  2. Optionally, you can add an icon to be displayed alongside with your plugin. Place a file with the name icon.png no larger than 48x72 px at the root of the repository.

  3. Write a nice README so your users can see the features of your plugin.

  4. When you have your plugin working. Commit your changes and push them to your repository.

Licensing your repository

  1. Go to your repository on GitHub and select Add file (next to the green Code button), and choose Create new file from the drop-down.
  2. In the file name field type LICENSE and click the Choose a license template button that will appear.
  3. Select BSD 2-Clause "Simplified" License from the list to the left. Fill in your details and press Review and submit.
  4. Commit your changes by clicking Commit changes at the bottom of the page. Make sure you check the button to directly commit to the master branch.

Submitting a plugin

  1. Fork the plugin-hub repository.
  2. Create a new branch for your plugin.
  3. Create a new file in the plugin-hub/plugins directory with the fields:
repository=
commit=

  1. To get the repository url, click the Clone or download-button choose Use HTTPS. Paste the url in in the repository= field.

  2. To get the commit hash, go to your plugin repository on GitHub and click on commits. Choose the latest one and copy the full 40-character hash. It can be seen in the top right after selecting a commit. Paste this into the commit= field of the file. Your file should now look something like this:

repository=https://github.com/dekvall/helmet-check.git
commit=9db374fc205c5aae1f99bd5fd127266076f40ec8

  1. This is the only change you need to make, so commit your changes and push them to your fork. Then go back to the plugin-hub and click New pull request in the upper left. Choose Compare across forks and select your fork and branch as head and compare.

  2. Write a short description of what your plugin does and then create your pull request.

  3. Check the result of your PR's CI workflow. With a ✔️ all is good, however if it has a ❌ next to your commit click it to check the build log for details of the failure. Once you've read over the build error, make the required changes, and push another commit to update the PR with the new commit= hash.
    Don't worry about how many times it takes you to resolve build errors; we prefer all changes be kept in a single pull request to avoid spamming notifications with further newly-opened PRs.

  4. Be patient and wait for your plugin to be reviewed and merged.

Updating a plugin

To update a plugin, simply update the manifest with the most recent commit hash.

Reviewing

We will review your plugin to ensure it isn't malicious, doesn't break Jagex's rules, or isn't one of our previously Rejected/Rolledback features.
If it is difficult for us to ensure the plugin isn't against the rules we will not merge it.

Plugin resources

Resources may be included with plugins, which are non-code and are bundled and distributed with the plugin, such as images and sounds. You may do this by placing them in src/main/resources. Plugins on the pluginhub are distributed in .jar form and the jars placed into the classpath. The plugin is not unpacked on disk, and you can not assume that it is. This means that using https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html#getResource-java.lang.String- will return a jar-URL when the plugin is deployed to the pluginhub, but in your IDE will be a file-URL. This almost certainly makes it behave differently from how you expect it to, and isn't what you want. Instead, prefer using https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html#getResourceAsStream-java.lang.String-.

Third party dependencies

We require any dependencies that are not a transitive dependency of runelite-client to be have their cryptographic hash verified during the build to prevent supply chain attacks and ensure build reproducability. To do this we rely on Gradle's dependency verification. To add a new dependency, add it to the thirdParty configuration in package/verification-template/build.gradle, then run ../gradlew --write-verification-metadata sha256 to update the metadata file. A maintainer must then verify the dependencies manually before your pull request will be merged.

My client version is outdated

If your client version is outdated or your plugin suddenly stopped working after RuneLite has been updated, make sure that your runeLiteVersion is set to 'latest.release' in build.gradle. If this is set correctly, refresh the Gradle dependencies by doing the following:

  1. Open the Gradle tool window.
  2. Right-click on the project's name. This will contain the Gradle icon (elephant).
  3. Choose Refresh Gradle Dependencies. If your issue is not resolved, try reloading all Gradle projects. This option is located in the toolbar in the Gradle tool window. Additionally, try invalidating caches.