Skip to content

Add plugin data storage guidance #38

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
dev-elie wants to merge 1 commit into
base: master
Choose a base branch
from
+1 −0
Open

Add plugin data storage guidance #38

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
1 change: 1 addition & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
## Config

- Config group names must be specific — e.g. `"deadman-prices"`, not `"deadman"`.
- Keep config values limited to user settings. If your plugin needs to persist a decent amount of data, save it to disk under the plugin's `.runelite` subdirectory instead of storing JSON blobs in config.
- Never rename a config key or config group without providing a migration. Renaming silently resets users' saved settings.
- If you add a `@ConfigItem` that toggles a feature involving a third-party server, it must:
- Be **disabled by default** (opt-in)
Expand Down