Getting Started with CinematicEngine

This guide will walk you through installing CinematicEngine, configuring necessary dependencies, and authoring your very first cinematic flythrough in minutes.

📋 System Requirements

Requirement	Supported Version	Notes
Server Software	Paper, Purpur	Paper 1.20.4, 1.20.6, or 1.21.x recommended.
Java Runtime	Java 21+	Compiled for Java 21 LTS virtual machine.
ProtocolLib	v5.3.0+	Required for Display entity camera spectator packets.
Folia	Unsupported	Uses Bukkit tick scheduler tasks; regional Folia threading is unsupported.

📦 Installation Steps

Install ProtocolLib:
- Download the latest build of ProtocolLib (v5.3.0 or newer) from its official repository.
- Place ProtocolLib.jar inside your server’s plugins/ directory.
Install CinematicEngine:
- Download CinematicEngine.jar from the official Releases.
- Place CinematicEngine.jar into your server’s plugins/ directory.
Start the Server:
- Start or restart your server to initialize default directories and configuration files:
  Ventana de terminal
```
plugins/CinematicEngine/
├── config.yml
└── scenes/
```
Verify Installation:
- Run the root command in your server console or in-game:
```
/cine help
```
- If installed correctly, you will see the full list of available CinematicEngine commands.

🎬 Authoring Your First Scene

Cinematic scenes are defined as YAML files located in the plugins/CinematicEngine/scenes/ folder.

Create a file named welcome.yml inside plugins/CinematicEngine/scenes/:

id: "welcome"
duration: 160 # 8 seconds (20 ticks = 1 second)
metadata:
  title: "Welcome Flythrough"
  author: "Admin"

tracks:
  - type: "camera"
    id: "flyby_camera"
    data:
      path-mode: "spline"
      look-at:
        mode: "static"
        target: [0.5, 68.0, 0.5] # Focus point (e.g. your town square or monument)
    keyframes:
      - tick: 0
        position: [25.0, 78.0, -25.0]
        fov: 70.0
        interpolation: "ease_in_out"
      - tick: 80
        position: [0.0, 82.0, -35.0]
        fov: 80.0
        interpolation: "ease_in_out"
      - tick: 160
        position: [-25.0, 75.0, -20.0]
        fov: 70.0
        interpolation: "linear"

  - type: "effect"
    id: "scene_soundtrack"
    keyframes:
      - tick: 10
        sound:
          name: "ui.toast.challenge_complete"
          volume: 1.0
          pitch: 1.0

🕹️ Testing and Playing Your Scene

Reload Scenes: To load your newly created scene without restarting the server, execute:
```
/cine reload
```
Verify Loaded Scenes: Check if the engine successfully parsed and validated the scene:
```
/cine list
```
You should see welcome listed along with its duration (160 ticks).
Play the Scene: Play the scene for yourself:
```
/cine play welcome
```
Or trigger it for a specific online player:
```
/cine play welcome Steve
```
Stop or Pause Early: If you need to halt the cinematic before it finishes:
```
/cine stop
```
Your original location, gamemode, and inventory will be safely restored instantly.

💡 Troubleshooting Tips

No Camera Movement: Ensure ProtocolLib is enabled and running without errors in your server console.
Jittery View: Verify that the client is running Minecraft 1.20+ with client rendering enabled. Display entity rigs natively interpolate client frames between server ticks.
YAML Syntax Errors: If /cine reload reports validation errors, check that coordinates are formatted as [x, y, z] numeric lists and that ticks are sequential.