OBSIDREL / DOCS

Documentation

Guides, tutorials and technical references for the Obsidrel ecosystem.

DocumentationObsidrel Skript — Overview

Obsidrel Skript — Overview

Obsidrel Skript

Obsidrel Skript is a native addon that lets Skript scripts work with custom content managed by Obsidrel Core. It runs through Obsidrel's addon runtime, not as another Bukkit JavaPlugin.

What can you script?

  • Items, blocks and furniture: check definitions and create or give the matching ItemStacks.
  • Actions and conditions: execute configured Obsidrel actions or evaluate Core conditions.
  • Player Data: read, write and reset stored values; check player timers.
  • Cooldowns: inspect readiness, read milliseconds remaining and reset cooldown state.
  • Interfaces: open Obsidrel menus and show or hide HUDs.
  • Events: react to 23 Obsidrel public event types, read their identifiers and cancel supported events.
  • Other services: interact with cosmetics, custom entities, sounds and loot rolls through the exposed effects.

The integration registers 15 effects, 8 conditions, 7 expression patterns and 23 event patterns. This describes the available syntax, not a claim that every operation has been individually tested on all servers.

Quick example

skript
command /myruby:
    trigger:
        if obsidrel has item "obsidrel:ruby":
            obsidrel give item "obsidrel:ruby" to player

on obsidrel furniture interact:
    send "Furniture: %obsidrel event id%" to event-player

obsidrel:ruby is a sample resource ID. Replace it with a definition loaded by your Core installation.

Requirements and verified environment

  • Obsidrel Core 1.0.0 with the core-reload: retain support.
  • Skript 2.17.1, installed separately in the server's plugins/ directory.
  • Java 21.
  • Validated on Purpur 1.21.11. Other server types and versions are not individually certified; Folia-specific execution has not been certified.

Obsidrel-Skript's Maven dependency on Skript 2.16.2 is a compile-time API version, not the server runtime used for validation.

Documentation map

  1. Installation & Requirements
  2. Effects Reference
  3. Conditions Reference
  4. Expressions Reference
  5. Events Reference
  6. Practical Examples
  7. Troubleshooting & Compatibility

Important lifecycle rule

/obsidrel reload refreshes Core content while retaining this addon's Skript syntax registrations on a compatible Core build. Replacing the addon JAR requires a full server restart. Running /obsidrel addons reload skript is intentionally refused to prevent invalid script references.

Was this article helpful?Loading ratings…

Help us improve Obsidrel documentation. One vote per account and article. Discord AI feedback can also contribute when the answer cites this article.