CineFrame

# CineFrame Play real video clips on item frames with synced audio on a Minecraft Java server. !(https://www.davids-repo.dev/mc/cineframe-preview.webp) **For video preview go (https://www.davids-repo.dev/cineframe/)** ## Features * Turns a wall of item frames into a video screen * Plays map video at up to 20 FPS * Synced audio through a resource pack that CineFrame builds and hosts * Pause and resume support, with audio rebuilt from the paused time * Auto replay support * Command based screen placement for command blocks and setup tools * PacketEvents map updates, so players only get the map data they need * Distance based packet range, so far away players stop getting screen packets * Folia scheduler support ## Requirements * A Minecraft Java server running Paper 26.2 or a compatible fork * Java 25 * PacketEvents installed * CineFrame installed * A video file in `plugins/CineFrame/media/` Tested server types can include Paper, Purpur, Pufferfish, Leaf, and Folia, as long as the build supports the same API version CineFrame was built for. Windows is the safest setup right now. Linux can work, and Linux ARM has a config option for frame format if playback is flaky. ## Install 1. Drop (https://www.davids-repo.dev/cineframe/assets/26.2/packetevents.jar) into your `plugins/` folder. 2. Drop CineFrame into your `plugins/` folder. 3. Restart the server once so CineFrame can make its folders. 4. Put videos in `plugins/CineFrame/media/`. Supported video files: * `.mp4` * `.mov` * `.webm` * `.mkv` * `.avi` After that, edit `plugins/CineFrame/config.yml` so players can download the audio resource pack. Restart the server after changing the config. ## Upgrade note If you are updating from an older CineFrame build, check your `config.yml`. Older configs may be missing the newer settings for debug level, packet range, map FPS, and Linux ARM frame format. You can add the keys below by hand, or back up your old config and let CineFrame create a fresh one. ## Config These keys are used by CineFrame to host the resource pack zip and control video packet sending. ```yaml # Port used for datapack download for users datapack-port: 25564 # Public URL or IP for remote players # Do not include http:// or https:// # You can find your public IP at https://whatismyipaddress.com/ # You can also use a domain if you already have one set up datapack-public-host: "mydomain.com" datapack-scheme: "http" datapack-public-port: 25564 # LAN URL for players on the same network as the server # This should be the server's LAN IP, not localhost # On Windows: # Press Win + R, type cmd, press enter, type ipconfig, press enter, # then find the IPv4 for the current network adapter. datapack-local-host: "10.0.0.42" datapack-local-scheme: "http" datapack-local-port: 25564 # Loopback URL for clients connected from 127.0.0.1 or ::1 datapack-loopback-host: "localhost" datapack-loopback-scheme: "http" datapack-loopback-port: 25564 # Debug logging for pack choice # Shows which resource pack URL was sent to each player datapack-debug-pack-url: false # Debug logging for the HTTP server # Shows pack download requests and responses datapack-http-debug: false datapack-http-log-headers: false # Debug log level # 0 = off # 1 = basic info # 2 = normal # 3 = more logs # 4 = very chatty # 5 = spammy cineframe-debug-level: 0 # How far away a player can be from a screen before CineFrame stops sending map packets # Range is measured in blocks from the center of the screen cineframe-packet-range-blocks: 64 # How often CineFrame checks which players are close enough to receive packets # Value is in milliseconds cineframe-packet-range-check-ms: 1000 # The frame rate used for map image updates # Must be between 1 and 20 cineframe-map-fps: 20 # Linux ARM frame format for live playback # png = safer on ARM # mjpeg = can be faster on some systems, but can be less stable if decoding is flaky linuxarm-frame-format: "mjpeg" ``` ## Commands All commands use the `cineframe.use` permission. This permission is enabled for everyone by default. ### Start placing a video screen ```md /media <filename> ``` Example: ```md /media trailer.mp4 ``` If the file name has spaces, type the full name. Example: ```md /media my video file.mp4 ``` After running `/media`, left click the first corner of the screen, then left click the opposite corner. The two corners must be on the same flat wall. They must share either the same X or the same Z value. CineFrame will spawn item frames and show the first frame of the video. ## Place a screen with coordinates ```md /mediacorners <x1> <y1> <z1> <x2> <y2> <z2> ``` This only works after `/media <filename>` has been run. Example: ```md /media trailer.mp4 /mediacorners 10 65 20 14 62 20 south ``` You can leave the facing out if you are running the command as a player. CineFrame will try to pick the facing from where you are standing. The fac