HiberniaDiscord » Chat to Discord Integration. - HiberniaDiscord 聊天同步到 Discord

HiberniaDiscord 是一款面向性能优化的 Minecraft 1.16.5 聊天桥接插件，可将游戏内聊天发送到 Discord，并通过内置的 discord2mc（可选）实现 Discord 与 Minecraft 双向通信。

⭐插件简介

只需创建一个 Webhook，把它填入配置文件，即可快速开始使用。

如果要启用 discord2mc，则还需要单独配置一个 bot token。

如果你在使用中遇到困难、想请求新功能，或想提出未来插件创意，可以加入开发者的 Discord：https://paradaux.io/discord

✨主要特性

• 通过 Web-hooks 与可选的 Discord bot，实现 Discord 与 Minecraft 双向通信
• 配置文件可完整翻译
• 易于配置
• 出色的插件兼容支持
• 支持为玩家加入、离开等事件设置自定义消息
• 支持 PlaceholderAPI 占位符

🎮安装步骤

• 使用上方按钮下载 HiberniaDiscord
• 将 HiberniaDiscord-3.0.0-RELEASE.jar 拖入 ~/plugins 文件夹
• （重新）启动服务器以生成配置文件
• 前往 ~/plugins/HiberniaDiscord 并打开 config.yml
• 创建一个 webhook，并将其填入对应字段
• 再次（重新）启动服务器
• 确认消息已发送到正确的频道

🔧基础配置说明

HiberniaDiscord 的配置非常简单。

你可以自定义插件中的所有英文消息，如有需要，作者也可以按请求提供命令本身的翻译。

作者还强烈建议你根据自己服务器的需求，修改 Avatar URL 以及各类事件消息。

config.yml

# Copyright © 2020 Property of Rían Errity Licensed under GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007. See <LICENSE.md> 
# Thank you for using HiberniaDiscord by Paradaux.io 
# Should you run into issues, feel free to pop into my discord server @ https://paradaux.io/discord 
# Additional Configuration is available in locale.yml (be sure to change the response of /discord to that of your server) 
# Buy me a beer: https://paypal.me/Paradaux 
discord 
:  
# disable this if you do not wish to have HiberniaDiscord register /discord. Change the invite link in locale.yml 
discord-command 
: true
# Discord webhook URL 
# To create a webhook, see https://support.discordapp.com/hc/en-us/articles/228383668-Intro-to-Webhooks 
webhook-url 
: ''
# Server name is used in the %server_name% placeholder. 
server-name 
: 'Server'
# Avatar API, for changing the Discord avatar per player 
# By default we use crafatar but you can switch these options to use whichever you like. Ask in the discord for support with this. 
# %playeruuid% will be replaced with the user's uuid. 
avatar-api 
: 'https://crafatar.com/renders/head/
%playeruuid%?size=10&overlay' 
# The following section toggles individual message updates when said events occur. 
events 
: 
# Placeholders: (Placeholder API support is baked in, if you have it installed.) 
#     * %playername% - The Player's Username 
#     * %playeruuid% - The Player's UUID 
#     * %servername% - The Server's name you specified above 
#     * %avatarapi% - The Avatar API you specified above. 
# There may be other placeholders, that are section specific such as %messageContent% referred to the content of the Message Event. 
# Empty messages will be replaced with a zero-width space so they appear as empty messages on discord. 
# Occurs when a message is sent in chat. 
chat-message :
enabled 
: true
avatar-url 
: '
%avatarapi%' 
username-format 
: '
%playername%' 
message-format 
: '
%messageContent%' 
# New Feature in 3.0.1! Allows server who use localised/global channels to only send messages to disocrd when 
# prefixed by some string, specified below. Disabled by default. 
message-prefix 
: '!'
message-prefix-disabled 
: true
# Occurs when a player joins the server. Player-specific Placeholders from PlaceholderAPI are supported here. 
player-join :
enabled 
: true
avatar-url 
: '
%avatarapi%' 
username-format 
: '
%servername% »' 
message-format 
: '
%playername% has joined the game.' 
# Occurs when a player leaves the server. Player-specific Placeholders from PlaceholderAPI are supported here. 
player-leave :
enabled 
: true
avatar-url 
: '
%avatarapi%' 
username-format 
: '
%servername% »' 
message-format 
: '
%playername% has left the game' 
# Advancement (Achievement) Completed event. 1.16.X only. 
advancement-completed :
enabled 
: true
avatar-url 
: '
%avatarapi%' 
username-format 
: '
%servername% »' 
message-format 
: '
%player% has completed %achievementName%' 
# Occurs when the server loads the plugin. Placeholders from PlaceholderAPI are NOT supported here. 
server-startup :
enabled 
: true
avatar-url 
: 'https://cdn.paradaux.io/static/plugin-branding/hiberniadiscord/hibernia-discord.png'
username-format 
: '
%servername% »' 
message-format 
: '
%servername% has started.' 
# Occurs when the server disables the plugin. Placeholders from PlaceholderAPI are NOT supported here. 
server-shutdown :
enabled 
: true
avatar-url 
: 'https://cdn.paradaux.io/static/plugin-branding/hiberniadiscord/hibernia-discord.png'
username-format 
: '
%servername% »' 
message-format 
: '
%servername% has stopped.' 
settings 
:  
# Provides Additional information for debug purposes. 
debug 
: false
# Provide anonymized usage stats so that I create features oriented towards my user-base 
# I won't hurt your family if you disable this, but I would appreciate you leaving it enabled. 
# It gives me information such as server versions, player counts, Java versions etcetera. Nothing identifiable. 
# You can find more information at the bottom of this configuration file. 
# https://bstats.org/plugin/bukkit/HiberniaDiscord/8386 
bstats 
: true
# Configure the permissions HiberniaDiscord listens to. 
discord-command-permission 
: 
"hiberniadiscord.discord" 
reload-command-permission 
: 
"hiberniadiscord.reload" 
update 
:  
# Whether or not to automatically check for updates and notify the console if found 
check 
: true
# Whether or not to notify players with the hdiscord.admin permission node 
notify 
: true
# Config version, no touchy plz 
config-version 
: 2.4
# BStats.org Notice. 
# bStats does not collect any personal data. Most of the collected data is information about the plugin's server like player count, online mode, 
#  Minecraft version, Java version, and more. All data gets sent and stored completely anonymously. Server IPs are only stored for ratelimiting 
# and not linked to the data. All data that is collected is publicly visible. If you are interested in what data is collected for your Minecraft 
# server, take a look at the pages for the plugins on your server. Please note that plugin authors can also send data that is customized for their plugin. 
# https://bstats.org/plugin/bukkit/HiberniaDiscord/8386 
# Force-disabling bStats 
# If you don't trust me, and my settings bstats has its own system to disable plugins' bstats. 
# Disabling bStats 
# If you don't want bStats to collect data from your server, you can disable it in the bStats config file. This file can be found in the /plugins/bStats/ folder. 
# bStats has nearly no effect on your server's performance and the sent data is completely anonymous. The collected data is important information for plugin authors 
# to improve their plugins and keep motivated. To value their work and effort, please keep bStats enabled. 

