OBSIDREL / DOCS

Documentation

Guides, tutorials and technical references for the Obsidrel ecosystem.

DocumentationRecipe API — methods and examples

Recipe API — methods and examples

RecipeAPI currently provides read-only discovery (all/find). There is no public registerRecipe() method in this interface. Define new recipes using YAML and reload, or investigate an approved extension contract when it exists.

What methods are available?

  • List<RecipeView> all();
  • Optional<RecipeView> find(String id);

These signatures are read directly from the public ObsidrelAPI 1.0 service interface. An Optional result can be empty, boolean results can indicate failure and views are public read-only projections rather than mutable Core objects.

Practical steps

  1. Add ObsidrelAPI as a provided (Maven) or compileOnly (Gradle) dependency. 2. Check Obsidrel is running and fetch ObsidrelProvider.require(1). 3. Call the matching service with an ID that is already loaded. 4. Handle missing values and failures before showing messages to players. 5. Test on a staging server with the exact Core version.

Troubleshooting

If lookup fails, check the resource ID and whether it loaded in Core. If provider lookup fails, confirm the plugin dependency, Core startup and API level. Do not link to private implementation classes; the supported contract is the public me.antzbr.obsidrel.api.* package.

See: API setup · Service catalog.

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.