Documentation Index
Fetch the complete documentation index at: https://mintlify.com/TheNextLvl-net/cinematics/llms.txt
Use this file to discover all available pages before exploring further.
The record subcommand captures the executing player’s position and look-direction over time, building a frame-by-frame camera path that can be replayed later with /cinematic play. The command acts as a toggle: the first invocation begins the recording session, and a second invocation with the same name stops it and writes the path to disk.
Syntax
Arguments
| Argument | Type | Required | Description |
|---|
name | string | ✅ Yes | The identifier used to save and later reference this recording. Must be unique among existing recordings. |
Behaviour
- Start recording — When no active recording exists for the player, the plugin begins capturing frames. The player sees a confirmation that recording has started.
- Stop and save — Calling the command again halts the capture. If serialisation succeeds, a
recording-saved message is sent with the recording name substituted into the <recording> placeholder. If the save fails for any reason, a recording-error message is sent instead.
- Stop without saving — If the player had already started a recording and calls the command without providing a new name, the session is stopped and a
recording-stopped message is sent without persisting the data.
The saved file is written to the plugin’s data folder on the server. Once saved, the recording is immediately available to /cinematic play, /cinematic info, and /cinematic delete.
Permission
| Permission node | Default |
|---|
cinematics.command.cinematic | op |
Response Messages
The following message keys from cinematics.properties can be sent during a record session:
| Key | When sent | Default text |
|---|
recording-saved | Recording written to disk successfully | Cinematics » Saved recording <name> |
recording-stopped | Recording session stopped before saving | Cinematics » Stopped the recording |
recording-error | An error occurred while saving the recording | Cinematics » An error has occurred while recording |
Use short, descriptive names without spaces when naming recordings — for example spawn-intro or hub-flythrough. Hyphens make names easy to type in tab-completion and keep the file names readable on disk.