Skip to content

Configuration

Jump to bottom
Emmanuel Lampe edited this page Jun 23, 2023 · 5 revisions

To configure FairyChat, you'll need to modify the config.yml file located in the FairyChat plugin directory. The configuration file uses the YAML format, which is a human-readable data serialization standard. Below is a breakdown of the configuration options:

Plugin Updates

FairyChat can automatically check for updates.

checkForUpdates: true
  • checkForUpdates: If set to true, FairyChat will automatically check for and notify you of any available updates.

Redis Credentials

Redis is an open-source in-memory data structure store used for implementing NoSQL key-value databases. In the context of FairyChat, Redis is used for communicating between servers.

redisCredentials:
  enabled: false
  url: redis://localhost:6379
  • enabled: Specifies whether Redis support should be enabled. When enabled, chat messages, broadcasts, and private messages will be handled over Redis.
  • url: The URL of your Redis server.

Setting Redis Username and Password

If your Redis server requires a username and password for authentication, you can include these in the URL. The format is redis://username:password@localhost:6379. Replace username and password with your Redis server's actual username and password.

Database Configuration

You can choose between MySQL and SQLite for your database.

database:
  mysql: false
  url: jdbc:mysql://localhost:3306/fairychat?autoReconnect=true&useSSL=false
  username: root
  password: ''
  playerIgnoreTable: player_ignores
  • mysql: Specifies whether MySQL should be enabled. If disabled, SQLite will be used.
  • url: The URL to the database, only required if MySQL is enabled.
  • username: The username to the database, only required if MySQL is enabled.
  • password: The password to the database, only required if MySQL is enabled.
  • playerIgnoreTable: The name of the table used to store player ignore data.

Chat Format

The chat format determines how chat messages will appear in the chat window.

chatFormat: <#5E548E><player_name></#5E548E> <dark_gray>»</dark_gray> <gray><message></gray>

The chatFormat value is written in the MiniMessage format, which allows for rich text formatting in Minecraft. It uses placeholders (like <player_name> and <message>) that get replaced with dynamic content when the chat is being processed. For a list of all available placeholders, refer to the MiniPlaceholders wiki.

Group Formats

Group formats allow you to define different chat formats based on the player's group. This is especially useful for distinguishing between different ranks or roles on your server.

groupFormats:
  admin: <dark_red><player_name></dark_red> <dark_gray>»</dark_gray> <white><message></white>

In the above example, players in the "admin" group will have their chat messages displayed in a different format. The format is also written in MiniMessage format and supports the same placeholders as the chatFormat.

Private Messaging

This section allows you to configure the private messaging feature of FairyChat.

privateMessaging:
  format:
    <dark_gray>[<#5E548E>PM</#5E548E>] <gray><sender_name></gray> → <#9F86C0><recipient_name></#9F86C0>
    »<dark_gray> <gray><message></gray>
 

 recipientExpirationSeconds: 90
  aliases:
    reply:
      - r
      - answer
    pm:
      - msg
      - message
      - tell
      - whisper
  • format: The format used for private messages, written in MiniMessage format.
  • recipientExpirationSeconds: The duration (in seconds) until a recipient can no longer respond to a private message.
  • aliases: Alternative commands that can be used for reply and pm.

Display Chat in Console

This option lets you decide if player chat messages should be displayed in the console when sent via Redis.

displayChatInConsole: true
  • displayChatInConsole: If true, player chat messages will be displayed in the console when sent via Redis.

Broadcast Messages

This section allows you to configure the format for broadcast messages.

broadcast:
  format: <dark_gray>[<gradient:#BE95C4:#9F86C0:#5E548E>Broadcast</gradient>]</dark_gray>
    <gray><message></gray>
  • format: The format used for broadcast messages, written in MiniMessage format.

Plugin's Messages

Customize the plugin's default messages.

messages:
  youCantMessageYourself: <red>Sorry, you can't message yourself.</red>
  youDidntMessageAnyone: <red>No recent messages received from anyone.</red>
  youCantMessageThisPlayer: <red>Sorry, you can't message this player.</red>
  youCantIgnoreYourself: <red>Sorry, you can't ignore yourself.</red>
  youUnignoredUser: <gray>You can receive messages from <#5E548E><name></#5E548E> again.</gray>
  youIgnoredUser: <gray>You will no longer receive messages from <#5E548E><name></#5E548E>.</gray>

Each key represents a specific message sent by the plugin. You can customize these messages as per your needs.

This page was last updated on June 23, 2023.

Clone this wiki locally