Skip to content

Repository files navigation

MaxFastBuild

MaxFastBuild

Server-authoritative mass building for Minecraft Java
Fabric client · Paper/Leaf plugin · command + chat protocol (no custom payload)

License Paper Client Java Fabric

English manual · 简体中文手册 · Architecture · Protocol · Configuration


Features

  • Radial build menu (hold key, release to select) with place / break by held item
  • Server-authoritative shapes — client sends anchors only; server regenerates and validates
  • Economy (Vault) + materials (inventory / optional shulker boxes)
  • Tool-aware breaking with durability floor and effective-tool checks
  • CoreProtect logging under the player name (when the API is available)
  • Partial refunds for unfinished per-block / per-area charges

Build modes

single Single line Line wall Wall floor Floor
cube Cube d-line D-Line d-wall D-Wall slope Slope
circle Circle cylinder Cylinder sphere Sphere pyramid Pyramid
cone Cone

Modules

Module Role
maxfastbuild-api Platform-neutral contracts
maxfastbuild-core Shapes, billing, protocol, tasks
maxfastbuild-storage SQLite tasks / ledger / escrow
maxfastbuild-fabric Fabric client (26.2 target; + optional server entry)
maxfastbuild-paper Paper/Leaf plugin (api-version 1.21 → 1.21.11+, including 26.2)

Requirements

  • Java 21+ (25 recommended for 26.2 stacks)
  • Server: Paper/Leaf 1.21.11+ (plugin api-version: 1.21; also loads on newer lines such as 26.2)
  • Client (optional): Fabric Loader ≥ 0.19.3, Fabric API matching the client game version (e.g. 26.2)
  • SQLite: not bundled in the plugin jar — use the server’s JDBC / sqlite-jdbc on the classpath (Paper often ships libraries; otherwise add the driver)
  • Soft-depend: Vault, CoreProtect

Build

./gradlew build

Artifacts:

  • Release folder (preferred): release/MaxFastBuild-Paper-<version>.jar, release/MaxFastBuild-Fabric-<version>.jar
    Filled automatically by ./gradlew build (copyReleaseJars).
  • Local Leaf test server: if ../test-server-leaf/ exists, Paper jar is also copied to
    ../test-server-leaf/plugins/MaxFastBuild.jar (deployPaperToLeaf, after :maxfastbuild-paper:jar / build).
  • Module outputs: maxfastbuild-paper/build/libs/, maxfastbuild-fabric/build/libs/
./gradlew build
# or only plugin + deploy:
./gradlew :maxfastbuild-paper:jar deployPaperToLeaf

Install (quick)

  1. Put the Paper plugin jar in the server plugins/ folder.
  2. Put the Fabric client jar (and Fabric API) in the client mods/ folder.
  3. Configure plugins/MaxFastBuild/config.yml (economy, CoreProtect, shulkers, limits).
  4. Restart the server; join with the client mod.

Player controls and workflows: English / 中文.

Internationalization (i18n)

Surface Files
Fabric client UI / HUD / errors maxfastbuild-fabric/.../lang/en_us.json, zh_cn.json
Paper message templates (not loaded yet; protocol keys + hard-coded admin strings) maxfastbuild-paper/.../messages_en_us.yml, messages_zh_cn.yml
Player manuals docs/USER_MANUAL_en_US.md, docs/USER_MANUAL_zh_CN.md

Protocol responses use translation keys (e.g. maxfastbuild.task.accepted); the client resolves them with language files.

Protocol (summary)

Client → server (no custom channel):

/__mfb place <mode> x1 y1 z1 x2 y2 z2 hollow material
/__mfb break <mode> x1 y1 z1 x2 y2 z2 hollow

Server → client: system chat marked with U+2063MFB1: + JSON (messageKey + data).

Details: docs/protocol.md.

License

LGPL-3.0-only — see LICENSE and NOTICE.

Interaction concepts inspired by Effortless Building (Requios) and related work; MaxFastBuild uses a separate transport, billing, persistence, and audit design.

Contributing

See CONTRIBUTING.md. Please use Conventional Commits.

About

Server-authoritative mass building for Minecraft 26.2 (Fabric client + Paper plugin)

Topics

Resources

Code of conduct

Contributing

Stars

Watchers

Forks

Releases

Contributors

Languages