diff --git a/README.md b/README.md index 11e896c..35c91eb 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,68 @@ # Extra Loader -Load extra resource packs and data packs for you. +Minecraft Forge 加载额外的资源包和数据包 +## 设计理念 + +Extra Loader 的目标是让 Mod 平台玩家更简单地管理游戏资源。通过将资源包集中存放在 `~/.extraloader//` 目录,玩家可以为不同版本的游戏维护独立的资源配置。我们提供三种加载模式(required/optional/default),让你对资源包的启用与禁用拥有灵活的控制权,既能确保关键资源必加载,也能避免不必要的包干扰游戏体验。 + +### 存储目录 + +将资源包或数据包放入对应目录: + +``` +~/.extraloader// +├── required/ # 必须加载 +├── optional/ # 默认禁用 +└── default/ # 默认启用 +``` + +### 示例 + +**资源包**: + +- `~/.extraloader/1.20.1/required/my-pack.zip` +- `~/.extraloader/1.20.1/optional/bonus-textures/` + +**数据包**: + +- `~/.extraloader/1.20.1/default/nice-fonts.jar` + +## 加载模式 + +| 模式 | 行为 | 玩家可禁用 | +| ---------- | -------------------- | ---------- | +| `required` | 强制加载,缺失时跳过 | ❌ 否 | +| `optional` | 默认禁用,需手动启用 | ✅ 是 | +| `default` | 默认启用,可手动禁用 | ✅ 是 | + +## 包识别规则 + +- 包含 `assets/` → 资源包 +- 包含 `data/` → 数据包 +- 两者都有 → 同时加载 + +支持 `.zip`、`.jar` 文件或直接目录。 + +## FAQ + +**Q: 包没生效?** + +- 检查是否包含 `assets/` 或 `data/` 目录 +- 确认有 `pack.mcmeta` 文件 +- 路径是否正确(`~/.extraloader//`) + +**Q: 如何禁用包?** + +- `default`:游戏内手动禁用 +- `optional`:默认禁用,需手动启用 +- `required`:无法禁用,删除或移出该目录 + +**Q: 服务端要装吗?** + +- 资源包仅客户端生效 +- 数据包需要服务端安装 + +## 许可证 + +[MIT License](LICENSE) diff --git a/WEB_INTRO.txt b/WEB_INTRO.txt new file mode 100644 index 0000000..36d6794 --- /dev/null +++ b/WEB_INTRO.txt @@ -0,0 +1,32 @@ +[h1=核心功能] + +Extra Loader 是一个 Minecraft Forge 模组,用于集中管理资源包和数据包。无需手动复制到游戏目录,支持直接使用目录或 `.zip/.jar` 文件。 + +[h2=全局路径] + +instance 全局:`<游戏目录>/extraloader/` +system 全局:`C:\Users\[用户名]\.extraloader\[游戏版本]\` + +[h3=按功能分为:] + +`required` - 强制加载,始终生效,无法禁用(红色) +`optional` - 可选加载,默认禁用,玩家可手动启用(青色) +`default` - 默认加载,玩家可手动禁用(绿色) + +[h3=自动识别规则] + +包含 `assets/` → 资源包 +包含 `data/` → 数据包 +两者都有 → 同时加载 + +[h2=快捷命令] + +`/extraloader open instance` 与 `/extraloader open system` + +[h1=设计理念] + +免复制:无需手动将资源包复制到游戏目录 +跨整合包复用:同一版本的不同整合包可共享同一份资源包 +约定优于配置、开箱即用:按目录结构自动加载,无需额外配置 + +[ban:title_menu]