ImageEmojis 是一款适用于 Paper (1.19.4+) 的插件,允许你在服务器上添加自定义表情符号。
[重要] 表情符号的最大分辨率为 256x256px!表情符号应存储为 .png 格式。
[重要] 图片名称应为小写,且不应包含任何特殊符号,例如:(、)、[、]、&、^ 等。
如果你遇到任何问题/错误,可以在 这里 提交。
? 截图
? 命令
/emojis list — 打开一本包含所有当前已添加表情符号的书。
/emojis update — 从服务器获取最新的表情符号资源包版本。旨在管理员更新表情符号并重新加载插件而你正在游戏时使用。(或者,你也可以直接重新加入服务器而无需使用此命令)。
/emojis reload — 重新加载插件。根据 ./plugins/ImageEmojis/emojis/ 目录生成资源包。
别名:/ie、/imageemojis。
? 权限
imageemojis.admin (默认赋予 管理员) — 允许使用 /emojis reload。
imageemojis.use (true 默认开启) — 允许使用表情符号以及 /emojis 命令。
imageemojis.update (true 默认开启) — 允许使用 /emojis update。
imageemojis.list (true 默认开启) — 允许使用 /emojis list。
? 主要功能
- 自动资源包生成 — 每次插件启动或重新加载时都会生成资源包。你唯一需要做的就是配置文件中提供你的服务器 IP,并在主机上开放 TCP 端口 (默认 5000)。
- 聊天建议 - 当玩家在聊天中输入消息时提供表情符号建议。你可以选择四种建议模式:
NONE - 禁用聊天建议。
TEMPLATES (默认设置) - 输入时建议表情符号模板(例如::clueless:)。
ACTUAL - 输入时建议实际的表情符号(其 UTF-8 字符)。(例如,
)。
BOTH - “TEMPLATES” 和 “ACTUAL” 模式的组合。
- 能够将表情符号与你的服务器资源包进行合并:你可以在
config.yml 中将 mergeWithServerResourcePack 字段设置为 true,并将你的资源包放入 ../ImageEmojis/ 目录中,文件名为 serverResourcePack.zip (文件名也可以自定义配置)。
- 告示牌替换 — 你可以启用/禁用告示牌上表情符号模板的替换。
- 铁砧替换 — 你可以启用/禁用在铁砧重命名物品时表情符号模板的替换。
- 命令替换 — 你可以启用/禁用发送命令时表情符号模板的替换。默认情况下,插件会自动预处理玩家发送的所有命令,并将表情符号模板更改为实际的表情符号。
- Discord 集成 - 如果你安装并设置了 DiscordSRV 插件,表情符号模板将被转换为相应的 UTF-8 表情符号,并且 UTF-8 符号会被预处理以在 Discord 中正确显示为表情符号。这将在游戏和 Discord 服务器中具有相同名称的表情符号上生效。
? 默认配置
[注意] 别忘了将你的公网 IP 填入 serverIp 字段。
此外,你应该在机器上开放 TCP 端口以使插件正常工作。端口默认为 5000。
否则,什么都不会起作用。
# Your server public IP goes here.
serverIp: "127.0.0.1"
# The port the resource pack will be hosted on. When the plugin launches, an HTTP server starts on that port.
# It should be opened on the machine so that players can download the resource pack.
webServerPort: 5000
# Resource pack enforcement policies:
# NONE - The resource pack won't be loaded on join. This option can fit servers where players prefer to download the resource pack manually.
# OPTIONAL - Players can decline the resource pack from loading on join.
# REQUIRED - Players are forced to play with the resource pack.
enforcementPolicy: "OPTIONAL"
# Replace emojis in anvils? (e.g., when renaming items)
replaceInAnvils: true
# Replace emojis on signs? (e.g., after editing them)
replaceOnSigns: true
# Replace emojis when sending a command? (e.g., in the "/msg" or "/say" commands)
replaceInCommands: true
# What will happen if a player doesn't have the "imageemojis.use" permission?:
# ERASE_EMOJIS - Erase all emojis from payload and proceed.
# CANCEL_EVENT - Cancel the event completely (e.g., prevent the message from being sent).
noPermAction:
inChat: "ERASE_EMOJIS"
inAnvils: "ERASE_EMOJIS"
onSigns: "ERASE_EMOJIS"
inCommands: "ERASE_EMOJIS"
# Whether a player will see the "Not enough permissions" message.
# Will be shown only for events with the "CANCEL_EVENT" action selected.
noPermMessage: false
当你在聊天中将光标悬停在表情符号上时,是否显示其名称。
如果你使用 Spigot 原生的聊天格式化程序(如 "VaultChatFormatter" 或 "LPC"),此功能可能无法正常工作,因为它们与 Paper Components 不兼容。
如果你正在寻找一个不会破坏消息的简单聊天格式化程序,你可以考虑使用我的:
emojiHoverEnabled: true
emojiHoverColor: "#AAAAAA"
聊天建议模式(在聊天中输入消息并按键盘上的 TAB 键时):
NONE - 无建议。
TEMPLATES - 建议模板(例如 ":sob:")。
ACTUAL - 建议实际的表情符号(例如 "?")。
BOTH - “TEMPLATES” 和 “ACTUAL” 模式的组合。
suggestionMode: "TEMPLATES"
表情符号模板格式(例如,你可以替换冒号或完全移除它们)。
templateFormat: ":<emoji>:"
插件是否应将 "emojis.zip" 资源包与服务器资源包合并?
如果为 "true",你需要将你的资源包放入 "/plugins/ImageEmojis/" 目录中。
输出结果将在 "emojis.zip" 存档内生成。
mergeWithServerResourcePack: false
要与 "emojis.zip" 合并的资源包名称。
mergeServerResourcePackName: "serverResourcePack.zip"
当你使用超过约 500 个表情符号时,可能会看到一些表情符号相互重叠(由于哈希函数限制在一定范围内)。
如果你计划在你的服务器上大量使用表情符号,可以将此值设置为 "true"。
重要提示:更改此项将重置所有现有的表情符号代码。这意味着:
- 之前写在告示牌和物品名称中的表情符号将显示为无效符号;
- 可用范围将从 2000 增加到 6400 个可用的表情符号 Unicode 字符。
extendedUnicodeRange: false
messages:
"resource-pack-description": "&nImage Emojis"
"only-players": "&c只有玩家可以使用此命令!"
"info-content": "&#F4CA16[ImageEmojis] &#B3BEC4当前共有 &#D8E5EC&n%s&r&#B3BEC4 个表情符号!
\n &#D8E5EC&n/emojis list&r&#B3BEC4 - 查看表情符号列表。
\n &#D8E5EC&n/emojis update&r&#B3BEC4 - 如果在本游戏会话期间更新了资源包,则获取最新版本。"
"resource-pack-up-to-date": "&#F4CA16[ImageEmojis] &#B3BEC4资源包现已是最新版本!"
"reloaded": "&#F4CA16[ImageEmojis] &#B3BEC4已重新加载!"
"not-enough-permissions": "&#F4CA16[ImageEmojis] &#B3BEC4权限不足。"
"command-not-found": "&#F4CA16[ImageEmojis] &c哎呀!该命令不存在,或者你没有足够的权限。"
"command-disabled": "&#F4CA16[ImageEmojis] &#B3BEC4该服务器已禁用此命令。"
"an-error-occurred": "&#F4CA16[ImageEmojis] &c重新加载时发生错误!请检查控制台日志以获取详细信息。"
### ? 安装指南
**[重要]** 开始之前,请确保插件版本与你的服务器版本**兼容**。
1. 从 <a href="https://github.com/MrQuackDuck/ImageEmojis/releases">Releases</a> 标签页下载最新版本的插件。
1. 将下载的 `.jar` 文件放入服务器的 `./plugins` 文件夹中。
1. 重启服务器或输入 `reload` 命令。
1. 进入 `./plugins/ImageEmojis` 目录并打开 `config.yml`。
1. 确保将服务器的公网 IP 填入 `serverIp` 字段。
1. 在服务器上开放一个 **TCP 端口**(默认为 **5000**),使其等于 `config.yml` 中的 `webServerPort` 字段值。
1. 运行 `/emojis reload` 命令。
**[注意]** 如果你之前启用了资源包,请在 `server.properties` 中将其禁用。
**恭喜!** 现在你已准备好使用该插件。将你的表情符号放入 `../ImageEmojis/emojis/` 目录中,重新加载插件,并在你的客户端输入 `/emojis update` 命令(或者直接重新加入服务器)!
<br/>
### ? 安装指南(视频格式)
该插件也在 YouTube 上有评测视频,你可以在其中跟随安装指南进行操作(时间戳:**1:04**):
ImageEmojis is a Paper (1.19.4+) plugin that allows you to add your custom emojis on your server.
[IMPORTANT] The max resolution of an emoji is 256x256px! Emojis should be stored in the '.png' format.
[IMPORTANT] Image names should be lowercase and shouldn't contain any special symbols like: (, ), [, ], &, ^, etc.
If you have any issues/bugs, you may leave them here.
? Screenshots
? Commands
/emojis list — opens a book with all currently added emojis.
/emojis update — fetches the latest version of the emojis resource pack from the server. Intended to be used in case when the admin updated emojis and reloaded the plugin while you were playing. (Alternatively, you can just rejoin and not use this command).
/emojis reload — reloads the plugin. Generates the resource pack based on the ./plugins/ImageEmojis/emojis/ directory.
Aliases: /ie, /imageemojis.
? Permissions
imageemojis.admin (for operators by default) — Allows to use /emojis reload.
imageemojis.use (true by default) — Allows to use emojis as well as the /emojis command.
imageemojis.update (true by default) — Allows to use /emojis update.
imageemojis.list (true by default) — Allows to use /emojis list.
? Key features
- Automated resource pack generation — the resource pack is generated every time the plugin starts or gets reloaded. The only thing you need to do is to provide your server IP in the configuration and open the TCP port on the host machine (5000 by default).
- Chat suggestions - emoji suggestions when a player types a message in chat. You can choose from four suggestion modes:
NONE - disable chat suggestions.
TEMPLATES (set by default) - suggest templates of emojis when typing (e.g., :clueless:).
ACTUAL - suggest actual emojis (their UTF-8 symbols) when typing. (e.g.,
).
BOTH - A combination of "TEMPLATES" and "ACTUAL" modes.
- Ability to merge emojis with your server resource pack: you can set the
mergeWithServerResourcePack field to true in the config.yml and put your resource pack into the ../ImageEmojis/ directory with the serverResourcePack.zip filename (the filename can be configured as well).
- Sign replacement — you can enable/disable replacement of emoji templates on signs.
- Anvil replacement — you can enable/disable replacement of emoji templates when renaming an item in the anvil.
- Command replacement — you can enable/disable replacement of emoji templates when sending commands. By default, the plugin automatically preprocesses all commands sent by players and changes emoji templates to actual emojis.
- Discord integration - if you have the DiscordSRV plugin installed and set up, emoji templates will be translated into appropriate UTF-8 emoji symbols, and UTF-8 symbols will be preprocessed to be displayed correctly in Discord as emojis. This will work with emojis that have the same name both in the game and on the Discord server.
? Default config
[CAUTION] Don't forget to put your public IP into the serverIp field.
Also, you should open the TCP port on your machine for the plugin to work. Port 5000 by default.
Otherwise, nothing will work.
# Your server public IP goes here.
serverIp: "127.0.0.1"
# The port the resource pack will be hosted on. When the plugin launches, an HTTP server starts on that port.
# It should be opened on the machine so that players can download the resource pack.
webServerPort: 5000
# Resource pack enforcement policies:
# NONE - The resource pack won't be loaded on join. This option can fit servers where players prefer to download the resource pack manually.
# OPTIONAL - Players can decline the resource pack from loading on join.
# REQUIRED - Players are forced to play with the resource pack.
enforcementPolicy: "OPTIONAL"
# Replace emojis in anvils? (e.g., when renaming items)
replaceInAnvils: true
# Replace emojis on signs? (e.g., after editing them)
replaceOnSigns: true
# Replace emojis when sending a command? (e.g., in the "/msg" or "/say" commands)
replaceInCommands: true
# What will happen if a player doesn't have the "imageemojis.use" permission?:
# ERASE_EMOJIS - Erase all emojis from payload and proceed.
# CANCEL_EVENT - Cancel the event completely (e.g., prevent the message from being sent).
noPermAction:
inChat: "ERASE_EMOJIS"
inAnvils: "ERASE_EMOJIS"
onSigns: "ERASE_EMOJIS"
inCommands: "ERASE_EMOJIS"
# Whether a player will see the "Not enough permissions" message.
# Will be shown only for events with the "CANCEL_EVENT" action selected.
noPermMessage: false
# Whether an emoji name should appear when you put your cursor over the emoji symbol in the chat.
# This feature MAY NOT WORK if you use Spigot-native chat formatters such as "VaultChatFormatter" or "LPC" due to their incompatibility with Paper Components.
# If you are looking for a simple chat formatter that doesn't break messages, you may consider using mine: https://github.com/MrQuackDuck/PlainChatFormatter
emojiHoverEnabled: true
emojiHoverColor: "#AAAAAA"
# Chat suggestions modes (when typing a message in the chat and hitting TAB on the keyboard):
# NONE - No suggestions.
# TEMPLATES - Suggest templates (e.g., ":sob:").
# ACTUAL - Suggest actual emoji (e.g., "?").
# BOTH - A combination of "TEMPLATES" and "ACTUAL" modes.
suggestionMode: "TEMPLATES"
# Emoji template format (e.g., you may replace colons or remove them completely).
templateFormat: ":<emoji>:"
# Should the plugin merge the "emojis.zip" resource pack with the server resource pack?
# If "true", you should put your resource pack in the "/plugins/ImageEmojis/" directory.
# The output will be generated within the "emojis.zip" archive.
mergeWithServerResourcePack: false
# Name of the resource pack to merge "emojis.zip" with.
mergeServerResourcePackName: "serverResourcePack.zip"
# When you use over ~500 emojis, you may see some emojis overlap each other (due to the hashing function being limited to a certain range).
# If you plan to use many emojis on your server, you may set this value to "true".
# IMPORTANT: Changing this will reset all existing emoji codes. This means:
# - Previously written emojis on signs and item names will appear as invalid symbols;
# - Range will be increased from 2000 to 6400 available emoji unicode symbols.
extendedUnicodeRange: false
messages:
"resource-pack-description": "&nImage Emojis"
"only-players": "&cOnly players can use this command!"
"info-content": "&#F4CA16[ImageEmojis] &#B3BEC4There are currently &#D8E5EC&n%s&r&#B3BEC4 emojis!
\n &#D8E5EC&n/emojis list&r&#B3BEC4 - see the emojis list.
\n &#D8E5EC&n/emojis update&r&#B3BEC4 - fetch the latest version of the resource pack if it was updated during the current game session."
"resource-pack-up-to-date": "&#F4CA16[ImageEmojis] &#B3BEC4The resource pack is now up to date!"
"reloaded": "&#F4CA16[ImageEmojis] &#B3BEC4Reloaded!"
"not-enough-permissions": "&#F4CA16[ImageEmojis] &#B3BEC4Not enough permissions."
"command-not-found": "&#F4CA16[ImageEmojis] &cOops! That command doesn't exist, or you don't have enough permissions."
"command-disabled": "&#F4CA16[ImageEmojis] &#B3BEC4This command is disabled on that server."
"an-error-occurred": "&#F4CA16[ImageEmojis] &cAn error occurred during reload! Check the console logs for details."
? Installation guide
[IMPORTANT] Before getting started, make sure the plugin's version is compatible with your server version.
- Download the latest version of the plugin from the Releases tab.
- Put the downloaded
.jar into the ./plugins folder of your server.
- Restart your server or enter the
reload command.
- Go to the
./plugins/ImageEmojis directory and open config.yml.
- Make sure to put your server's public IP into the
serverIp field.
- Open a TCP port (5000 by default) on your server equal to the
webServerPort field from the config.yml.
- Run the
/emojis reload command.
[NOTE] You should disable your resource pack in server.properties if you enabled it earlier.
Congrats! Now you're ready to use the plugin. Put your emojis into the ../ImageEmojis/emojis/ directory, reload the plugin, and enter the /emojis update command on your client (or just rejoin)!
? Installation guide (in a video format)
The plugin is also reviewed on YouTube, where you can follow the installation guide (Timecode: 1:04):
评论 0
登录后参与评分
还没有评论,来抢沙发吧