Cutscene API
Cutscene API is a modification that opens up opportunities for map and mod creators to create cinematic scenes with smooth camera movement and various visual effects, playing directly in the game in real time.
Main Features
The system is based on the concept of a cutscene type, which is fully configurable through a datapack. Each cutscene has the following parameters:
- Duration in game ticks
- Camera movement trajectory
- List of allowed actions for the player during viewing
- Smooth transitions at the beginning and end
- Special effects to enhance visual impact
All these elements are optional, but their proper combination allows creating truly impressive scenes.
Camera Trajectory
The player's camera can follow a predefined route consisting of segments of various types: straight lines, Bézier curves, Catmull-Rom splines, static points, or special points with coordinates defined by mathematical functions. Camera rotation is configured similarly, including a special tracking mode for a specific point.
Smooth Transitions
For more natural immersion into the cutscene, various types of transitions are provided. Available options include smooth easing when entering/exiting the scene, as well as screen fading to any color with the ability to dynamically change the hue.
Action Restrictions
During cutscene playback, you can limit the player's capabilities: prohibit movement, head turning, block breaking, item use, damage taking, or switch to spectator mode for protection from hostile mobs.
Visual Effects
In addition to camera movement, the system supports various visual elements: gradually appearing text, drawing simple geometry using triangles, displaying rectangles, and overlaying textures in specified positions.
Commands
/cutscene start <player> <type> [at_preview | position] [start_camera_rotation] [path_rotation] — starts a cutscene for the specified player with given positioning and rotation parameters
/cutscene stop [player] — stops cutscene playback
/cutscene preview set <type> [start_pos] [path_rotation] — activates camera trajectory preview mode
/cutscene preview hide — hides the preview
Usage Examples
In the mod's source repository, there is a folder "Example Cutscenes" — this is a datapack with a set of test scenes that demonstrate all the capabilities of the modification. Although some of them may seem unusual, they do an excellent job of teaching.
Compatibility
The mod is designed with maximum compatibility with other modifications in mind and should not cause conflicts. Most released versions maintain backward compatibility, especially regarding data formats.
