Skip to content
This repository has been archived by the owner on Nov 29, 2022. It is now read-only.
/ yapper-old Public archive
generated from SolteraGG/kotlin-plugin-base

Chat management, formatting and cross-server communication plugin.

License

Notifications You must be signed in to change notification settings

kaylendog/yapper-old

Repository files navigation

StickyChat

Chat plugin, formatter, and messaging system for dddMC.

Overview

  • Chat formatting with PlaceholderAPI support
  • Custom death message support
  • Persistent nicknames
  • SignSpy
  • Mail system
  • Direct message system with server-wide blocking support
  • Custom join/leave messages
  • Cross-server support using Redis pub/sub
  • MotD support
  • Timed message broadcasts

API

StickyChat provides an API other plugins can use to interface with its chat, direct messaging, and mail system. You can find the JavaDocs for the API here.

Configuration

The default configuration for StickyChat is below.

#
# StickyChat
# Authors: SkyezerFox
#
# Main Configuration File
#

# Configure remote database settings.
data:
  enable: true
  database: minecraft
  tableprefix: stickychat_
  host: localhost
  port: 5432
  username: postgres
  password: password

# Configure the prefix used by StickyChat
prefix: "&b&lStickyChat &r&8» &r"

# Configuration for chat.
chat:
  # The default format to use.
  # Supports placeholders and color codes.
  format: "&7%player_name% &8» &7%message%"

  # Disable join/quit messages - useful if you have a bungee plugin handling them for you already.
  disable-join-messages: false
  disable-quit-messages: false

  # Whether StickyChat should format death messages.
  format-death-messages: true
  death-message-format: "%message%"

  # Configuration for staff chat
  staff-chat-format: "&d[SC] &7%player_name% &8» &7%message%"
  staff-chat-prefix: +

# Configuration for private messages.
#
# Available formats:
# %from_name% - Name of the player who sent the message
# %from_uuid% - UUID of the player who sent the message
# %to_name% - Name of the player who received the message
# %message% - The message
#
# Supports placeholders and color codes. For incoming messages, placeholders will be evaluated
# as the recipient. For outgoing, they will be evaluated as the sender.
dms:
  incoming:
    enable-sound: true
    format: "&8[&e&lPM&r&8] &a%from_name% &8» &r%message%"
  outgoing:
    format: "&8[&e&lPM&r&8] &a%from_name% &8» &r%message%"

# various debug options
debug:
  # Allow players to send themselves messages.
  enable-self-message: false

License & Copyright

Yapper is licensed under the GNU General Public License v3. See the LICENSE for more information.

Copyright (c) 2022 Kaylen Dart and contributors.