🔧配置 Discord2Mc

这是一个可选功能，用于将 Discord 消息发送到 Minecraft。

原作者说明：该功能目前处于 alpha 状态，请自行承担使用风险。

启用步骤

• 创建一个 Discord bot，并获取它的 token
• 打开 ~/plugins/HiberniaDiscord/discord2mc.yml
• 将 token 填入 token 字段
• 获取你希望 bot 监听的频道 ID
• 将该频道 ID 作为元素加入 monitoredChannels 列表
• 将 enabled 设置为 true
• （重新）启动服务器即可

如果你的配置文件损坏或无效，可以使用下方默认配置文件进行恢复。

discord2mc.yml

# This is optional functionality which will allow you to have discord messages me sent to minecraft. This is fully customizable. 
# This functionality is in an alpha state. use at your own risk. 
# Switch this to true to use the discord2mc functionality 
enabled 
: false
# This is the API token for your discord bot please see https://www.writebots.com/discord-bot-token/ for more information. 
# Do NOT share this. 
# In order for your bot to see the messages in your server, you will need to invite it to your server 
# as if you would with any other discord bot. Use the base link below, replacing the client id of your bot 
# https://discord.com/oauth2/authorize?client_id=CLIENTID&scope=bot 
token 
: ''
# For discord commands. ; by default. 
# Set it to 'disabled' to disable discord commands. 
# Commands are coming in 3.1.0, please suggest commands you'd like to see! 
command-prefix 
: ';'
# Whether or not messages from bots are sent in-game. 
send-messages-from-bots 
: false
# This list is for the channel IDs of the channels you want the bot to listen to messages in. 
# See https://kb.statbot.net/faq/how-do-i-find-my-server-user-channel-id/ for information on how to get channel IDs 
monitored-channels 
:  - 'channelID'
- 'anotherChannelID'
# This is where you'll control how your discord messages appear in-game. 
# There's a number of placeholders you can use. 
# %username% - Their discord username 
# %discriminator% - The four digits following their username# 
# %nickname% - Their nickname on the guild the message was sent. 
# %guildname% - The name of the guild (server) the message was sent 
# %message% - The message itself 
# %mainrole% - The highest role they have. 
# Request more placeholders on the support discord. 
message-format 
: 
"&7D: &7#%channel%: <&c%mainrole%&7> <&c%username%#%discriminator%&7>: &7%message%" 
# No touchy 
version 
: 1.0

