-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
7cf14cd
commit 4333693
Showing
2 changed files
with
89 additions
and
75 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,75 +1,82 @@ | ||
[>>English<<](README_en.md) | ||
|
||
# Chat Tools | ||
Chat Tools 是一个 Minecraft Fabric 模组,为玩家提供众多的实用聊天功能。\ | ||
Chat Tools 是一个 Minecraft Fabric 模组,为玩家提供众多的实用聊天功能。 | ||
请安装前置模组 [Cloth Config](https://modrinth.com/mod/cloth-config)。 | ||
|
||
Chat Tools的大部分功能支持高度个性化,请在配置页面进行配置。\ | ||
Chat Tools的大部分功能支持高度个性化,请在配置页面进行配置。 | ||
配置页面启动方式(请确保安装好 [Cloth Config](https://modrinth.com/mod/cloth-config) ): | ||
- 输入指令 `/chattools opengui` | ||
- Chat Tools 与 [Mod Menu](https://modrinth.com/mod/modmenu) 联动,在 Mod Menu 中打开Chat Tools 配置界面 | ||
|
||
# 功能介绍 | ||
## 基本(General Section) | ||
包含模组基本设定 | ||
- 显示聊天时间(Show Timestamp)\ | ||
在信息前面插入一个时间戳\ | ||
- 显示聊天时间(Show Timestamp) | ||
在信息前面插入一个时间戳 | ||
![Timestamp](<images/Timestamp.png>) | ||
- 储存聊天记录(Restore Messages)\ | ||
- 储存聊天记录(Restore Messages) | ||
在切换会话之后从上一个会话储存聊天记录 | ||
- 隐藏自己昵称(Nickname Hider)\ | ||
在自己视角里隐藏自己真实昵称\ | ||
- 隐藏自己昵称(Nickname Hider) | ||
在自己视角里隐藏自己真实昵称 | ||
![Nickname Hider](<images/Nickname Hider.png>) | ||
- 最大聊天记录数量(Max History Length)\ | ||
调整游戏保留聊天记录上限\ | ||
- 最大聊天记录数量(Max History Length) | ||
调整游戏保留聊天记录上限 | ||
![Max History Length](<images/Max History Length.png>) | ||
|
||
## 聊天提醒(Notifier Section) | ||
各种聊天提醒功能 | ||
- 后台弹窗提醒(Toast)\ | ||
- 后台弹窗提醒(Toast) | ||
![Toast](<images/Toast.gif>) | ||
- 声音选项(Sound)\ | ||
- 声音选项(Sound) | ||
支持自定义音效 | ||
- 动作栏选项(Actionbar)\ | ||
- 动作栏选项(Actionbar) | ||
在动作栏提醒关注的消息 | ||
- 高亮选项(Highlight)\ | ||
支持自定义高亮前缀(匹配到的消息前面加前缀)\ | ||
- 高亮选项(Highlight) | ||
支持自定义高亮前缀(匹配到的消息前面加前缀) | ||
![Highlight Function](<images/Highlight Function.png>) | ||
- 匹配白名单(Allow List)\ | ||
- 匹配白名单(Allow List) | ||
列表中的内容将会被匹配 | ||
- 匹配黑名单(Ban List)\ | ||
- 匹配黑名单(Ban List) | ||
列表中的内容将不会被匹配(优先级大于白名单列表) | ||
|
||
## 注入聊天(Formatter Section) | ||
使用指定样式格式化自己的消息,可以根据不同服务器应用不同的规则(请参考[聊天气泡](#聊天气泡bubble-section)规则) | ||
- 注入文本(Pattern)\ | ||
即自动格式化替换的样式\ | ||
例如:\ | ||
`&e{text}` 在支持以 & 作为自定义颜色前缀的服务器中将会让您的消息变成金色\ | ||
`&e{text} ~(ovo)~` 将额外为您加上个性化后缀(小尾巴)\ | ||
- 注入文本(Pattern) | ||
即自动格式化替换的样式 | ||
例如: | ||
`&e{text}` 在支持以 & 作为自定义颜色前缀的服务器中将会让您的消息变成金色 | ||
`&e{text} ~(ovo)~` 将额外为您加上个性化后缀(小尾巴) | ||
`我的坐标是:{pos}` 将为您自动替换 `{pos}` 为当前坐标 | ||
- 匹配黑名单(Auto-Disable when matches...)\ | ||
在有些情况下,我们**不希望**自己的文本被格式化。\ | ||
这些情况包括(但不限于):\ | ||
向箱子商店插件售卖物品时在聊天栏输入的物品数量(或all);\ | ||
以各种特殊字符开头的指令。\ | ||
Chat Tools的默认正则表达式字串 `^\d+$|^[.#%$/].*|\ball\b` 即可满足需求,\ | ||
- 匹配黑名单(Auto-Disable when matches...) | ||
在有些情况下,我们**不希望**自己的文本被格式化。 | ||
这些情况包括(但不限于): | ||
向箱子商店插件售卖物品时在聊天栏输入的物品数量(或all); | ||
以各种特殊字符开头的指令。 | ||
Chat Tools的默认正则表达式字串 `^ d+$|^[.#%$/].*| ball b` 即可满足需求, | ||
当然,您也可以更改或自行添加更多。 | ||
|
||
## 快捷发言(Chat Keybindings Section) | ||
用快捷键来代替常用的指令 | ||
- 一键复读(Trigger Last Command Hotkey)\ | ||
按下设置的热键即可将您上一条指令重复一遍\ | ||
例如:\ | ||
- 一键复读(Trigger Last Command Hotkey) | ||
按下设置的热键即可将您上一条指令重复一遍 | ||
例如: | ||
在跑酷地图中 F3+C 记录坐标并发送一次后,此后每按下一次快捷键即可快速回溯到记录点位置。 | ||
- 指令宏(Command Keybindings)\ | ||
为常用指令设置热键\ | ||
- 指令宏(Command Keybindings) | ||
为常用指令设置热键 | ||
![Command Keybindings](<images/Command Keybindings.png>) | ||
|
||
## 聊天气泡(Bubble Section) | ||
- 启用聊天气泡(Enable Chat Bubbles)\ | ||
在玩家头上渲染聊天气泡\ | ||
- 启用聊天气泡(Enable Chat Bubbles) | ||
在玩家头上渲染聊天气泡 | ||
![Chat Bubbles](<images/Chat Bubbles.png>) | ||
- 聊天气泡规则(Bubble Rules)\ | ||
为不同的服务器应用不同的聊天气泡规则\ | ||
![Bubble Rules](<images/Bubble Rules.png>) | ||
- 聊天气泡规则(Bubble Rules) | ||
为不同的服务器应用不同的聊天气泡规则 | ||
![Bubble Rules](<images/Bubble Rules.png>) | ||
|
||
## 聊天回应(Responser Section) | ||
> **注意:在服务器中使用此功能前,请先咨询他人及管理员的意见!** | ||
- 启用聊天回应(Enable Responser) | ||
聊天回应功能允许对于特定的聊天内容自动回复特定的信息 | ||
- 聊天回应规则列表(Responser Rules) | ||
在不同的服务器应用不同的聊天回应规则 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,75 +1,82 @@ | ||
[>>Simplified Chinese<<](README.md) | ||
|
||
# Chat Tools | ||
Chat Tools is a Minecraft Fabric Mod that provides players with numerous useful chat features. \ | ||
Chat Tools is a Minecraft Fabric Mod that provides players with numerous useful chat features. | ||
Please install [Cloth Config](https://modrinth.com/mod/cloth-config) first. | ||
|
||
Most of the features of Chat Tools support a high degree of personalization, please configure them in the configuration page. \ | ||
Most of the features of Chat Tools support a high degree of personalization, please configure them in the configuration page. | ||
Configuration page startup method (please make sure [Cloth Config](https://modrinth.com/mod/cloth-config) is installed): | ||
- Activate the command `/chattools opengui` | ||
- Chat Tools is linked to [Mod Menu](https://modrinth.com/mod/modmenu), and the Chat Tools configuration screen can be shown in Mod Menu. | ||
|
||
# Function introduction | ||
## General Section | ||
Contains the basic settings of Chat Tools | ||
- Show Timestamp \ | ||
Inserts a timestamp in front of the message.\ | ||
- Show Timestamp | ||
Inserts a timestamp in front of the message. | ||
![Timestamp](<images/Timestamp.png>) | ||
- Restore Messages\ | ||
- Restore Messages | ||
Restore messages from previous sessions. | ||
- Nickname Hider \ | ||
Hides your real nickname in your own view.\ | ||
- Nickname Hider | ||
Hides your real nickname in your own view. | ||
![Nickname Hider](<images/Nickname Hider.png>) | ||
- Max History Length\ | ||
Adjusts the maximum number of chat history kept in the game.\ | ||
- Max History Length | ||
Adjusts the maximum number of chat history kept in the game. | ||
![Max History Length](<images/Max History Length.png>) | ||
|
||
## Notifier Section | ||
Various chat alert functions | ||
- Toast Notification\ | ||
Various chat notifier functions | ||
- Toast Notification | ||
![Toast](<images/Toast.gif>) | ||
- Sound\ | ||
- Sound | ||
Support custom sound effects. | ||
- Actionbar\ | ||
- Actionbar | ||
Remind attention to messages in the action bar. | ||
- Highlight\ | ||
Support custom highlighting prefix.\ | ||
- Highlight | ||
Support custom highlighting prefix. | ||
![Highlight Function](<images/Highlight Function.png>) | ||
- Allow List\ | ||
- Allow List | ||
The contents of the list will be matched. | ||
- Ban List\ | ||
- Ban List | ||
The contents of the list will not be matched. (Its priority is greater than Allow List) | ||
|
||
## Formatter Section | ||
Format your own messages using the specified pattern. You can apply different rules to different servers. [See Bubble Rules](#bubble-section). | ||
- Pattern\ | ||
Automatically format the replacement style.\ | ||
For example: \ | ||
`&e{text}` will make your message gold on servers that support a custom color prefix of &.\ | ||
`&e{text} ~(ovo)~` will additionally personalize your message with a suffix.\ | ||
- Pattern | ||
Automatically format the replacement style. | ||
For example: | ||
`&e{text}` will make your message gold on servers that support a custom color prefix of &. | ||
`&e{text} ~(ovo)~` will additionally personalize your message with a suffix. | ||
`My coordinates are: {pos}` will automatically replace `{pos}` with the current coordinates for you. | ||
- Auto-Disable when matches...\ | ||
In some cases, we **do not want** our text to be formatted. \ | ||
These situations include (but are not limited to):\ | ||
The number of items (or `all`) sent in chat when selling items to the Chest Shop; \ | ||
Commands that begin with various special characters. \ | ||
Chat Tools' default RegEx string `^\d+$|^[. #%$/]. *|\ball\b` is all that is needed.\ | ||
- Auto-Disable when matches... | ||
In some cases, we **do not want** our text to be formatted. | ||
These situations include (but are not limited to): | ||
The number of items (or `all`) sent in chat when selling items to the Chest Shop; | ||
Commands that begin with various special characters. | ||
Chat Tools' default RegEx string `^ d+$|^[. #%$/]. *| ball b` is all that is needed. | ||
Of course, you can change it or add more yourself. | ||
|
||
## Chat Keybindings Section | ||
Use hotkeys to replace frequently used commands | ||
- Trigger Last Command Hotkey\ | ||
Press the set hotkey to repeat your previous command.\ | ||
For example: \ | ||
- Trigger Last Command Hotkey | ||
Press the set hotkey to repeat your previous command. | ||
For example: | ||
While playing a Parkour map, do F3+C and activate it once. Then you can quickly go back to the recorded point location every time you press the hotkey. | ||
- Command Keybindings\ | ||
Set hotkeys for frequently used commands.\ | ||
- Command Keybindings | ||
Set hotkeys for frequently used commands. | ||
![Command Keybindings](<images/Command Keybindings.png>) | ||
|
||
## Bubble Section | ||
- Enable Chat Bubbles\ | ||
Renders a chat bubble over one's head.\ | ||
- Enable Chat Bubbles | ||
Renders a chat bubble over one's head. | ||
![Chat Bubbles](<images/Chat Bubbles.png>) | ||
- Bubble Rules\ | ||
Apply different bubble rules on different servers.\ | ||
![Bubble Rules](<images/Bubble Rules.png>) | ||
- Bubble Rules | ||
Apply different bubble rules on different servers. | ||
![Bubble Rules](<images/Bubble Rules.png>) | ||
|
||
## Responser Section | ||
> **Warning: If you are going to use this feature in a server, please inquire with other players and admins first!** | ||
- Enable Responser | ||
Response to other's messages automatically. | ||
- Responser Rules | ||
Apply different responser rules on different servers. |