rs3dev init
scaffold a new plugin folder named <name> in the current directory
Usage: rs3dev init [options] <name>
scaffold a new plugin folder named <name> in the current directory
Options:
-p, --permissions <list> optional permissions to request, comma
separated
(httpAccess,chatAccess,trackingAccess)
--required-permissions <list> permissions the plugin cannot work without,
comma separated
--prettyui add PrettyUI as a required dependency
--template <name> shape of main.lua: window (default), event,
library or minimal (default: "window")
--no-editor-files do not write .vscode/, .gitignore, .rs3ignore
and README.md
--email <address> contactEmailAddress for plugin.json
--url <name=https://host/> base URL to declare under urls in plugin.json
(repeatable) (default: [])
--no-agent-files do not copy AGENTS.md, Cursor rules and Claude
Code skills
--stubs <dir> stubs folder to reference from .luarc.json
(default: RS3_STUBS_DIR or the installed
@tmhs/rs3-luals-stubs)
--force add files to an existing non-empty folder
(never overwrites)
--existing treat <name> as an existing plugin folder:
write .luarc.json and the agent files only
(same as rs3dev adopt)
--vendor with --existing: copy the stubs into
<plugin>/.rs3/stubs so .luarc.json is portable
-C, --cwd <dir> parent directory for the new plugin (default:
"/home/runner/work/RS3-Developer-Tools/RS3-Developer-Tools")
-h, --help display help for command