For modpack makers

Set BuildPrint's defaults, lock settings and turn features off for everyone who plays your pack.

Ship config/buildprint/config.pack.json with your pack. BuildPrint reads it next to the player's own config.json and never writes to it, so a pack update never undoes what a player changed.

config/buildprint/config.pack.jsonJSON
{
  "defaults": { "ghostOpacity": 60, "buildAssist": true },
  "locked":   { "printerMode": false },
  "reason":   "No printer in this pack",
  "features": { "printer": false, "marketplace": false }
}

Defaults #

  • A default applies to every setting the player has not changed. What they changed stays theirs.
  • Change a default in a pack update, and it reaches every player who never touched that setting.
  • Reset in the settings goes back to your default, not BuildPrint's.
  • The keys are the ones in config/buildprint/config.json. Start the game once and copy them from there.
  • BuildPrint notes which defaults it applied in config/buildprint/config.pack-applied.json. That file is the player's: leave it out of your pack.

Locked settings #

A locked setting always has your value. In the settings it is greyed out with "Set by the modpack", and your reason when you give one.

Features #

Turn a feature off with false. The same names a server uses for its rules work here, and two more. Where a server turns a feature off, the player is told it is off on the server; where your pack does, that it is off in this modpack.

NameWhat it turns off
easy_placeEasy place
drag_placeDrag place
easy_destroyEasy break
angel_placementPlacing in mid-air
auto_rotateAuto-rotate
printerPrinter
excavatorExcavator
pastePaste
create_schematicsCreating schematics: saving from the world
free_cameraFree camera
carried_itemsTaking from carried boxes
placement_hintsExact placement
marketplaceThe Marketplace: browsing, downloading and publishing
build_togetherBuild together: shared build sessions

Schematics #

Files in the schematics folder of the game folder show up in the menu under Local. Ship them there to give players builds to start from.

Sorted reads the same kind of file, config/sorted.pack.json, from its next update on.

Something missing or wrong on this page? Say so on Discord.