🚀 快速开始#

本页介绍如何开始使用 Bookshelf。喜欢这个项目？欢迎在 GitHub 上点亮 Star，或在 Modrinth 上关注我们。

📥 安装#

使用管理器制作自定义捆绑包。

  1. 前往 mcbookshelf.dev

  2. 选择你的模块

  3. 检查依赖关系

  4. 下载捆绑包

下载后，将 ZIP 文件移至 Minecraft 世界的 datapacks 文件夹。

可从 GitHub 或 Modrinth 获取发布版本，并选择下载：

  • 📚 捆绑包： 相关模块及其依赖项的组

  • 🧩 模块： 单个模块及其依赖项

下载后，将 ZIP 文件移至 Minecraft 世界的 datapacks 文件夹。

如果你使用 beet 构建流程，请从 PyPI 安装 mcbookshelf：

pip install mcbookshelf

然后，在 beet 配置中引用 Bookshelf 捆绑包或模块：

beet.yml#
require:
  - bookshelf.bundle.<name_of_bundle>
  - bookshelf.bundle.dev
  - bookshelf.module.<name_of_module>
  - bookshelf.module.raycast

要处理源代码，你必须先构建 Bookshelf。

🛠️ 准备工作

  • 数据包基础

  • 已安装 Git

  • 已安装 UV

📥 安装步骤

  1. 克隆仓库：

    git clone https://github.com/mcbookshelf/bookshelf.git
cd bookshelf

  2. 构建模块：

    uv run modules build

构建的模块出现在 build 文件夹中。

小技巧

发布的数据包稳定但可能不是最新的。要获取最新功能或修复，请从源代码构建或使用预发布版本。

👶 开始使用#

运行此命令以检查安装：

function #bs.load:status

该命令会列出已加载的模块并检查兼容性问题。如果你还不熟悉数据包安装，可以参考这篇指南。

确认安装正常后，你可以浏览各个模块的文档、尝试示例，并将所需功能逐步接入自己的项目。

重要

  • Bookshelf 使用持久化实体。请勿执行 kill @e，应改用 kill @e[tag=!bs.persistent]。了解更多

  • Bookshelf 通常不会影响其他数据包，但多个数据包调用同一函数时仍可能发生冲突。请务必先设置输入，再运行函数。

接下来，可以查看模块文档，了解各个模块的用途和使用方法。

备注

本节仍在完善中。如果你有改进建议，欢迎在 Discord 服务器中提出。

💬 这对你有帮助吗？

欢迎在下方留下你的问题和反馈！