OBSIDREL / DOCS

Documentation

Guides, tutorials and technical references for the Obsidrel ecosystem.

DocumentationAdd a visual background to a menu

Add a visual background to a menu

Obsidrel supports bitmap inventory backgrounds and clickable hotspots. Place the PNG under plugins/Obsidrel/resources/ui/backgrounds/, then add the documented visual.background section to the menu:

yaml
visual:
  background:
    file: diamond_menu.png
    height: 256
    ascent: 31
    shift-x: -48

On reload, the Core manages the image as a pack source; rebuild and distribute the pack to see the change.

Invisible clickable hotspots

A button can use slots: [0, 1, 2, 9, 10, 11] with render: false. Its image is already drawn in the background, while the invisible inventory slots remain clickable. The parser documents left-actions, right-actions, shift-left-actions, shift-right-actions and middle-actions; actions is a fallback.

If icons are misaligned, adjust background layout and click slots separately. For exact examples read resources/ui/visual-ui.md shipped with the Core.

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.