rxx built-in plugins

home scripting API plugins source

These plugins ship with rxx and are written in Rune.

mode vis

Shows -- NORMAL --, -- VISUAL --, or the current script mode at the bottom of the editor. Hidden while entering a : command. There’s nothing to configure.

The mode indicator during selection, dragging, pasting, and command entry.
source ↗

animation mode

Adds animation/mode to :set. The values are forward (the default), reverse, and ping-pong. Each view keeps its own setting. With four frames, ping-pong plays 0, 1, 2, 3, 2, 1, then repeats.

Reverse and ping-pong playback.
:set animation/mode = reverse
:set animation/mode = ping-pong
source ↗

miniview

A draggable, resizable preview that floats above your views. Run :miniview, then click a sheet frame to pin it or an animation preview to follow playback. Click Target to choose again; Esc cancels target selection.

Pin a frame, drag and resize the panel, then attach it to live animation playback.
:miniview
:miniview/show
:miniview/off
source ↗

layer status

Lists layers by number and marks the active layer. The eye beside each layer toggles its visibility. Set layer-status/show to off to hide the list.

Click the eyes to reveal mint, gold, and pink rocket bodies, then switch active layers.
:set layer-status/show = on
source ↗

selection outline

Outlines the nontransparent pixels in a visual selection using the foreground color. Select the area to outline, then run :selection/outline. The result can be undone.

Applying a gold outline, then undoing and redoing the edit.
:selection/outline
source ↗

rotate & scale

Adds rotation and scaling modes for visual selections. Run :selection/rotate or :selection/scale, then drag with the left mouse button. Right-click to set the pivot. Enter applies the edit; Esc cancels.

Changing algorithms during rotation, scaling, and moving the pivot.

Press : in either mode to change rotate-scale/algo. Available algorithms: nearest, cleanedge, mmpx, rotsprite. The preview updates at the current angle and scale.

:selection/rotate
:set rotate-scale/algo = cleanedge
:selection/scale
source ↗

loading the plugins

rxx loads plugins/ from the current directory and the user configuration directory. Add a plugin directory for a run with --plugin-dir (repeat it for multiple directories):

rxx --plugin-dir /path/to/rxx/plugins

For persistent extra directories, set RXX_PLUGIN_PATH in your shell startup file. It accepts a PATH-style list; for example, on macOS or Linux:

export RXX_PLUGIN_PATH="$HOME/src/my-plugins:$HOME/src/more-plugins"

Search order is --plugin-dir directories, RXX_PLUGIN_PATH, local plugins/, then the user configuration plugin directory. The first match for each plugin name wins. See plugin discovery in the API reference for details.

See the scripting guide for writing plugins and the API reference for available functions.

back to top - back to home

© 2026 Guy Sviry