🚀 快速开始#

This page shows how to start using Bookshelf. Like it? Star on GitHub or follow on Modrinth.

📥 安装#

Use the manager to make a custom bundle.

  1. Go to mcbookshelf.dev

  2. Pick your modules

  3. Review dependencies

  4. Download the bundle

After downloading, move the ZIP file to your world’s datapacks folder.

Get releases from GitHub or Modrinth. You can download either:

  • 📚 Bundles: groups of related modules with their dependencies

  • 🧩 Modules: a single module with its dependencies

After downloading, move the ZIP file to your world’s datapacks folder.

If you use the beet pipeline, install mcbookshelf from PyPI:

pip install mcbookshelf

Then, reference Bookshelf bundles or modules in your beet config:

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

To work with the source code, you must first build Bookshelf.

🛠️ Requirements

  • Datapack basics

  • Git installed

  • uv installed

📥 Installation steps

  1. 克隆仓库：

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

  2. Build the modules:

    uv run modules build

Built modules appear in the build folder.

小技巧

Release datapacks are stable but may not be the newest. For the latest features or fixes, build from source or use a pre-release.

👶 First steps#

Run this command to check the installation:

function #bs.load:status

This lists loaded modules and checks for compatibility issues. If you need help installing a datapack, see this guide.

From there, you can explore the documentation for individual modules, try out examples, and start integrating their functionality into your own projects!

重要

  • Bookshelf uses persistent entities. Avoid kill @e, use kill @e[tag=!bs.persistent] instead. Learn more

  • Side effects are rare, but conflicts can occur if multiple datapacks use the same functions. Always set inputs before running a function.

Next, check out the modules documentation to see each module in detail and learn how to use them.

备注

This section is in progress. If you have ideas to improve it, share them on the Discord server.

💬 这对您有帮助吗？

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