🏞️ Paintings

Overview

Custom paintings are configured in paintings.yml. Oraxen reads this file and then generates the paintings via server internals. Use this file to register new paintings.

important

Paintings require Paper 1.21.3+. The painting_variant item component used to give paintings as items requires Paper 1.21.5+.

note

Paintings are hot-reloadable, meaning that your server doesn't require a restart for your changes to apply. Run /oraxen reload paintings to re-register paintings. Please note that you will have to rejoin for some changes to apply; this is a limitation of Minecraft.

warning

To turn the painting into an actual item you still need to use the painting_variant component or see the full tutorial here.

Configuration

Paintings are configured in plugins/Oraxen/paintings.yml.

• 📁 plugins

  • 📁 Oraxen

    • 📄 paintings.yml

info

Painting texture files live in plugins/Oraxen/pack/assets/oraxen/textures/painting/.

asset_id: oraxen:edna points to plugins/Oraxen/pack/assets/oraxen/textures/painting/edna.png.
asset_id: minecraft:ball points to plugins/Oraxen/pack/assets/minecraft/textures/painting/ball.png.

A key without a namespace, for example edna, becomes oraxen:edna. Its texture is then looked up at assets/oraxen/textures/painting/edna.png.

Painting Entry

Each entry under paintings: becomes one painting.

✅ enabled

Disables a painting without deleting it. Defaults to true.

paintings:
  oraxen:edna:
    enabled: false

👤 author

Sets the author of the painting. Supports MiniMessage formatting. Defaults to Oraxen.

paintings:
  oraxen:edna:
    author: the_jan_craft

🎨 title

Defines the title of the painting. Supports MiniMessage formatting. Defaults to the key path.

paintings:
  oraxen:edna:
    title: Edna

📝 asset_id

Sets the asset ID of the painting. Defaults to the painting key.

paintings:
  oraxen:edna:
    asset_id: "oraxen:edna"

📏 width & height

Sets the width and height (in blocks) of the painting when placed. Both default to 1 and are clamped to 1 to 16.

paintings:
  oraxen:edna:
    width: 1
    height: 1

📡 include_in_random

Whether this painting can be randomly selected when a player places a painting. Defaults to false. The legacy random_place key is honored when include_in_random is absent.

paintings:
  oraxen:edna:
    include_in_random: false

Example

paintings:
  oraxen:edna:
    author: the_jan_craft
    title: <red>Edna Painting
    asset_id: oraxen:edna # This will reference plugins/Oraxen/pack/assets/oraxen/textures/painting/edna.png
    width: 1
    height: 1
    include_in_random: false