Skip to content

OrangeMiracle/CleanMaid

Repository files navigation

CleanMaid

CleanMaid 是一个轻量的 Minecraft 服务端清理 Mod。她会像认真值班的女仆一样,按配置清扫掉落物和实体,减少堆积带来的服务器压力。

支持版本

  • Minecraft 1.21.1
  • NeoForge 21.1.222
  • Java 21

主要功能

  • 自动定时清理掉落物和经验球
  • 清理前 warning 与倒计时提示
  • 两层分批清理:维度级分批 + 单维度内实体类型分批
  • 物品黑白名单与维度黑白名单
  • 刚掉落保护、命名物品保护、玩家死亡掉落保护
  • /cleanmaid 管理命令与快捷 /ccb
  • actionbar / chat 可配置播报
  • 隐藏彩蛋与隐藏进度

安装

  1. 安装 Minecraft 1.21.1 服务端。
  2. 安装 NeoForge 21.1.222
  3. 将发布页中的主 Mod jar 放入服务端 mods/ 目录。
  4. 启动服务端,配置会生成到 config/cleanmaid/

常用命令

所有命令默认需要权限等级 3

/cleanmaid help
/cleanmaid clean
/ccb
/cleanmaid status
/cleanmaid reload
/cleanmaid set interval 60
/cleanmaid set enabled true
/cleanmaid set easter_egg false

黑白名单:

/cleanmaid item blacklist add minecraft:dirt
/cleanmaid item blacklist remove minecraft:dirt
/cleanmaid item whitelist list
/cleanmaid dimension blacklist add minecraft:the_nether
/cleanmaid dimension whitelist add minecraft:overworld
/cleanmaid dimension whitelist list

定向清理:

/cleanmaid clean dimension minecraft:the_nether
/cleanmaid clean item minecraft:cobblestone
/cleanmaid clean entity minecraft:experience_orb
/cleanmaid clean force

配置文件

配置目录:

config/cleanmaid/

主要文件:

cleanmaid-server.toml
blacklist.toml
whitelist.toml

cleanmaid-server.toml 控制定时、目标实体、保护规则、显示位置、声音、权限和彩蛋开关。

blacklist.tomlwhitelist.toml 同时保存物品和维度:

{
  "items": [],
  "dimensions": []
}

黑白名单规则

  • blacklist = 必须清理
  • whitelist = 保护,不清理
  • blacklist 优先级高于 whitelist

默认物品:

  • blacklist:minecraft:cobblestoneminecraft:dirt
  • whitelist:minecraft:diamondminecraft:netherite_ingot

构建

.\gradlew.bat build

构建产物位于:

build/libs/

Release 下载

正式版本请从 GitHub Releases 下载。

About

A configurable Minecraft server-side cleanup mod for dropped items and entities.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages