OBSIDREL / DOCS

Documentation

Guides, tutorials and technical references for the Obsidrel ecosystem.

DocumentationInstallation & Requirements

Installation & Requirements

Prerequisites

ComponentRequirement
JavaJDK/runtime 21
Obsidrel Core1.0.0 build containing the reload-retention update
Skript2.17.1 verified runtime
ServerPurpur 1.21.11 tested
Obsidrel-SkriptNative addon JAR, 1.0.0

A Core JAR labeled 1.0.0 but built before the reload-retention change is not equivalent to the tested build. Verify the Core build, not only its displayed version.

Directory layout

text
plugins/
├── Obsidrel.jar
├── Skript-2.17.1.jar
├── Obsidrel/
│   └── addons/
│       └── ObsidrelSkript-1.0.0.jar
└── Skript/
    └── scripts/
        └── my-obsidrel.sk

The exact server plugin JAR filenames can differ. Do not move Obsidrel-Skript to plugins/ as a separate Bukkit plugin. It has an obsidrel-addon.yml descriptor, not plugin.yml.

Steps

  1. Stop the server completely.
  2. Install a retention-enabled Obsidrel Core and Skript 2.17.1 in plugins/.
  3. Put the Obsidrel-Skript JAR in plugins/Obsidrel/addons/, removing older copies of the same addon.
  4. Start the server and verify that the Core reports Obsidrel Skript — ENABLED.
  5. Place scripts in plugins/Skript/scripts/ and load them using the Skript command.
text
/sk reload my-obsidrel.sk
/obsidrel addons list

First script

skript
command /checkobsidrel:
    trigger:
        if obsidrel has item "obsidrel:ruby":
            send "The ruby definition is loaded." to player
        else:
            send "Ruby definition not found." to player

The sample will return not found if your installation does not define obsidrel:ruby. This is not necessarily a plugin error.

Reloading

  • /sk reload my-obsidrel.sk: reloads a script.
  • /obsidrel reload: reloads Core content; requires Core retention support to keep the bridge active.
  • /obsidrel addons reload skript: intentionally blocked while the bridge is active.
  • Replacing the Skript or Obsidrel-Skript JAR: full server restart required.

Threading

Mutating Obsidrel effects must run on the main server thread. When invoked in an asynchronous Skript section, the bridge ignores the effect and logs one warning rather than scheduling unsafe mutations. Region-thread/Folia usage has not been certified.

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.