Files
2026-01-15 19:50:49 +00:00

124 lines
4.7 KiB
YAML
Executable File

# ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
# ┃ HuskChat - Config ┃
# ┃ Developed by William278 ┃
# ┣━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
# ┣╸ Information: https://william278.net/project/huskchat/
# ┣╸ Config Help: https://william278.net/docs/huskchat/config-files/
# ┗╸ Documentation: https://william278.net/docs/huskchat/
# Locale of the default language file to use. Docs: https://william278.net/docs/huskclaims/translations
language: en-gb
# Whether to automatically check for plugin updates on startup
check_for_updates: false
# Whether to handle chat packets directly for better 1.19+ support (may cause rare compatibility issues)
use_packet_listening: true
# Placeholder settings
placeholder:
# Use PlaceholderAPI. If you're on Bungee/Velocity, this requires PAPIProxyBridge installed
use_papi: true
# If using PAPIProxyBridge, how long to cache placeholders for (in milliseconds)
cache_time: 3000
# Message comamnd settings
message_command:
# Whether to enable the /msg command
enabled: true
# List of command aliases for /msg
msg_aliases:
- /msg
- /m
- /tell
- /whisper
- /w
- /pm
# List of command aliases for /reply
reply_aliases:
- /reply
- /r
# Whether to apply censorship filters on private messages
censor: false
# Whether to log private messages to the console
log_to_console: false
# Logging format for private messages
log_format: '[%sender% -> %receiver%]: '
# Group private message settings
group_messages:
# Whether to enable group private messages (/msg Player1,Player2,...)
enabled: true
# Maximum amount of players in a group message
max_size: 10
# Formats for private messages (uses MineDown)
format:
inbound: '&e&l%name% &8→ &e&lYou&8: &f'
outbound: '&e&lYou &8→ &e&l%name%&8: &f'
group_inbound: '&e&l%name% &8→ &e&lYou[₍₊%group_amount_subscript%₎](gray show_text=&7%group_members%)&8:
&f'
group_outbound: '&e&lYou &8→ &e&l%name%[₍₊%group_amount_subscript%₎](gray show_text=&7%group_members%)&8:
&f'
# (Bungee/Velocity only) List of servers where private messages cannot be sent
restricted_servers: []
# Social spy settings (see other users' private messages)
social_spy:
enabled: false
format: '&e[Spy] &7%name% &8→ &7%receiver_name%:%spy_color% '
group_format: '&e[Spy] &7%name% &8→ &7%receiver_name% [₍₊%group_amount_subscript%₎](gray
show_text=&7%group_members% suggest_command=/msg %group_members_comma_separated%
):%spy_color% '
socialspy_aliases:
- /socialspy
- /ss
# (Bungee/Velocity only) Local spy settings (see local messages on other servers)
local_spy:
enabled: false
format: '&e[Spy] &7[%channel%] %name%&8:%spy_color% '
localspy_aliases:
- /localspy
- /ls
# List of channels to exclude from local spy
excluded_local_channels: []
# Broadcast command settings
broadcast_command:
enabled: false
broadcast_aliases:
- /broadcast
- /alert
format: '&6[Broadcast]&e '
log_to_console: true
log_format: '[BROADCAST]: '
# Join and quit message settings
join_and_quit_messages:
# Use the "huskchat.join_message.[text]" permission to override this.
# Use the "huskchat.silent_join" permission to silence for a user.
join:
enabled: true
format: '&e%name% joined the network'
# Use the "huskchat.quit_message.[text]" permission to override this.
# Use the "huskchat.silent_quit" permission to silence for a user.
quit:
enabled: true
format: '&e%name% left the network'
# Note that on Velocity/Bungee, PASSTHROUGH modes won't cancel local join/quit messages
broadcast_scope: GLOBAL
# Discord integration settings. Docs: https://william278.net/docs/huskchat/discord-hook
discord:
# Enable hooking into Discord via Webhooks and/or Spicord
enabled: false
# Discord message format style (INLINE or EMBEDDED)
format_style: INLINE
# Send messages in channels to a webhook by mapped URL
channel_webhooks: {}
# Whether to hook into Spicord for two-way chat
spicord:
# Requires Spicord installed and "huskchat" added to the "addons" in config.toml
enabled: true
# Format of Discord users in-game. Note this doesn't support other placeholders
username_format: '@%discord_handle%'
# Send in-game messages on these channels to a specified Discord channel (by numeric ID)
receive_channel_map:
global: '123456789012345678'
# Send Discord messages on these channels (by numeric ID) to a specified in-game channel
send_channel_map:
'123456789012345678': global
# Custom names to display wherever you use the "%server%" placeholder instead of their default name
server_name_replacement:
very-long-server-name: VLSN