Skip to content

Commit

Permalink
chore: Update the README
Browse files Browse the repository at this point in the history
  • Loading branch information
CerealAxis committed Feb 22, 2024
1 parent 4b0669b commit 634216e
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 10 deletions.
6 changes: 1 addition & 5 deletions README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -50,24 +50,20 @@ pauseInsteadOfStopRecordingOnPlayerQuit = false
# Recording storage path template, supports ${name} and ${uuid} variables.
recordPath = "replay/player/${name}@${uuid}"

# Pause recording on high speed.
[pauseRecordingOnHighSpeed]
enabled = false # Whether to enable pausing recording on high speed, which pauses recording when the player moves at high speeds.
threshold = 20.0 # Speed threshold to trigger pausing recording on high speed.

# Filter settings.
[filter]
checkBy = "name" # Basis for blacklist/whitelist check, can be "name" or "uuid", default is "name", indicating player name.
recordMode = "blacklist" # Recording mode, either blacklist or whitelist.
blacklist = [] # Blacklist, empty means no players are blocked.
whitelist = [] # Whitelist, empty means no players are recorded.

# Clear outdated recording file settings.
[clearOutdatedRecordFile]
enabled = false # Whether to enable cleaning function.
days = 7 # Number of days to retain outdated recording files.

# Record suspicious player behavior settings.
[recordSuspiciousPlayer]
enableThemisIntegration = false # Whether to enable recording of suspicious players monitored by Themis reports.
enableMatrixIntegration = false # Whether to enable recording of suspicious players monitored by Matrix reports.
Expand All @@ -79,7 +75,7 @@ recordPath = "replay/suspicious/${name}@${uuid}" # Suspicious player recording
## Author Information

- Core Dev: [MC-XiaoHei](https://github.com/MC-XiaoHei), wrote most of the code
- Contributor: [CerealAxis](https://github.com/CerealAxis), helped me implement automatic cleaning of expired recordings, Matrix adaptation functionality, and wrote the README
- Core Dev: [CerealAxis](https://github.com/CerealAxis), helped me implement automatic cleaning of expired recordings, Matrix adaptation functionality, and wrote the README
- Contributor: [Cranyozen](https://github.com/Cranyozen), helped me complete the automatic build CI

## Precautions
Expand Down
6 changes: 1 addition & 5 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,24 +50,20 @@ pauseInsteadOfStopRecordingOnPlayerQuit = false
# 录像存储路径模板,支持 ${name} 和 ${uuid} 变量。
recordPath = "replay/player/${name}@${uuid}"

# 在高速运动时暂停录制
[pauseRecordingOnHighSpeed]
enabled = false # 是否启用高速录制暂停功能,此功能在玩家高速运动时暂停录制。
threshold = 20.0 # 触发高速录制暂停的速度阈值

# 筛选器设置
[filter]
checkBy = "name" # 黑白名单检查依据,可选值为 "name" 或 "uuid",默认为 "name",即下方的黑白名单中填写的是玩家名。
recordMode = "blacklist" # 录制模式为黑名单或白名单(whitelist)
blacklist = [] # 黑名单列表,为空表示不屏蔽任何玩家
whitelist = [] # 白名单列表,为空表示不录制任何玩家

# 清理过时录制文件设置
[clearOutdatedRecordFile]
enabled = false # 是否启用清理功能
days = 7 # 过时录制文件的保留天数

# 记录可疑玩家行为设置
[recordSuspiciousPlayer]
enableThemisIntegration = false # 是否启用监视Themis报告的可疑玩家录制功能
enableMatrixIntegration = false # 是否启用监视Matrix报告的可疑玩家录制功能
Expand All @@ -79,7 +75,7 @@ recordPath = "replay/suspicious/${name}@${uuid}" # 可疑玩家录制文件路
## 作者信息

- 主要开发者:[MC-XiaoHei](https://github.com/MC-XiaoHei),编写了大部分的的代码
- 贡献者[CerealAxis](https://github.com/CerealAxis),帮助我制作了自动清理过期录像功能、Matrix适配功能,并且编写了 README
- 主要开发者[CerealAxis](https://github.com/CerealAxis),帮助我制作了自动清理过期录像功能、Matrix适配功能,并且编写了 README
- 贡献者:[Cranyozen](https://github.com/Cranyozen),帮助我完成了自动构建 CI

## 注意事项
Expand Down

0 comments on commit 634216e

Please sign in to comment.