OlaChat

Configuration Guide

OlaChat features a heavily commented, out-of-the-box ready config.yml. Here are some of the most powerful sections explained.

🔗 Redis vs Standalone

OlaChat relies on Redis to synchronize private messages, replies, spy chat, ignores, and network broadcasts across multiple servers.

• If you are running a Proxy Network (Velocity/BungeeCord), set redis: enabled: true.
• If you are running a Single Server, set it to false. Everything will still work perfectly locally!

🛡️ Vault Provider (Prefixes & Groups)

To accurately display player prefixes, suffixes, and chat formats based on ranks, OlaChat requires a metadata provider. We highly recommend using our native OlaVault plugin over the standard Vault. In your config.yml, leave vault-provider: "AUTO" to automatically detect and prefer OlaVault if it is installed on your server!

🖱️ Interactive Chat (Hover & Click)

You can configure exactly what happens when a player hovers or clicks a name in chat! We fully support PlaceholderAPI (PAPI) here.

chat-interact:
  hover:
    - "<gray>Click to message <gold><player></gold></gray>"
    - "<gray>Ping: <green>%player_ping%ms</green></gray>"
  click-command: "/msg <player> "

Tip: Leave a trailing space in click-command if you want it to suggest the command rather than instantly execute it.

📻 Rich Auto Broadcaster

The built-in broadcaster allows you to schedule rich-text announcements. To change where the announcement appears, simply prefix your message with [ACTIONBAR] or [TITLE].

broadcaster:
  enabled: true
  interval: 300 
  randomize: false
  messages:
    - "<gray>[<gold>Tip</gold>]</gray> <white>You can send private messages using /msg!</white>"
    - "[ACTIONBAR] <gold>Make sure to vote for the server today!</gold>"
    - "[TITLE] <aqua><bold>EVENT STARTING</bold></aqua>;<gray>Check the discord for more details!</gray>"

(For titles, separate the main title and subtitle using a semicolon ;)

📡 Dynamic Channels & Proximity Chat

You can create infinite custom channels.

• Proximity Chat: Set radius: 100 to limit chat to players within 100 blocks. (Set to -1 for infinite).
• Cross Server: Set cross-server: true to route the channel across Redis.
• Triggers: Use prefix: "#" for players to type # hello, or use command: "staffchat" to generate a /staffchat command!

channels:
  local:
    prefix: "!"
    permission: "olachat.local"
    format: "<dark_gray>[<yellow>Local</yellow>]</dark_gray> <gray>[<server>]</gray> <gold><player><reset>: <white><message>"
    cross-server: false
    radius: 100