mirror of
https://github.com/runelite/plugin-hub.git
synced 2026-01-28 00:03:44 -05:00
531a9a8554
This lets us have better control over which dependencies are verified, as changes to runelite-client's dependencies cause all Hub plugins with pinned deps to fail, as the new transitive deps aren't pinned. Moving this file into this repo not only lets us update it in these situations, but also means individual plugin authors don't need to touch Gradle's verification and all of it's associated pains. This also allows plugins to pull a dependency that another plugin pulls already with no extra work.
123 lines
7.3 KiB
Markdown
123 lines
7.3 KiB
Markdown
|
|
# plugin-hub [](https://discord.gg/mePCs8U)
|
|
|
|
This repository contains markers for [RuneLite](https://github.com/runelite/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.
|
|
|
|
|
|
## Creating new plugins
|
|
There are two methods to create an external plugin, you can either:
|
|
|
|
- Use [this](https://github.com/runelite/example-plugin/) plugin template.
|
|
|
|
- Clone this repository and run the `create_new_plugin.py` script. This requires you to have `python3` installed
|
|
|
|
**If you are using IntelliJ, you will need at least version 2017.3**
|
|
|
|
### Using the template repository
|
|
1. Generate your own repository with [this](https://github.com/runelite/example-plugin/generate) 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. Open `build.gradle` and edit `runeLiteVersion` from `1.5.44-SNAPSHOT` to the latest release. If you are unsure about the current version it's specified on [runelite.net](https://runelite.net/).
|
|
|
|
6. In order to make sure everything works correctly, try to start the client with your external plugin enabled by running the test.
|
|
|
|
|
|
|
|
7. 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`.
|
|
|
|
8. Use the same tool, *Refactor > Rename*, to rename `ExamplePlugin`, `ExampleConfig` and `ExamplePluginTest` to `HelmetCheckPlugin` etc.
|
|
|
|
9. Go to your plugin file and set it's name in the `PluginDescriptor`, this can have spaces.
|
|
|
|
10. Open the `runelite-plugin.properties` file and add info to each row.
|
|
```
|
|
displayName=Helmet check
|
|
author=dekvall
|
|
support=
|
|
description=Alerts you when you have nothing equipped in your head slot
|
|
tags=hint,gear,head
|
|
plugins=com.helmetcheck.HelmetCheckPlugin
|
|
```
|
|
`support` is the URL you want players to use to leave feedback for your plugin; by default this links to your repository. `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.
|
|
|
|
11. 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.
|
|
|
|
12. Write a nice README so your users can see the features of your plugin.
|
|
|
|
13. 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.
|
|
|
|
3. Move the generated folder to it's own git repository and open the `build.gradle` file in IntelliJ.
|
|
|
|
4. In order to make sure everything works correctly, try to start the client with your external plugin enabled by running the test.
|
|
|
|
|
|
|
|
5. Edit `runelite-plugin.properties` with a support link and tags. `support` is the URL you want players to use to leave feedback for your plugin; by default this links to your repository. `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.
|
|
|
|
6. 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.
|
|
|
|
7. Write a nice README so your users can see the features of your plugin.
|
|
|
|
8. 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 *Insights* from the top bar. Then choose *Community* in the list to the left.
|
|
2. In the license section of the list press *Add*.
|
|
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 *Create new file* in 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](https://github.com/runelite/plugin-hub).
|
|
2. Create a new branch for your plugin.
|
|
3. Create a new file in the `plugin-hub/plugins` directory with the fields:
|
|
```
|
|
repository=
|
|
commit=
|
|
```
|
|
4. To get the repository url, click the *Clone or download*-button choose *Use HTTPS*. Paste the url in in the `repository=` field.
|
|
|
|
5. 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
|
|
```
|
|
6. 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](https://github.com/runelite/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.
|
|
|
|
7. Write a short description of what your plugin does and then create your pull request.
|
|
|
|
8. 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 or [breaking
|
|
jagex's rules](https://secure.runescape.com/m=news/another-message-about-unofficial-clients?oldschool=1).
|
|
__If it is difficult for us to ensure the plugin isn't against the rules we
|
|
will not merge it__.
|
|
|
|
## 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](https://en.wikipedia.org/wiki/Supply_chain_attack) and ensure build reproducability.
|
|
To do this we rely on [Gradle's dependency verification](https://docs.gradle.org/nightly/userguide/dependency_verification.html).
|
|
To add a new dependency, add it to the `thirdParty` configuration in [`package/verification-template/build.gradle`](https://github.com/runelite/plugin-hub/blob/master/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. |