Skip to content

Latest commit

 

History

390 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ImmersiveCinematics

Add cutscenes to your modpack — no command blocks required. A single mod for all your storytelling needs. Write JSON scripts or use the in-game editor.

中文文档

This project is generated by AI Agent. The author provides ideas and concepts, while the AI Agent handles code implementation and feature development.


What Is This?

ImmersiveCinematics is a Minecraft mod that adds cutscenes to modpacks. A server-side trigger system coordinates with client-side playback: script authors define cutscenes in JSON (or via the in-game editor), and the trigger system plays them automatically when conditions are met — 23 trigger types covering login, location, advancement, biome, entity kill, entity/block/item-on-interact, dimension change/residency, item craft/use/consume/release/instant-use/use-interrupt, item pickup/drop, xp, observation, inventory, structure, and gamestage.

Use cases:

  • Play an intro cutscene when entering a new area
  • Boss fight pre-rendered cinematics
  • Chest opening camera close-up
  • Fixed-camera puzzle rooms (Resident Evil 0-style)
  • Automated world tour flythroughs

Features

Cutscene System

  • 6-DOF camera: position, yaw, pitch, roll, FOV, zoom
  • Keyframe animation + Bézier curve paths for smooth camera movement
  • Relative/absolute positioning, looping, infinite duration, camera follow/look-at tracking
  • Multi-track timeline: camera, letterbox, audio, event, mod event, overlay (fade / image / subtitle / pip)
  • Widescreen letterbox bars with keyframe-driven aspect ratio animation
  • Morph transitions between shots (crossfade model)

Trigger System (Server-Side)

  • 23 trigger types: login, location (point+radius / cuboid area), advancement, biome, entity kill (with scene conditions: dimension/biome/position), entity interact, block interact, item-on-interact (item+target+target_type, bare-hand support), dimension change, dimension residency, item craft, item use, item consume, item release, item instant use, item use interrupt, item pickup, item drop, xp (level/total), observation (server raycast, block/entity), inventory, structure, gamestage
  • OR/AND logic and wildcard matching supported
  • Repeatable or single-fire, with configurable delay and on_enter/exit_buffer

Runtime Control

  • 18 behavior flags: skippable, interruptible, hold-at-end, keyboard/mouse/mob-AI blocking, 7 independent HUD toggles, arm hiding, view bob suppression, player model rendering, pause-when-paused, etc.
  • Playback queue: un-interruptible scripts queue incoming requests (capacity 8, priority-ordered, auto-continue); interruptible scripts are replaced immediately; priority never overrides interruptibility
  • Multi-player script tracking with completion sync

Compatibility

  • Forge 47.x+ and Fabric 1.20.1 (MultiLoader, no third-party API dependency)
  • Shader pack compatible (no OpenGL pipeline intrusion)
  • View bobbing suppression (hurt shake, walk bob, nausea)
  • Pause-aware: scripts freeze when game is paused

World & Audio

  • Chunk preloading with far camera-region support: hidden fake player drives vanilla chunk/entity tracking, so distant cutscene locations stay loaded and entities are relayed to the real client
  • Per-script preload toggle (meta.preload), next-clip prewarm and end-of-script release diff reuse, configurable radius/cap/force/prewarm settings persisted per platform
  • Audio listener modes (meta.listener: player/camera), sound-engine based AUDIO tracks, relative/absolute positioning and environment-sound redirection

Getting Started

  1. Install Minecraft Forge 1.20.1 (47.x+) or Fabric 1.20.1
  2. Download ImmersiveCinematics and place it in .minecraft/mods/
  3. Launch the game

Commands

Command Description
/icinematics play <file> [players] Play a cinematic script (defaults to all players, supports @a/@p selectors)
/icinematics stop [players] Stop current playback
/icinematics status Show playback status
/icinematics reload Sync global scripts to the world save and reload triggers
/icinematics validate <file> Static-validate a script file (authoring self-check)

In-Game Editor

Use the built-in timeline editor to create and modify scripts visually without leaving the game. Multi-track timeline, keyframe editing, playback control (play/pause toggle + reset-to-first-frame), camera gizmo, and trigger condition editors.

A single build includes both playback runtime and the in-game editor. All users download the same jar.


Version

Current: 0.3.5

Version
Minecraft 1.20.1
Forge 47.x+
Fabric 0.14.0+
Script Format v3

What's Next

0.4.0

  • Camera instance queue and picture-in-picture overlays
  • stat / item_smelt triggers
  • Relative-segment baseline for camera paths

License

MIT License

About

Add cutscenes to your modpack — no command blocks required. 14 trigger types, keyframe camera with Bézier curves, in-game editor.

Topics

Resources

Stars

11 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages