Introduction to RUNE
Welcome to the RUNE Interface documentation! R.U.N.E. – Routing & Utility Node Editor is a visual workflow editor that lets you build automation flows, data processing pipelines, and complex logic without writing traditional code.
What is RUNE?
R.U.N.E. – Routing & Utility Node Editor is a node-based visual programming system. Instead of writing code line by line, you:
- Drag nodes onto a canvas
- Connect them together with wires
- Configure inputs and outputs
- Run your flow immediately
Think of it like building with LEGO blocks - each node does a specific job, and you connect them to create complex workflows.
RUNE Interface vs RUNE CLI
RUNE comes in two forms:
- RUNE Interface: A graphical application with a visual editor. Perfect for designing flows, debugging, and interactive development.
- RUNE CLI: A command-line tool for executing flows. Perfect for automation, scripts, and CI/CD pipelines.
Both tools use the same flow format, so you can design in the Interface and execute with the CLI.
Key Concepts
Flows
A flow is a collection of connected nodes that work together to accomplish a task. Each flow is saved as a JSON file and can be shared, versioned, and executed.
Nodes
Nodes are the building blocks of flows. Each node:
- Has inputs (data and execution pins)
- Performs a specific operation
- Produces outputs (data and execution pins)
Execution Flow
Nodes are connected with execution pins that control the order of operations. When a node finishes, it triggers the next connected node.
Data Flow
Nodes pass data between each other using data pins. Values flow from output pins to input pins.
Session State
Session State is a storage system that persists data throughout a flow execution. You can set, get, and delete values that other nodes can access.
Getting Started
Ready to start building? Choose your path:
- RUNE Interface Getting Started - Learn to use the visual editor
- RUNE CLI Getting Started - Learn to use the command-line tool
- Luau API Reference - Explore the scripting API
- Node Reference - Browse available nodes
Download
Get RUNE Interface and RUNE CLI from itch.io.
Built by Blazium Engine Contributors