Build interactive experiences for Arrival.Space using JavaScript.
export class MyPlugin extends ArrivalScript {
static scriptName = "myPlugin";
// Properties shown in the editor UI
speed = 5;
color = "#ff0000";
offset = { x: 0, y: 1, z: 0 };
// Runs every frame
update(dt) {
this.entity.rotate(0, this.speed * dt, 0);
}
}- Agent Quickstart - High-signal coding checklist for LLM/plugin generation
- Getting Started - Create your first plugin
- API Reference - ArrivalScript & ArrivalSpace API
- Properties - Expose settings in the editor
- Multiplayer - Real-time sync & messaging
- Sequences - Build cutscenes, object animation, and marker-driven events
- Cutscenes via MCP/CLI - Create cutscenes/animations headlessly with
.pathfiles (no plugin) - Examples - Ready-to-use plugin examples
| Type | Example | UI Component |
|---|---|---|
number |
speed = 5 |
Numeric slider |
boolean |
isEnabled = true |
Toggle switch |
string |
label = "Hello" |
Text field |
color |
color = "#ff0000" |
Color picker |
vec3 |
pos = { x: 0, y: 1, z: 0 } |
X/Y/Z inputs |
Sync state and send messages between players:
// Automatically synced to all players
score = attribute(0, { sync: true });
// Send custom events
ArrivalSpace.net.send("Game:hit", { damage: 10 });
// Listen for events from other players
ArrivalSpace.net.on("Game:hit", (data, sender) => {
console.log(`${sender.userName} hit for ${data.damage}`);
});See Multiplayer Documentation for details.
| Plugin | Description |
|---|---|
| Annotation Marker | 3D marker with icon and markdown popup panel |
| Avatar Animation | Override player idle/walk/jump animations |
| Avatar Bone Attachment | Attach a GLB model to any avatar bone with configurable offset and rotation |
| Bouncy Box | Simple bouncing motion behavior |
| Box Stack | Physics pyramid of boxes and spheres |
| Character Scale | Adjust character scale and movement feel |
| Dynamic Light | Configurable cone/point light controller |
| First-Install Setup | One-time, owner-only setup panel via the onInstall() hook; persists config to pluginStore |
| Feed Recorder | Records a Splat Monitor's render-target feed to a downloadable WebM video (plus PNG snapshots), with HUD button, hotkey, and event-bus control |
| Game HUD | Game-style HUD overlay example |
| GLB Model | Load and attach an external GLB model |
| Google 3D Tiles | Stream the Google Earth globe (Photorealistic 3D Tiles) centered on any lat/lon, with LOD streaming and miniature-globe scaling |
| Hello World | Simplest possible plugin |
| Hover Board | Rideable dynamic board with avatar animation, input, and physics tuning |
| Info Panel | Dynamic world-space iframe/UI panel |
| Lamp | Lamp GLB with rigidbody collision and configurable light |
| Localized Light Probe | Spatial light probe volume that overrides primary light, environment, and post-effects with radius falloff |
| Firework Marker FX | React to a cutscene's timeline markers by spawning ascent flames and burst fireworks |
| AI NPC | LLM-driven NPC chat panel, built on the general ArrivalSpace.ai.complete API (free GPT-6 Luna by default, no key needed; or the owner's OpenAI/Anthropic/GLM key) |
| AI Text Tool | Non-NPC use of ArrivalSpace.ai.complete: paste text, pick summarize/translate/rewrite, one-shot completion with a plugin-supplied system prompt |
| NPC Character | Spawn and control a follower NPC |
| Outfit Override | Temporarily override avatar outfit parts |
| Piano | Playable 5-octave keyboard: silhouette outline + soft note on hover, full strike on click, stopPropagation to make keys solid to the pointer |
| Physics Box | Basic rigidbody/collision example |
| Floating Cutscene Button | Floating 3D button that plays a selected cutscene entity, with cooldown and range checks |
| Measure Tool | Measure distances, paths, areas and heights on splats and meshes, drag points to edit — ArrivalSpace.raycastSplats, raycastScreen |
| Ray Probe | A drone measures its height above the visible ground (raycastVisual) and above the colliders (raycastPhysics) |
| Speaking Sign | Speaks its text with a streamed AI voice when you come close, and glows with its voice |
| Voice NPC | Click an NPC and talk to it with your voice; it answers aloud in realtime, in character |
| Pin Board | Editors save a shared board, visitors pin notes into their own folder — ArrivalSpace.fs space files |
| Post Process Volume | Local post-effects blend volume |
| Scene Tour Camera | Overlay list of scene entities; click one to fly the free camera to it |
| Rail Camera | Constrained free-fly studio camera on rails with cine viewfinder (letterbox, exposure/HDR, zoom), operator panel, and record transport driving the Feed Recorder |
| Ragdoll Physics | Procedural avatar ragdoll: bone-derived capsule bodies, cone/hinge constraints, impact-triggered activation, and head-tracked camera follow |
| Scavenger Hunt | Controller that discovers Scavenger Item entities, tracks collection via proximity, and shows progress/finish HUD |
| Scavenger Item | Collectible marker with gizmo-positionable placement, default visual or custom GLB, used with Scavenger Hunt |
| Simple Chat | Multiplayer chat with ArrivalSpace.net |
| Snowfall | Falling snow made of Gaussian splats, follows the camera |
Spin Image on Corner (.path cutscene) |
Cutscene, not a plugin — a .path sequence that spins an image on one of its corners (position + rotation keyframes); see docs/cutscenes-via-mcp.md |
| Splat Crop | Movable oriented box that crops the space's loaded splat(s) — keep inside or carve a hole (Invert), with a soft edge. The Crop Splats toggle can disable cropping to use the box purely as a Cull Google Tiles selector |
| Splat Monitor | Live render-to-texture screen (monitor / CCTV / portal window) fed by a hidden second camera — camera-entity, follow-player, or fixed POV; window mode with off-axis projection; scanlines, LED raster, curve, on-demand rendering |
| Splat Portal | Portal window that reveals another scene splat only through its opening via a stencil mask (true window onto the splat's real location). Optional near-clip (hide splats in front, objects still occlude), horizontal screen curve, and a glowing frame |
| Splat Reveal | Configurable reveal on the space's loaded unified/LOD splat via the gsplatModifyVS hook (WebGL + WebGPU) — radial/sweep/rain/scatter/dissolve/bloom patterns with a final scale bump |
| Splat Snow | Flattened GSplat snow cover that raycasts onto collision surfaces |
| Sound Press Button | Clickable 3D button that plays / pauses / stops a referenced Custom Sound entity |
| Sound Trigger | Play sound on proximity |
| Vehicle Physics Model | Driveable vehicle with custom chassis/wheel GLB models, headlights, suspension, and input controls |
| VRM Tuning & Debug | Live control panel + visualizer for the engine's native VRM systems (which run automatically for every loaded VRM). Sliders tune the global window.VRMSpringBones (ropiness, air resistance, stiffness/gravity/drag, collision iterations) and window.VRMToonMaterial (diffuse/emissive/ambient/specular, skybox & tonemap); debug toggles draw the engine's real colliders and bones |
| Velocity Pad | Sets player velocity when standing on a pad (API 1.14.0) |
When adding, renaming, or removing example files, also update docs/plugin-search-index.json.
- Add or update the matching entry for each new example with:
pathkindtitlesummaryscript_name(for examples)- focused
keywordsthat describe what someone would search for
- Keep the metadata concise and based on the actual file contents, not guesses.
- Remove entries for deleted examples and rename entries when filenames change.
- Update
total_entriesso it matches the actual number of items inentries.
The arrival CLI (in tools/arrival-cli/) lets you manage a space as local files — pull it into a git-friendly workspace, edit room.json / entities/*.json / plugins/*.mjs / assets/* with your own editor, then push it back.
npm install -g @arrival-space/cli # puts `arrival` on your PATH (or: npx @arrival-space/cli <command>)
arrival login # sign in via your browser (OAuth)
arrival spaces # list your spaces
arrival pull 45637586_1234 # download into ./45637586_1234/
arrival validate # server-side dry-run
arrival push # apply your edits to the live spaceSee tools/arrival-cli/README.md for the workspace layout and current limits.