OBSIDREL / DOCS

Documentation

Guides, tutorials and technical references for the Obsidrel ecosystem.

DocumentationComplete reference: Actions

Complete reference: Actions

Actions live in resources/actions/. Definitions are reusable and execute only when invoked.

FieldFormatBehavior
enabledboolean (true)Activation
permissiontext/emptyWhole-action permission
conditions / conditionIDsPreconditions
failure-message / condition-messagetextDenial feedback
steps / actionsmapOrdered steps
steps.<id>.typeoperation typeSelects effect
steps.<id>.delayduration (5t, 2s)Delay
steps.<id>.chanceprobabilityExecution chance
steps.<id>.permissiontextStep gate
steps.<id>.conditionsIDsStep-only eligibility
steps.<id>.cancel-eventbooleanSupported event cancellation

Core operations include MESSAGE, COMMAND, SOUND, TITLE, ACTION_BAR, PARTICLE, GIVE_ITEM, REMOVE_ITEM, TELEPORT, MENU, HUD, ACTION, VAR_SET, VAR_ADD, VAR_REMOVE, VAR_RESET, FLAG_SET, FLAG_TOGGLE, TIMER_START, LOOT, CLOSE_MENU. Aliases include GIVE, REMOVE, LOOT_TABLE; additional operations exist in specialized engines. Each type has distinct parameters.

Advanced reusable example

yaml
reward:
  enabled: true
  conditions: [showcase_level_five]
  steps:
    notice:
      type: ACTION_BAR
      message: '<green>Reward unlocked</green>'
    prize:
      type: GIVE_ITEM
      delay: 10t
      item: AMETHYST_SHARD
      amount: 1

showcase_level_five is a bundled Showcase condition; replace with your own ID otherwise.

Three-file project · Conditions · Triggers.

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.