Skip to content

Configuration ​

config.yml ​

Inside this file, you can find... Configuration for plugin? XD

yml
config-version: 5 # DO NOT CHANGE

#  @      @@@  @@@@@ @   @  @@@  @   @  @@@  @@@@@            @   @  @@@  @@@@  @@@@@ @@@@  @   @
#  @     @   @    @   @ @  @     @   @ @   @   @              @@ @@ @   @ @   @ @     @   @ @@  @
#  @     @@@@@   @     @   @     @@@@@ @@@@@   @      @@@@    @ @ @ @   @ @   @ @@@@  @@@@  @ @ @
#  @     @   @  @      @   @     @   @ @   @   @              @   @ @   @ @   @ @     @  @  @  @@
#  @@@@@ @   @ @@@@@   @    @@@  @   @ @   @   @              @   @  @@@  @@@@  @@@@@ @   @ @   @

options:
  language: English # Available: English, Russian, Ukrainian
  enable-logging: true # Enables logging to console.
  default: local # Chat that will be used by default
  save-internal-chats: true # Saves internal chats (or in other words chats, that included inside plugin).
  broadcast-cooldown: 70 # Cooldown in seconds. Used for guys cannot to spam with broadcasts
  chat-default-cooldown: 1 # Cooldown in seconds. Needed for remove spam. But, in every internal chat (global.yml etc.) uses their own cooldown

  # Enables some experiments like .json for chats or databases for mutes.
  experiments:
    jsonForChats: true
    databasesForMute: true
# ...other sections...

options section. ​

yml
options:
  language: English # Available: English, Russian, Ukrainian
  enable-logging: true # Enables logging to console.
  default: local # Chat that will be used by default
  save-internal-chats: true # Saves internal chats (or in other words chats, that included inside plugin).
  broadcast-cooldown: 70 # Cooldown in seconds. Used for guys cannot to spam with broadcasts
  chat-default-cooldown: 1 # Cooldown in seconds. Needed for remove spam. But, in every internal chat (global.yml etc.) uses their own cooldown

  # Enables some experiments like .json for chats or databases for mutes.
  experiments:
    jsonForChats: true
    databasesForMute: true

Here, we can found options for language, logging and default chat. Also, here you can see experiments. We return to this sub-section later.

  • language - Allows to change language for plugin.
  • enable-logging - Enables logging of EVERY chat to console.
  • default - chat, that will be used by default.
  • save-internal-chats - If enabled (true), internal (global, local, business, etc.) chats will saved.
  • broadcast-cooldown - Time in seconds, that will blocks broadcast for 1 people for that time.
  • chat-default-cooldown - Cooldown for chats by default.

chats section. ​

Here you can change or add chats and settings. As example, we use global, and admin chats.

yml
# ... other sections ...
chats:
  global:
    template: "global.yml" # Template for global chat. You can use formats like json (WIP)
    prefix: "!" # Prefix for use global chat. By default, and most popular — "!".
    radius: -1 # If -1 or 0 — global.
    perm: "" # If not set or just empty, will allow everyone to use this chat
  local:
    template: "local.yml" # Template for local chat.
    prefix: "" # Not set cause isn't need.
    radius: 100
  whisper:
    template: "whisper.yml"
    prefix: ["*", "_", "~"] # Supports aliases
    radius: 10
    perm: "" # If not set or just empty, will allow everyone to use this chat
  # Example chat with perms - Admin chat.
  #admin:
  #  template: "admin.yml"
   # prefix: [":", "^"]
   # perm: "lazychat.admin" # Able for set perm for chat. If not set, perm will be = none.
    # If player do not have perm — He cannot read and send messages in this chat. If he try — in chat will send only text with prefix that DO NOT work.
  # Example chat - Business chat.
  #business:
  #  template: "business.json"
  #  prefix: ["$", ";"]

# ... other sections ...

global ​

  • template - Plugin uses "templates" system, that allows to better manage chats. Requres to set file name from /templates folder inside plugin folder
  • prefix - symbol/word that allows to use chat. In this case
  • radius - radius (in blocks), on that your message will sent. In this case - -1, will sent message to global chat.

whisper ​

  • prefix - also, you can make aliases (or list of variations of prefix)

admin ​

  • perm - permission, that will allows to use chat. If not set - everyone can use this chat. Else, they need to have special permission. Recomended to restart server after change this parametr

blacklist section ​

In this section you can made global blacklist. Like dissallow specify tags. Also, you can disable using MM for signs and MM using in chat by player ever.

yml
# ... other sections
blacklist:
  chat:
    minimessage: false # Disables able for players for use any minimessage tags. By default, colors enabled (or in other words on false).
    gradients: false # Disables able for players for use gradients. By default, gradients enabled (or in other words on false).
    tags: # Disables custom (and not only) tags.
      - newline
      - obf
      - hover
      - lang
      - tr
      - translate
      - font
      - selector
      - score
      - nbt
      - sprite
      - click
  signs: false # Disables able for players for use MiniMessage on signs. By default, enabled (or in other words on false).

Released under the MIT License. Made by LazyCato0o. Created with VitePress.