Skip to content

SanZiNEO/ImmersiveCinematics

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 — 16 trigger types covering login, location, advancement, biome, dimension change, entity kill, entity interact, block interact, item-on-interact, item craft, item use, item consume, inventory, structure, gamestage, and custom event.

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
  • Multi-track timeline: camera, letterbox, audio, event, mod event
  • Widescreen letterbox bars with keyframe-driven aspect ratio animation
  • Morph transitions between shots

Trigger System (Server-Side)

  • 16 trigger types: login, location (point+radius / cuboid area), advancement, biome, dimension change, entity kill, entity interact, block interact, item-on-interact, item craft, item use, item consume, inventory, structure, gamestage, custom event
  • OR/AND logic and wildcard matching supported
  • Repeatable or single-fire, with configurable delay

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.
  • Script queuing and preemption for fixed-camera zones
  • Multi-player script tracking with completion sync

Compatibility

  • Shader pack compatible (no OpenGL pipeline intrusion)
  • View bobbing suppression (hurt shake, walk bob, nausea)
  • Pause-aware: scripts freeze when game is paused

Getting Started

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

Commands

Command Description
/icinematics play <file> Play a cinematic script
/icinematics stop Stop current playback
/icinematics status Show playback status

In-Game Editor

Use the built-in timeline editor to create and modify scripts visually without leaving the game.

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


Version

Current: 0.3.2

Version
Minecraft 1.20.1
Forge 47.x+
Script Format v3

What's Next

0.4.0

  • Audio track: background music and sound effects synced to timeline, with fade-in/out and looping
  • Event track: execute in-game commands at any point on the timeline
  • Full multi-track timeline support: all track types visible and editable

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

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages