Skip to content

Update template AGENTS.md restricted functions and classes #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ldavid432 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update template AGENTS.md restricted functions and classes #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 24 additions & 2 deletions templateplugin/AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,19 @@
# RuneLite Plugin Development — Agent Guidelines

For the latest guidelines visit: https://raw.githubusercontent.com/runelite/example-plugin/refs/heads/master/AGENTS.md

Additional relevant pages:
- RuneLite wiki's rejected features list: https://github.com/runelite/runelite/wiki/Rejected-or-Rolled-Back-Features
- Jagex's third party client guidelines: https://secure.runescape.com/m=news/third-party-client-guidelines?oldschool=1

## Logging

- Use `log.debug()` for developer/diagnostic logging.
- Do not use `log.info` for per-frame or per-event logging - RuneLite runs at INFO level in production, so high-frequency info logs will pollute user logs. `log.info()` is fine for one-time startup/shutdown messages or infrequent events.

## Threading & Concurrency

- Never use `Thread.sleep()`.
- Never use `Thread.sleep()` or `Thread.interrupt`.
- Never block on `shutDown()` or `startUp()` — don't call `executor.awaitTermination()` in shutdown, just use `shutdownNow()`.
- Never do blocking network IO or disk IO on the client thread. The OkHttp thread pool can be used for blocking network requests.
If you need to call back into `client` from the okhttp threadpool, such as from the response queued with `enqueue()`, use `clientThread.invoke()`
Expand All @@ -23,10 +29,25 @@
## API Usage

- Use `net.runelite.api.gameval` package constants — `ItemID`, `InterfaceID`, `ObjectID`, etc. Never hardcode magic numbers when gameval constants can be used instead.
- Use `LinkBrowser` to open URLs, not `java.awt.Desktop`
- Use `LinkBrowser.browse` to open URLs, not `java.awt.Desktop.browse`
- Never use `Desktop.open` or `LinkBrowser.open`
- When looking up Widgets, pass the component ID from gamevals (eg `client.getWidget(InterfaceID.DomEndLevelUi.LOOT_VALUE)`) - do not manually combine interface + component child IDs.
- Use of Java reflection is forbidden.

### Forbidden
These APIs cannot be used at all

* `Client.menuAction`
* `java.lang.Runtime`
* `java.awt.KeyboardFocusManager`

### Restricted
These APIs are **heavily** discouraged and will cause the plugin to require manual review. If the user insists on using these APIs make it clear to them that this will cause their plugin will require manual review, which has no timeline.

* `Client.hopToWorld`
* `Filepath.Unchecked`
* `ScriptEventBuilder.setCanSendPackets`

## HTTP & JSON

- Use OkHttp for all HTTP requests. `@Inject OkHttpClient` to get the HTTP client. Do not use `HttpURLConnection`, `java.net.http.HttpClient`, or Apache HttpClient.
Expand All @@ -39,6 +60,7 @@
- All file i/o must go through the Filepath utility. Use of Filepath requires setting PluginDescriptor `internalName` to the internal name of the plugin.
- Use `Filepath.Chooser` instead of `JFileChooser`
- To migrate a legacy plugin data folder from .runelite automatically, set PluginDescriptor `legacyDataDirectory` to the name of the legacy folder.
- Use of `Filepath.Unchecked` is heavily discouraged as it will cause the plugin to require manual review

## Config

Expand Down
Loading