Documentation / Integrating with Existing Skripts
PROPOSED API
API specification — not a released addon. SkCine-specific syntax shown here is proposed and must be implemented and server-tested before use.

Integrating with Existing Skripts

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.

SkCine must not require a pet, economy, quest, NPC or permissions plugin to create scenes. Integrate through ordinary Skript variables, functions and events.

Trusted reward flow

  1. Your existing gameplay system determines reward and validates payment.
  2. It stores an idempotent transaction/reward ID.
  3. Start a cosmetic SkCine reveal using the already-determined reward.
  4. On skip or finish, grant/reconcile reward exactly once through the gameplay system.
  5. Never reroll the reward inside the cinematic.
# Pseudocode contract only: never duplicate grant logic here.
set {_reward} to {game::reward::%uuid of player%}
set {_scene} to new cine scene named "reveal:custom"
# Configure reveal using {_reward}, then play it.

Optional integrations

  • SkBee / display tooling: coexist without overriding its generic syntax.
  • Citizens / model systems: adapter only, with tested version.
  • PlaceholderAPI: render placeholders safely, per viewer.
  • WorldGuard: respect region controls or provide opt-out permission policy.
  • Resource packs: namespaced sounds and textures, no dependency on SkCine assets.

ChickFarm example

A Chicken Farm Simulator-style server may use SkCine for egg openings, rebirth celebrations and pet reveals, but these are merely examples of universally reusable reward and progression sequences. No world name, currency, player UUID, pet rarity or economy is baked into the addon.

© 2026 DHeaven · SkCine documentation design · All scene authoring happens in Skript (.sk).