From 37ad4caf86d6a46d56927b6a87a48b536591a6ba Mon Sep 17 00:00:00 2001 From: Adam Date: Thu, 11 Jul 2024 21:19:20 -0400 Subject: [PATCH] readme: remove Using the script section This is rarely used and takes up a large portion of the readme. --- README.md | 39 +++------------------------------------ 1 file changed, 3 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index 63947c1eb..b8480142b 100644 --- a/README.md +++ b/README.md @@ -8,17 +8,11 @@ provided "as is"; we make no guarantees about any plugin in this repo. ## Setting up the development environment We recommend [IntelliJ Idea Community Edition](https://www.jetbrains.com/idea/download/) as well as Java 11. You can either have -IntelliJ install Java (select `Eclipse Temurin`) or download it from https://adoptium.net/temurin/releases/. +IntelliJ install Java (select `Eclipse Temurin`) or download it from https://adoptium.net/temurin/releases/. You must also have a GitHub account. ## 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 - -### 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. + 1. Generate your own repository from the [plugin template](https://github.com/runelite/example-plugin/generate) link. + Alternatively, you may use the `create_new_plugin.py` script provided in this repository to generate a new plugin project. 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**. @@ -55,33 +49,6 @@ There are two methods to create an external plugin, you can either: 12. 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 its 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 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](https://github.com/runelite/runelite/wiki/Using-Jagex-Accounts). - - ![run-test](https://i.imgur.com/tKSQH5e.png) - - 5. 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. - - 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 *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.