Commands - superstrellaa/CinematicTools GitHub Wiki
CinematicTools includes two main command groups:
-
/cinematic-clientโ For creating and configuring local cinematics. -
/cinematic-serverโ For running, managing, and syncing cinematics on the server, with support for NPC control.
These commands are used to create and test cinematics on the client side.
-
/cinematic-client add <x y z?>โ Adds a new point. If no coordinates are provided, uses the current player position. -
/cinematic-client insert <index>โ Inserts a point at the given index. -
/cinematic-client remove <index>โ Removes the point at the given index. -
/cinematic-client clearโ Deletes all points in the cinematic. -
/cinematic-client goto <index>โ Teleports to the exact position and rotation of a specific point. -
/cinematic-client listโ Lists all defined points.
-
/cinematic-client start <duration?> <loops?>โ Starts the cinematic with optional duration and loop count. -
/cinematic-client stopโ Stops the cinematic. -
/cinematic-client pauseโ Pauses playback. -
/cinematic-client resumeโ Resumes playback. -
/cinematic-client loops <amount>โ Sets how many times the cinematic will repeat. -
/cinematic-client duration <time>โ Sets the total duration (e.g.,5s,10m).
-
/cinematic-client mode <default/outside>โ Changes the camera mode. -
/cinematic-client smooth_start <true/false>โ Enables smooth transition at the start of the cinematic. -
/cinematic-client spinning_fix <true/false>โ Fixes rotation bugs when transitioning between points. (Experimental)
-
/cinematic-client interpolation <type>โ Sets the interpolation type between points. Available types:-
linear,cosine,cubic,hermite,circular,invcular
-
-
/cinematic-client show <type>โ Highlights all segments using the selected interpolation type. -
/cinematic-client hide <type>โ Hides all segments using the selected interpolation type.
-
/cinematic-client follow <entity/player/pos/self/none> <target>โ Makes the camera follow an entity, player, position, self or nothing. -
/cinematic-client target <entity/player/pos/self/none> <target>โ Controls what the camera looks at (direction). -
/cinematic-client follow_center <x y z>โ Sets a position as the center point to follow.
-
/cinematic-client pos step <value>โ Sets position interpolation step granularity. -
/cinematic-client yaw step <value>โ Sets yaw rotation granularity. -
/cinematic-client pitch step <value>โ Sets pitch rotation granularity. -
/cinematic-client set <x y z> <pitch> <yaw> <roll>โ Manually sets a pointโs position and rotation. -
/cinematic-client instert <position> <rotation> <roll>โ (โ ๏ธ Experimental, behavior unclear)
-
/cinematic-client save <path>โ Saves the cinematic with the given name. -
/cinematic-client load <path>โ Loads a previously saved cinematic.
These commands manage server-stored cinematics and allow synced playback and NPC control.
-
/cinematic-server create <name>โ Creates a new server-side cinematic. -
/cinematic-server listโ Lists all saved cinematics on the server. -
/cinematic-server remove <name>โ Deletes a cinematic from the server. -
/cinematic-server start <name> <players> <duration> <loops>โ Starts a cinematic for the given players. -
/cinematic-server stop <players>โ Stops a cinematic for the specified players. -
/cinematic-server pause <player>โ Pauses the cinematic for a player. -
/cinematic-server resumeโ Resumes paused cinematics. -
/cinematic-server clearโ Clears temporary data (like current session cinematics). -
/cinematic-server get <name>โ Retrieves specific settings from a cinematic (e.g., interpolation type, smooth start, etc.).
NPCs can be used as animated actors in your scenes.
-
/cinematic-server npc summon <name> <x y z> <yaw> <pitch>โ Summons a named NPC at a specific position. -
/cinematic-server npc walk <name> <x y z>โ Makes the NPC walk to a location. -
/cinematic-server npc run <name> <x y z>โ Makes the NPC run to a location. -
/cinematic-server npc jump <name>โ Makes the NPC jump. -
/cinematic-server npc animation <play/resume/stop> <animationName>โ Controls which animation the NPC plays.
-
/cinematic-clientis local only โ it doesn't sync with other players. -
/cinematic-serverallows multiplayer-synced cinematics and remote NPC control. - You can combine both to create, test, and deploy complex cinematic experiences.