Basic format (WIP) - thewinnt/Cutscene-API GitHub Wiki

The very basics of the mod.

To start with,

• you need a datapack
• your cutscenes will go into the data/(namespace)/cutscenes folder as json files.

A cutscene can specify these fields:

• length [number] (required) - the length of the cutscene in game ticks
• path and rotation [list of path segments] - specify the path and rotation of your camera using path segments
• start_transition and end_transition [transitions] - specify the transitions when entering and leaving a cutscene
• disable_actions [boolean or object] - allow you to disable certain actions or all of them at once (see here for an incomplete list)
• effects [list of effects] - a list of on-screen effects for your cutscene
• block_movement and block_rotation [booleans] - allow blocking the player's movement and rotation when the camera path or rotation is not specified
• hide_hand and hide_block_outline [booleans] - should be self-explanatory
• rotation_handler [object] - how the player's mouse movement is handled during the cutscene

You can see some examples of cutscenes in the Example Cutscenes datapack in the repository. Some good ones IMO are transition_test, rotation_handler_test and seconds_test

Effects are well-explained in these release notes.

To play a cutscene, you can run the /cutscene start @s <id> command, where id is the name of your cutscene. You can then stop it using /cutscene stop.