Installation & Requirements
API status — PROPOSED, NOT IMPLEMENTED. SkCine is currently a design specification in this conversation; no built SkCine.jar or syntax registry was supplied. All SkCine-specific examples are intended API contracts, not verified runnable
.sk. Do not advertise these as tested until each example passes a real Skript reload and runtime test.
Intended requirements
| Component | Target/notes |
|---|---|
| Server | Paper 1.21.11 is the mandatory integration-test baseline |
| JVM | Java 21 for primary Paper target; Paper 26.x versions requiring Java 25 must run on Java 25 |
| Skript | 2.16.x on compatible Paper; separately test 2.17.x |
| SkCine | Not yet available as a verified binary |
| PacketEvents | Optional camera/entity packet backend, independently installed where supported |
| Resource pack | Optional for custom audio/overlays |
Intended deployment sequence (once released)
- Confirm Paper/Java/Skript version using server console and plugin information.
- Stop server, copy verified
SkCine-<version>.jarintoplugins/, and start server. - Check
plugins/startup logs. Investigate any disabled optional camera backends. - Save scripts into
plugins/Skript/scripts/. - Run
/sk reload <script-name>; fix the first parser error before proceeding. - Try the first cinematic on a test server before deploying to production.
Do not install a speculative artifact from this documentation. The repository needs code, a compiled JAR, and an in-game validation matrix before these steps are actionable.
No authoring GUI or scene YAML
The plugin may use plugins/SkCine/config.yml for engine budgets and diagnostics, but all scenes, keyframes, triggers, effects and logic live in Skript. Commands such as /skcine info are diagnostic only; no /skcine scene create is required or intended.
Fallbacks and limitations
- Without packet integration: use a verified spectator/camera entity fallback when available, or report unsupported mode; never silently promise a modded camera.
- Resource pack absent: use native sounds and title/subtitle approximations.
- Unsupported features: fail with a clear capability result before changing player state.
- Never claim support for a version without loading and running smoke tests on it.
Verified upstream references
- Skript 2.17.0 release — Paper 1.21.5–26.3.
- Skript 2.16.2 release — Paper 1.21.4–26.2.
- Skript addon API and AddonModule.
- SyntaxRegistry.
- Paper Display API 1.21.11.
- PacketEvents dependency guidance.
These links verify upstream capabilities and version declarations, not the existence of SkCine syntax.