# mc-SaveRestorer

**Repository Path**: li27744/mc-save-restorer

## Basic Information

- **Project Name**: mc-SaveRestorer
- **Description**: 提供完全手动触发的存档清理工具，玩家可在主菜单 → 选项界面打开本模组的设置屏幕，选择存档后一键执行深度清理，移除因移除模组而残留的无效方块、实体、物品、进度、维度引用等，使存档恢复干净。
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-05-10
- **Last Updated**: 2026-05-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# SaveRestorer

[![License](https://img.shields.io/badge/License-MIT-green)](LICENSE)
![Minecraft](https://img.shields.io/badge/Minecraft-1.21.1-blue)
![NeoForge](https://img.shields.io/badge/NeoForge-21.1.0%2B-orange)
一个 Minecraft NeoForge 模组，用于修复因移除模组而导致残留无效数据的世界存档。

## 功能特性

- **深度清理** – 扫描并移除无效方块、实体、物品、进度、维度引用、强制加载区块等。
- **安全可控** – 仅操作主菜单下的世界原始文件，不启动世界或服务器。
- **无干扰 UI** – 单个设置界面内嵌实时进度反馈（不弹窗、不切换界面）。
- **可选备份** – 清理前自动压缩整个世界文件夹为 ZIP（可配置开关）。
- **替换无效方块** – 可选择用 `minecraft:stone` 或 `minecraft:air` 填充被移除的方块。
- **过滤名单** – 通过配置文件支持白名单/黑名单，可指定 ModID 或完整命名空间。
- **完全手动** – 修复操作完全由玩家主动触发，无自动扫描或后台任务。
  
  ## 使用流程
1. 进入主菜单 → **选项** → 点击右侧 **“存档修复…”** 按钮。
2. 从下拉列表中选择要修复的存档（自动列出 `saves` 目录下所有有效世界）。
3. 设置是否 **启用备份**（强烈推荐）以及 **替换方块** 类型。
4. 点击 **“开始修复”** – 界面底部两行状态实时反馈：
   - 第一行：当前阶段（如“正在备份…”、“处理区域文件: r.0.0.mca”）
   - 第二行：详细信息（如当前处理的文件名）
5. 完成后，第一行显示 **“修复完成”** 或 **“修复失败”**。
   
   > **重要提示** – 使用任何修复工具之前，请务必手动备份你的世界。此模组按“原样”提供，不提供任何担保。
   
   ## 配置文件
   
   配置文件位于 `config/saverestorer/config.toml`：
   
   | 配置项                 | 类型        | 默认值                 | 说明                                                           |
   | ------------------- | --------- | ------------------- | ------------------------------------------------------------ |
   | `enable_backup`     | `boolean` | `true`              | 清理前是否创建世界 ZIP 备份。                                            |
   | `replacement_block` | `string`  | `"minecraft:stone"` | 用于替换无效方块的方块 ID。                                              |
   | `filter_mode`       | `string`  | `"none"`            | 过滤模式：`"none"`（不过滤）、`"whitelist"`（白名单）、`"blacklist"`（黑名单）。    |
   | `filter_list`       | `list`    | `[]`                | 过滤名单，支持 ModID 或完整命名空间（如 `"oldmod"` 或 `"oldmod:some_block"`）。 |
   
   ### 过滤示例
   
   **白名单** – 只处理来自指定模组的数据：
   ```toml
   filter_mode = "whitelist"
   filter_list = ["removedmod"]