OBSIDREL / DOCS

Documentation

Guides, tutorials and technical references for the Obsidrel ecosystem.

DocumentationFonts: glyph icons, custom PNG, aliases and chat

Fonts: glyph icons, custom PNG, aliases and chat

Definitions live in plugins/Obsidrel/resources/fonts/. Custom glyphs require a pack successfully loaded by the player.

Basic example without custom PNG

yaml
icons:
  enabled: true
  glyphs:
    orb:
      texture: 'minecraft:item/emerald.png'
      codepoint: AUTO
      aliases: [':orb:', ':gem:']
      height: 8
      ascent: 8
      chat:
        enabled: true
        permission: ''

First test with a vanilla image.

Advanced: use your own PNG

  1. Save orb.png under plugins/Obsidrel/pack/source/assets/obsidrel/textures/font/orb.png.
  2. Set the glyph field to texture: obsidrel:font/orb.png.
  3. Run /obsidrel pack build, distribute the pack and test :orb:.
  4. Ordinary chat aliases additionally require the global aliases bridge and chat.enabled.
FieldPurpose
enabledEnable collection
glyphs.<id>.texturePNG path with extension
codepointAUTO or selected codepoint
aliasesText shortcuts such as :orb:
height, ascentGlyph geometry and baseline
chat.enabled, chat.permissionOptional chat exposure and permission

Important: font textures include .png, unlike Blocks/Items model.texture resource keys.

Fonts/UI · Pack build and delivery.

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.