OBSIDREL / DOCS

Documentation

Guides, tutorials and technical references for the Obsidrel ecosystem.

DocumentationObsidrel Java API: developer reference

Obsidrel Java API: developer reference

The Obsidrel Java API is a public, versioned integration contract for Bukkit/Paper plugins and native Obsidrel addons. It is not a REST service or a replacement for content YAML. You can read registered resources, create inventory items, interact with placed furniture and entities, execute actions, control interfaces and inspect runtime data without depending on private Core internals.

Choose your integration

  • External plugin: compile against ObsidrelAPI, declare the Core dependency and get the registered service with ObsidrelProvider.require(1).
  • Native addon: implement ObsidrelAddon, ship obsidrel-addon.yml and access the public platform through AddonContext.
  • Content creator: if you only want a new block, item, recipe or furniture configuration, begin with the normal YAML guides. The Java API is for developers writing integrations.

Available services

Before publishing an integration

Compile with Java 21, match API level 1, depend on the public library using provided/compileOnly and never shade or relocate it. Run your test server with a compatible Obsidrel Core build. Treat Optional and status-returning methods as operations that may fail.

What stays private?

Developers can learn the published signatures and use them. The implementation of the Core, internals and private source files are not part of the public API reference. Only the public me.antzbr.obsidrel.api.* contract is supported.

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.