From 5ebd02c489c1b932fdcfb8624a25d66491c5e763 Mon Sep 17 00:00:00 2001 From: Guido Rosso <1817068+neurowave@users.noreply.github.com> Date: Sun, 23 Aug 2026 11:38:41 -0700 Subject: [PATCH 1/4] docs(scripting): match protocol names to the Editor and list the missing ones The type picker labels three protocols differently from the docs: the blank protocol is Blank rather than Util, and the listener action and transition condition entries have no trailing Script. The protocols overview also listed 7 of the 10 available protocols, omitting the blank protocol (which already has a page in the sidebar) and both file format protocols. --- scripting/protocols/listener-action-scripts.mdx | 2 +- scripting/protocols/overview.mdx | 3 +++ scripting/protocols/transition-condition-scripts.mdx | 2 +- scripting/protocols/util-scripts.mdx | 2 +- 4 files changed, 6 insertions(+), 3 deletions(-) diff --git a/scripting/protocols/listener-action-scripts.mdx b/scripting/protocols/listener-action-scripts.mdx index 2a281921..33fbd669 100644 --- a/scripting/protocols/listener-action-scripts.mdx +++ b/scripting/protocols/listener-action-scripts.mdx @@ -10,7 +10,7 @@ Use Listener Action Scripts when you need to perform side effects—such as upda ## Creating a Listener Action Script -[Create a new script](/scripting/creating-scripts) and select **Listener Action Script** as the type. +[Create a new script](/scripting/creating-scripts) and select **Listener Action** as the type. ## Anatomy of a Listener Action diff --git a/scripting/protocols/overview.mdx b/scripting/protocols/overview.mdx index e67462d8..da9c76d0 100644 --- a/scripting/protocols/overview.mdx +++ b/scripting/protocols/overview.mdx @@ -14,7 +14,10 @@ Rive currently ships with the following protocols, with more to come: - [Path Effect](/scripting/protocols/path-effect-scripts) - Create custom path effects. - [Transition Conditions](/scripting/protocols/transition-condition-scripts) - Create custom state machine transition conditions. - [Listener Actions](/scripting/protocols/listener-action-scripts) - React to state machine listeners. +- [Blank](/scripting/protocols/util-scripts) - Share helper logic across your other scripts. - [Test](/scripting/protocols/test-scripts) - Unit test your functions. +- **File Format** - Read and write your own binary file format inside the Editor. +- **Text File Format** - Read and write a text-based format, and drive the Editor's text intelligence for it. Each protocol represents a different kind of script the Editor can generate: a converter that shapes data, a custom drawing function, a layout helper, a testing harness, a path effect you can attach to strokes, and so on. diff --git a/scripting/protocols/transition-condition-scripts.mdx b/scripting/protocols/transition-condition-scripts.mdx index f497289c..3371d7ae 100644 --- a/scripting/protocols/transition-condition-scripts.mdx +++ b/scripting/protocols/transition-condition-scripts.mdx @@ -7,7 +7,7 @@ description: "Create custom state machine transitions using scripts" ## Creating a Transition Condition Script -[Create a new script](/scripting/creating-scripts) and select **Transition Condition Script** as the type. +[Create a new script](/scripting/creating-scripts) and select **Transition Condition** as the type. ## Anatomy of a Transition Condition diff --git a/scripting/protocols/util-scripts.mdx b/scripting/protocols/util-scripts.mdx index ca11249e..b35375d9 100644 --- a/scripting/protocols/util-scripts.mdx +++ b/scripting/protocols/util-scripts.mdx @@ -8,7 +8,7 @@ They’re ideal for math helpers, geometry utilities, color functions, or any lo ## Creating a Util Script -[Create a new script](/scripting/creating-scripts) and select **Util** as the type. +[Create a new script](/scripting/creating-scripts) and select **Blank** as the type. ```lua --- Example helper function. From b23896cbc3b7ec7022cc597d02694c1ccf1c4a89 Mon Sep 17 00:00:00 2001 From: Guido Rosso <1817068+neurowave@users.noreply.github.com> Date: Sun, 23 Aug 2026 11:53:34 -0700 Subject: [PATCH 2/4] docs(scripting): tighten the new protocol descriptions Match the terse imperative form the existing entries use. --- scripting/protocols/overview.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/scripting/protocols/overview.mdx b/scripting/protocols/overview.mdx index da9c76d0..4fc35165 100644 --- a/scripting/protocols/overview.mdx +++ b/scripting/protocols/overview.mdx @@ -14,10 +14,10 @@ Rive currently ships with the following protocols, with more to come: - [Path Effect](/scripting/protocols/path-effect-scripts) - Create custom path effects. - [Transition Conditions](/scripting/protocols/transition-condition-scripts) - Create custom state machine transition conditions. - [Listener Actions](/scripting/protocols/listener-action-scripts) - React to state machine listeners. -- [Blank](/scripting/protocols/util-scripts) - Share helper logic across your other scripts. +- [Blank](/scripting/protocols/util-scripts) - Share helper logic across scripts. - [Test](/scripting/protocols/test-scripts) - Unit test your functions. -- **File Format** - Read and write your own binary file format inside the Editor. -- **Text File Format** - Read and write a text-based format, and drive the Editor's text intelligence for it. +- **File Format** - Read and write a binary file format. +- **Text File Format** - Read and write a text file format. Each protocol represents a different kind of script the Editor can generate: a converter that shapes data, a custom drawing function, a layout helper, a testing harness, a path effect you can attach to strokes, and so on. From 639248c34d6acd01e620b48411b9f946d4461bbf Mon Sep 17 00:00:00 2001 From: Guido Rosso <1817068+neurowave@users.noreply.github.com> Date: Sun, 23 Aug 2026 12:23:35 -0700 Subject: [PATCH 3/4] docs(scripting): retitle the Util page to Blank The overview and the create step now say Blank, matching the picker, so the page title and headings should not still say Util. Other protocol pages are titled ' Scripts' after the picker label. --- scripting/protocols/util-scripts.mdx | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/scripting/protocols/util-scripts.mdx b/scripting/protocols/util-scripts.mdx index b35375d9..535cc973 100644 --- a/scripting/protocols/util-scripts.mdx +++ b/scripting/protocols/util-scripts.mdx @@ -1,12 +1,12 @@ --- -title: "Util Scripts" +title: "Blank Scripts" description: "Create helper modules to organize shared logic across your scripts." --- -Util scripts let you organize your code into small, focused modules that can be reused across multiple scripts. +Blank scripts let you organize your code into small, focused modules that can be reused across multiple scripts. They’re ideal for math helpers, geometry utilities, color functions, or any logic that should be broken out into its own script. -## Creating a Util Script +## Creating a Blank Script [Create a new script](/scripting/creating-scripts) and select **Blank** as the type. @@ -33,9 +33,9 @@ print(result) -- 5 ``` -## Utils with Custom Types +## Blank Scripts with Custom Types -Custom types defined in your Util scripts will automatically be accessible +Custom types defined in your Blank scripts will automatically be accessible in the parent script. ```lua From 5630a9efe420ff1c3cc8be57f65c0581af0795c8 Mon Sep 17 00:00:00 2001 From: Guido Rosso <1817068+neurowave@users.noreply.github.com> Date: Sun, 23 Aug 2026 12:47:53 -0700 Subject: [PATCH 4/4] docs(scripting): finish the Util to Blank rename unit-testing.mdx still referred to Util Scripts after the protocol page was retitled. --- scripting/debugging/unit-testing.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/scripting/debugging/unit-testing.mdx b/scripting/debugging/unit-testing.mdx index e3b2e9cf..786337c2 100644 --- a/scripting/debugging/unit-testing.mdx +++ b/scripting/debugging/unit-testing.mdx @@ -1,10 +1,10 @@ --- title: "Unit Testing" -description: "Write and run unit tests for your Util Scripts using Test scripts." +description: "Write and run unit tests for your Blank Scripts using Test scripts." --- import { Demos } from '/snippets/demos.jsx' -Test scripts let you write unit tests for your [Util Scripts](/scripting/protocols/util-scripts) and run them directly in the Rive editor. +Test scripts let you write unit tests for your [Blank Scripts](/scripting/protocols/util-scripts) and run them directly in the Rive editor. Use them to verify math helpers, string utilities, or any other pure logic your scripts depend on. Beyond validating your code, tests also serve as precise instructions for the [AI Agent](/editor/ai-agent), helping it produce code that behaves exactly as you intend. @@ -32,7 +32,7 @@ Inside a case, the `expect` function is passed as an argument to your test callb ### Example ```lua --- Load the Util that you want to create tests for +-- Load the script that you want to create tests for local MyUtil = require('MyUtil') function setup(test: Tester)