Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/ryanhcode/sable/llms.txt

Use this file to discover all available pages before exploring further.

Sable is a library mod for Minecraft that gives mod developers a foundation for building interactive, physics-driven moving block structures. It targets mod developers on both Fabric and NeoForge, supported through a shared Architectury common module. If your mod needs ships, vehicles, moving platforms, rotating machinery, or any other structure that moves through the world, Sable handles the underlying physics simulation, collision detection, entity tracking, and chunk management for you.

What is a sub-level?

A sub-level is a self-contained Minecraft region — complete with chunks, block entities, and entities — that exists at a dynamic position and orientation within a Minecraft level. Unlike static in-world structures, a sub-level has a pose: a position and rotation that can change every physics tick, driven by a full rigid-body simulation. Players and entities standing on a sub-level ride with it automatically, block entities receive per-tick callbacks, and the entire region can be assembled from or disassembled back into the world at runtime. Sub-levels are the core primitive in Sable. Everything else — physics pipelines, constraint joints, block physics properties, entity actors — is built around the concept of a region that moves.

Compatibility

Sable is an incredibly intrusive mod. It makes extensive use of mixins, and is prone to extensive compatibility issues with other mods.
Because Sable patches deeply into Minecraft’s level, chunk, and entity systems via Mixins, it can conflict with other mods that touch the same systems. You should treat Sable as a hard dependency carefully and test thoroughly against any other mods in your pack or project. For adding optional, simple compatibility so that a mod functions correctly alongside Sable without depending on it directly, see Sable Companion. Sable Companion provides a lightweight surface for mods that only need to behave well in the presence of sub-levels.

Licensing

Unless otherwise stated, all content in the Sable repository is licensed under the PolyForm Shield License 1.0.0 by RyanHCode. PolyForm Shield permits use of Sable as a dependency in your own mods, but restricts competing uses. When submitting a pull request to Sable, you give RyanHCode the right to license your contributions under the PolyForm Shield License (Version 1.0.0), and you irrevocably permit a potential future re-licensing of Sable — containing your contributions — under the MIT license. All submitted code must be your own original work that you have the right to contribute.

Community

Development discussion for Sable takes place on Discord. You are welcome to join either of the following servers:

Sable Zone

The dedicated Sable development server for API questions, mod compatibility, and contributor discussion.

Create Aeronautics

The broader Create Aeronautics community, where Sable originated and where many Sable-based projects are discussed.

Build docs developers (and LLMs) love