How to install NovelAI scripts

Choose a community script, review what it needs, and import it into the scope that fits your workflow.

1. Choose a script and release

Start in the script catalogue or browse categories. Read the description, prerequisites, dependencies, scope notes, and examples before choosing a tool.

Open its Releases section to compare versions, changelogs, uploader-declared compatibility, and permissions. Download the intended .naiscript file. Compatibility and permissions are supplied by the uploader; scripts are not automatically security-audited or tested by Story ScriptVault.

A SHA-256 checksum can help you compare a downloaded file with the published release. Matching a checksum establishes file identity, not safety.

2. Open NovelAI User Scripts and import

In NovelAI, open User Scripts from the goose menu in the left sidebar. With a story selected, it is also available from the Advanced tab in the right sidebar. The documented keyboard shortcut is Alt+X.

Use the import control in the User Scripts modal to select the .naiscript file. Follow the script author's setup instructions, including any required companion scripts. Keep a backup or test copy of important story text and lorebook entries before enabling tools that change them.

3. Choose account or story scope

Account scripts are saved to your account and load when any story is selected. Story scripts are saved in the story file and load only with that story.

Compare the script's supported and recommended scope with your intended use. An uploader's “Both” label means to consider either scope, not that you need to install two copies. Follow any scope-specific instructions supplied by the author.

4. Review permissions and try the documented workflow

Compare NovelAI's permission requests with the task described by the author. Relevant capabilities can include changing document text, story settings, or lorebook entries, writing to the clipboard, and opening file or download dialogs.

Review the reasons listed in the release details. An empty uploader declaration is not a safety assessment. If a requested capability is unexpected or unclear, stop and ask the author before granting it.

Try the author's example on a test story and check the result. See the official permissions documentation for the current API behavior.

5. Disable or troubleshoot a script

Return to User Scripts to disable or remove a script. If a script makes the interface unusable, NovelAI documents adding ?noscript=true to the NovelAI URL and reloading to prevent scripts from loading while you disable the problematic one.

For an issue report, include the script version, chosen scope, steps, and visible error. Avoid sharing private story content. Use the script's comments or author-provided support link.

This guide follows the official NovelAI scripting introduction. Consult that documentation for interface changes and current behavior.