🎮默认语言文件

locale.yml 主要用于命令反馈，例如 /discord 和 /hiberniadiscord 的返回文本。

你可以借此自定义插件响应内容。

locale.yml

# Copyright © 2020 Property of Rían Errity Licensed under GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007. See <LICENSE.md> 
# Thanks for using HiberniaDiscord. Here you will find the default (English_IE) locale for HiberniaDiscord 
# The Locale only concerns command feedback, such as /discord and /hiberniadiscord, allowing you to customize responses. 
# If you would like to create an official language translation which would be shipped with the plugin please contact me. [email protected] 
# Changing this could result in "unintended" consequences. You have been warned. 
locale-version 
: 1.0
prefix 
: 
"&cHibernia&3Discord &7» " 
loading-message 
:  - 
"+ ------------------------------------ +" 
- 
"|   Running HiberniaDiscord v3.0.0     |" 
- 
"|       © Rían Errity (Paradaux)       |" 
- 
"|         https://paradaux.io          |" 
- 
"+ ------------------------------------ +" 
- 
"LICENSED UNDER GNU General Public License v3.0" 
shutdown-message 
:  - 
"+ ------------------------------------ +" 
- 
"|   Unloaded HiberniaDiscord v3.0.0    |" 
- 
"|       © Rían Errity (Paradaux)       |" 
- 
"|         https://paradaux.io          |" 
- 
"+ ------------------------------------ +" 
- 
"LICENSED UNDER GNU General Public License v3.0" 
severe-messages :
old-version-config 
: 
"HiberniaDiscord » &7You were running an old version. Large configuration changes occurred between v2.1.X and v3.0.0 requiring your configuration to be overwritten. Apologies for any inconvenience caused." 
config-not-exist 
: 
"HiberniaDiscord » Your configuration file doesn't seem to exist, is it invalid? a new version has been deployed. If this is your first run, this isn't cause for concern." 
bad-backup 
: 
"HiberniaDiscord » An issue occurred whilst backing up your configuration file." 
no-permission 
: 
"&c%prefix% &cYou do not have permission." 
hiberniadiscord :
reload-success 
: 
"%prefix% &cconfig.yml &7& &clocale.yml &c have been &creloaded&7." 
default 
:    - 
"%prefix% &cDeveloped &7and &cMaintained&7 by &cParadaux" 
- 
"&7This is &copen source &7software, please leave this &cattribution&7." 
- "&7For support 
: 
&chttps://paradaux.io/discord" 
discord 
: 
# This message is sent when /discord is used. The permission for this command is in config.yml 
# You can add additional lines if you wish to create a more complex message. 
default 
:    - 
"&7Check out our &3discord &7server (&cClick me!&7)" 
# The clickable link 
link 
: 
"https://paradaux.io/discord" 

❓占位符与自定义说明

config.yml 中常见占位符

• %playername% - 玩家名称
• %playeruuid% - 玩家 UUID
• %servername% - 你在配置中设置的服务器名称
• %avatarapi% - 你配置的头像 API
• %messageContent% - 消息事件中的聊天内容

discord2mc.yml 中常见占位符

• %username% - Discord 用户名
• %discriminator% - 用户名后的四位数字标识
• %nickname% - 发送消息时该用户在服务器中的昵称
• %guildname% - 消息来源的 guild（服务器）名称
• %message% - 消息内容
• %mainrole% - 用户的最高角色
• %channel% - 频道名称

事件说明

• chat-message：玩家聊天时触发
• player-join：玩家加入服务器时触发
• player-leave：玩家离开服务器时触发
• advancement-completed：完成进度/成就时触发，仅适用于 1.16.X
• server-startup：插件加载时触发
• server-shutdown：插件卸载时触发

注意事项

• 如果安装了 PlaceholderAPI，插件已内建支持相关占位符
• 空消息会被替换为零宽空格，以便在 Discord 中显示为“空消息”
• /discord 命令是否注册，可在 config.yml 中通过 discord-command 控制
• discord2mc 需要额外的 Discord bot token
• 请勿泄露你的 bot token

💡反馈与支持

• 发现 Bug 时，请使用 issue tracker 进行报告，而不是在评论区反馈
• 你也可以加入支持 Discord：https://paradaux.io/discord
• 原文中的 issue tracker 链接以页面中的 here 为准

✨支持开发

如果你愿意，可以通过原文提供的支持链接进行赞助。

支持者可在开发者的 Discord 服务器中获得 “supporter” 身份组，以及优先支持和功能建议反馈。

• 赞助链接以原页面中的 here 为准