Quickstart

Goal: install omp-spt, create a named endpoint, and attach to its native OMP TUI.

1. Install the prerequisites

You need Oh My Pi 16.3.15 or newer and spt-core. There is no plugin installation step.

The v0.2.0 omp-spt release supports x86_64 Windows and x86_64 Linux only. Its archive has no macOS or Arm64 adapter payload.

PowerShell (x86_64 Windows)

if (-not (Get-Command omp -ErrorAction SilentlyContinue)) { irm https://omp.sh/install.ps1 | iex }
if (-not (Get-Command spt -ErrorAction SilentlyContinue)) { irm https://sabermage.github.io/spt-releases/install.ps1 | iex }

bash (x86_64 Linux / Git Bash on x86_64 Windows)

command -v omp >/dev/null 2>&1 || curl -fsSL https://omp.sh/install | sh
command -v spt >/dev/null 2>&1 || curl -fsSL https://sabermage.github.io/spt-releases/install.sh | sh

Open a fresh shell if either installer updated your PATH, then verify both commands:

omp --version
spt --version

omp-spt requires Oh My Pi 16.3.15 or newer and spt-core 0.31.0 or newer. If either version check reports an older release, run omp update or spt update as appropriate, open a fresh shell if needed, and repeat both checks before installing the adapter.

2. Install the adapter

spt adapter add --release BigscreenVR/omp-spt

This installs one fat adapter.spt release for the supported x86_64 Windows and Linux targets. The archive includes their adapter binaries, the manifest, and the packaged OMP extension.

3. Create and attach to an endpoint

Choose a stable endpoint id. This example uses librarian:

spt endpoint run --adapter omp-spt --id librarian --create

For another name, use the canonical form spt endpoint run --adapter omp-spt --id <id> --create and replace <id>.

The command launches OMP with adapter/strings/omp-spt.mjs and attaches your terminal directly to OMP’s native TUI. Native attach is the default. ReadyAgent and LiveAgent are the supported hostable roles.

During bring-up, the extension:

1. binds the OMP session id to the Spacetime endpoint;
2. marks the endpoint idle and starts delivery;
3. submits each incoming message as an OMP turn;
4. sends OMP’s response to the original sender; and
5. ends the binding when the native TUI shuts down.

You now have a named endpoint in the standard Spacetime messaging and lifecycle model. Use the spt-core documentation for endpoint rosters, messaging, subnets, and other public commands.

4. Update later

spt adapter update omp-spt

OMP loads the packaged extension fresh on endpoint bring-up. Restart an already running endpoint to move it to the updated adapter:

spt endpoint stop librarian
spt endpoint run --adapter omp-spt --id librarian

Next, read the Native integration contract for launch, delivery, reply, failure, and shutdown behavior.