Skip to content

About YAML files

Jump to bottom
CroaBeast edited this page Nov 8, 2025 · 2 revisions

Powered by Takion and PrismaticAPI

📚 Basic Understanding

Before diving into SIR's configuration, it's essential to understand YAML file basics.

🎓 Learning YAML

If you're new to YAML files, check out these helpful tutorials:

🔄 Automatic Updates

SIR features an automatic update system for configuration files:

update: true  # Enable automatic updates for this file
  • When update: true is present, the file will automatically update with new versions
  • If false or absent, the file remains unchanged during updates

📝 Text Input Flexibility

1. Dynamic List Conversion

Any text input can be written in two ways:

# Single line
message: "Welcome to the server!"

# Multiple lines
message: 
  - "Welcome to the server!"
  - "Enjoy your stay!"

# Null inputs (all are valid)
message: null
message: []
# or simply remove the path

2. Unicode Support

Text inputs support Unicode characters in two ways:

# Direct input
message: "Hello! ★ ♥ ☺"

# Using Unicode pattern (<u:xxxx> or <U:xxxx>)
message: "Hello! <u:2605> <u:2665> <u:263A>"

3. Small Caps Conversion

Transform text to small caps using the <small_caps> or <sc> tags:

message: "<small_caps>Hello World!</small_caps>"
# Output: "ʜᴇʟʟᴏ ᴡᴏʀʟᴅ!"

message: "<sc>Welcome</sc>"
# Output: "ᴡᴇʟᴄᴏᴍᴇ"

🎨 Text Formatting

1. Color Support

# Simple Gradient
message: "<g:#FF0000:#0000FF>Amazing Text</g>"

# Multi-Color Gradient
message: "<g:#FF0000>Amazing<g:#00FF00>Text<g:#0000FF>Here</g:#0000FF>"
message: "<g:#FF0000>Amazi<g:#0AB07F>ng Text</g:#0000FF>"

# Rainbow
message: "<rainbow:50>Colorful Message</rainbow>"
message: "<r:1>Colorful Message</r>"

# Single Colors
message: "{#00FF00}Green Text"
message: "%#0000FF%Blue Text"
message: "[#FF00FF]Magenta Text"
message: "<#FFFF00>Yellow Text"
message: "&x00FFFFCyan Text"
message: "&?#FF9900Orange Text"

# Legacy Colors
message: "&aColored Text"

2. Message Types

# Default (chat)
message: "Hello there!"

# Action Bar (available prefixes)
message: "[action_bar]Another action bar message"
message: "[action-bar]Above hotbar message"

# Title (available prefixes)
message: "[title]Big Message"
message: "[title:5]Message with 5 seconds stay time"
message: "[TITLE]Case insensitive"
message: "[Title:10]With custom duration"

# JSON
message: "[json]{\"text\":\"JSON formatted message\"}"

BossBar Configuration (bossbars.yml)

bossbars:
  custom-bossbar:
    progress-decrease: true    # Progress bar decreases over time
    time: 5                   # Duration in seconds
    messages:
      interval: 0             # Interval between messages
      lines:
        - "&e&lMy custom bossbar message :o"
    formats:
      - "RED"                 # Bar color
      - "SEGMENTED_12"        # Bar style
      - "GREEN:SOLID"         # Combined color and style

  bossbar-1:
    messages:
      lines:
        - "&e&lMy custom bossbar message :o"
        - "&cAnother great line"
    time: 7                   # Duration in seconds
    formats: "BLACK"          # Simple color format

# Usage in any message:
message: "[bossbar:custom-bossbar]Message with custom bossbar"

Discord Webhook Configuration (webhooks.yml)

webhooks:
  webhook-1:
    enabled: false
    url: 'YOUR_WEBHOOK_URL'
    content: ''
    username: 'CyberWorldReset'
    avatar-url: 'https://example.com/avatar.png'
    tts: false
    embeds:
      embed-1:
        title: 'Come get some fresh resources!'
        description: '{message}'
        url: ''
        footer:
          text: 'ZeroToil Development'
          icon-url: 'https://example.com/icon.png'
        thumbnail-url: ''
        image-url: ''
        author:
          name: 'Example Webhook'
          url: 'https://example.com'
          icon-url: 'https://example.com/icon.png'
        fields: []
        # Optional fields example:
        #  field-1:
        #    name: 'Subheading'
        #    value: 'Message goes here'
        #    inline: true

  another-webhook: []  # Empty webhook configuration

# Usage in any message:
message: "[webhook:webhook-1]Message to send to Discord"

⚠️ Important Notes:

  • BossBar formats support all Minecraft color names and styles
  • Webhook URLs should be kept private and secure

3. Interactive Chat Components

# Hover Text
message: "<hover:\"Hover tooltip\">Hover over me!</text>"

# Clickable Text
message: "<run:\"/command\">Click to execute</text>"

# Combined Hover and Click
message: "<hover:\"Tooltip here\"|run:\"/help\">Click me!</text>"

# Multi-line Hover
message: "<hover:\"Line 1<n>Line 2\">Hover for more</text>"

🎮 Player Variables

Available in player-related messages (case-insensitive):

message: "Welcome {PLAYER}!"
variables:
  - {player}      # Player name
  - {displayName} # Display name
  - {uuid}        # Player UUID
  - {world}       # Current world
  - {gamemode}    # Player gamemode
  - {x}          # X coordinate
  - {y}          # Y coordinate
  - {z}          # Z coordinate
  - {yaw}        # Player yaw
  - {pitch}      # Player pitch
  - {prefix}     # Player prefix
  - {suffix}     # Player suffix

⚠️ Important Notes

  1. All text patterns are case-insensitive for convenience
  2. Multiple message types can be combined in a single message
  3. Color formatting is provided by PrismaticAPI
  4. Advanced functionality (webhooks, interactive chat) is powered by Takion

🔗 Related Links

Clone this wiki locally