LUA CREATOR · SCRIPT SDK 1

Your tools.
Your rules.

Turn repeated actions into one command. Build a MIDI generator, an audio analyzer or a complete window for your workflow, right inside VLTone.

Free. Lua is included with VLTone.

Lua Creator: editor, commands and script validation
Edit, check, run and install in one window.
01

Creator: nodes, C++ and Lua

Choose how to extend VLTone: audio processing in a graph or a tool that works with the project.

  1. For audio signal processing, open the node-based Creator. Connect input, processing and output, then design the mini-module’s controls.
  2. If you need another algorithm, add C++ Function and use the Creator SDK.
  3. For commands, MIDI generation, file analysis and custom windows, open Lua Creator from the scripts section.
  4. Save your source project. Compiling a DSP module and installing a Lua package are separate ways to add your result to the app.

You have chosen the right editor for the task. Detailed reference material is available on the Creator page.

Explore nodes and C++
02

Lua Creator: your first script

Lua 5.5 is included in VLTone. Scripts run in separate processes; the DAW controls project changes.

  1. Open Lua Creator from the scripts section. Create a package with New or open an SDK example with Open.
  2. Review the manifest: ID, name, version, commands, entry files, contexts and permissions.
  3. Select a command, edit its Lua file and press Check. Fix errors reported in the log.
  4. Save the package and press Preview copy. Inspect the result on the project copy.
  5. When satisfied, use Run in real project on your actual project. Stop ends an active run.
  6. Press Install to add its commands to the library; Export saves a .vltscript package to share.

The checked script is installed and available in the scripts menu.

Check validates the source; it does not replace testing behavior on a project copy.

main.luaRead the selection
local context = vlt.context.get()
local tracks = context.selection.tracks or {}

return {
  message = "Selected tracks: " .. #tracks
}

This minimal command reads the context and returns a message. Open midi-transpose from the SDK to practice project edits.

03

Lua: tracks, clips, MIDI and Undo

A script reads the selection context and performs supported operations through the Script SDK.

  1. Read the selection with vlt.context.get() and project state with vlt.project.get().
  2. Check that a track or MIDI clip exists and prepare operations using IDs from the current response.
  3. Pass the current revision, a descriptive label and operations to vlt.project.apply().
  4. Inspect the result and undo it in the app. If the project changed during processing, read it again and prepare new operations.

A consistent batch of edits is applied and available in history.

Start with midi-transpose: it handles selection, MIDI range and state freshness.

04

Lua: custom windows and background tasks

Build tools with their own interface inside VLTone using the Script SDK.

  1. Open interactive-workbench or styled-workbench and inspect its window description and handlers.
  2. Use native buttons, fields, tables and tabs; add a canvas for custom graphics.
  3. Break lengthy work into chunks, show progress and provide cancellation.
  4. Check keyboard operation, window closure and Stop. Review completed edits separately from unfinished background work.

Your tool has its own interface and a controllable lifecycle.

05

Lua: audio analysis and generation

Scripts can process PCM, prepare files and measure results. This runs as a tool task rather than an audio-thread DSP node.

  1. Open pcm-analysis, transient-slicer or Arrangement Lab from the SDK.
  2. Choose an input file or generation settings and review the required permissions.
  3. Read and synthesize in bounded blocks, with cancellation for lengthy work.
  4. Audition the result, check its level and then add the completed audio to the project.

You have analyzed or generated audio ready for the arrangement.

06

Lua: installation, permissions and sharing

Manage installed packages in the script manager. Permissions determine their available actions.

  1. Open a package in Lua Creator and review its sources, resources and declared permissions.
  2. Run Check and Preview copy, then Install.
  3. Select a command in the script manager, assign a shortcut or add it to the toolbar. Context commands appear where applicable.
  4. Share with Export → .vltscript and keep the editable source.
  5. If a script does not start, check the selected command, project context, permissions and log.

Commands are available where needed, and the package is ready to share.

07 · SCRIPT SDK

Start with a working example.

Open an example folder in Lua Creator, inspect manifest.json and the example code, then try it on a project copy. The download contains the SDK and ready-to-use examples.

midi-transpose

Transpose MIDI

Selection, notes, current state and a single Undo step.

arrangement-lab

Arrangement Lab

Composition, rhythm, six audio parts, a mixer and measurements.

styled-workbench

Custom interface

Windows, tabs, tables, styling and events.

transient-slicer

Transient slicing

Analyze audio and prepare slices for the project.

pcm-analysis

PCM analysis

Read audio buffers and measure the signal.

background-events

Background events

Respond to events and manage a task’s lifetime.

SDK reference in the editor shows the installed version’s reference. For external editors, vlt_script_worker --sdk prints the API catalog; --check file.lua validates a file without running it.

Make VLTone your own.

Creator and Lua are free to use, with no registration.

Download VLTone