Skip to content

Main Config

Every section of config.yml, with its default values.

require-permission: false lets everyone use a feature. true asks for the permission written in the comment above it, see Permissions.

Menu titles and icons are in their own file, see GUI.

gui

gui:
  require-permission: false
  buttons:
    visible:
      require-permission: false
    # gravity, base-plate and pose have the same key
    arms:
      require-permission: false
      show-hands: false             # true = held items stay visible while arms are off
    lock:
      require-permission: false
      personal: false               # true = only the player who locked a stand can open its GUI

backpack

backpack:
  require-permission: true
  scale: 0.625      # 1.0 = the size of a full block
  offset:
    y: 3.5885       # height above the stand's feet, moves with the body pose

balloon

balloon:
  require-permission: false
  click-part: chestplate    # right-clicking this part in the world fills the balloon
  item:
    scale: 0.625
    small-head: false       # true = sized for a small stand's head
  model:
    require-permission: true
    scale: 1.25             # 1.0 = the model's own size
    leash-bone: handle      # the model's l_ bone the lead ties to, written without l_
  mob:
    require-permission: false
    scale: 1.25
    baby:
      require-permission: false

If the model has no l_ bone with the leash-bone name, the lead ties to its first l_ bone.

offsets

Positions measured from the stand's feet: x to the side, y up, z forward. x and z turn with the stand.

  offsets:
    position:    { x: -1.25, y: 3.25, z: 0.0 }   # where the balloon floats
    lead-end:    { x: -1.25, y: 3.25, z: 0.0 }   # the lead's end at the balloon
    lead-start:  { x: -0.25, y: 0.75, z: 0.0 }   # the lead's end at the stand
    rise-from:   { x: -0.25, y: 0.75, z: 0.0 }   # where a new balloon starts rising from

motion

  motion:
    turn-speed: 0.12          # how fast it turns to follow the stand, 0 to 1
    follow-speed: 0.1         # how fast it moves to follow the stand, 0 to 1
    drag-lean:
      strength: 2.0           # how far it leans when the stand moves, 0 = never
      max-degrees: 22.5
    rise:
      enabled: true           # a new balloon floats up instead of appearing
      speed-share: 0.35       # rising speed, as a share of follow-speed
    culling:
      enabled: true           # stop moving balloons nobody is near
      radius-blocks: 32       # players further than this don't count
      always-radius-blocks: 5 # players closer than this always count
    sway:                     # tilting side to side, mob balloons never sway
      item: true
      model: true
      tilt-degrees: 5.0
    bob:                      # floating up and down
      item: true
      model: true
      mob: true
      distance-blocks: 0.25
      speed: 0.05             # also sets the sway speed

model

model:
  emissive-bone: emissive   # bones with this word in their name glow, on mannequins and model balloons

mannequin

The bone names in your models that receive the stand's pose. See Building a Model.

mannequin:
  bones:
    head: head
    body: body
    left-arm: left_arm
    right-arm: right_arm
    left-leg: left_leg
    right-leg: right_leg
    base-plate: baseplate   # not posed, only shown or hidden with the Base Plate button

A model without one of these bones is fine, that part is simply skipped.

paste-slot

The two copy slots, see Copy slots.

paste-slot:
  setup:                    # the first slot of the stand GUI
    require-permission: true
    items:                  # bringing the copy's items along
      require-permission: true
  pose:                     # the pose paste slot
    require-permission: false

A paste does not use up the copy, so one copy could dress any number of stands. Keep items.require-permission on for survival servers.

break

What a stand keeps when it is broken, see Copy and paste.

break:
  copy:
    pose: true
    setup: true
    items: false
Key What the dropped copy remembers
pose The angle of every part
setup The toggle buttons, the mannequin and a ModelEngine balloon
items Armour, held items, the backpack, and an item or mob balloon. While off, these drop beside the copy as normal items
  • Players with boxstand.break.bypass always get all three, see /boxstand breakmode.
  • The lore on a copy comes from pose.copy-items, pose.copy-setup and pose.copy-pose in Messages.
  • Turn all three off to make stands break like vanilla.

pose

The rest pose

The pose a stand starts in. It is also where shift-clicking a part puts it back, and the pose a stand takes when a mannequin goes on.

pose:
  default-animation: idle   # a mannequin rests on the first frame of this animation
  default:                  # angles in degrees, used when there is no such animation
    head:      { x: 0,   y: 0, z: 0 }
    body:      { x: 0,   y: 0, z: 0 }
    right-arm: { x: -15, y: 0, z: 10 }
    left-arm:  { x: -10, y: 0, z: -10 }
    right-leg: { x: 1,   y: 0, z: 1 }
    left-leg:  { x: -1,  y: 0, z: -1 }
Stand Its rest pose
No mannequin The default: angles
Mannequin The first frame of the chosen preset pose, or of default-animation when none is chosen
Mannequin whose model lacks that animation The default: angles

Controls

  control: scroll           # scroll or wasd, see Usage
  body-turn-xz: false       # let the body lean on X and Z, not just turn on Y
  swap-view-axes: true      # swaps which axis the front and side views turn
  sidebar: true             # show the angles on the sidebar while posing
  outline-block: orange_stained_glass   # outlines the part being posed
  scroll:
    step-degrees: 5         # degrees per scroll notch
    invert-direction: false
    hide-hotbar: true       # empty the hotbar while posing
  wasd:
    step-degrees: 5
    cooldown-ticks: 1       # ticks between turns while a key is held
    hide-hotbar: false

body-turn-xz is off as it ships. The body then only turns on the Y axis, the way the whole stand does: it faces a direction and cannot lean. Its button and the sidebar show that one angle instead of three. Turn it on and the body leans like any other part, with the readouts growing back on their own.

It is the body alone. The head, arms and legs turn on all three axes whatever this says, and so does a pose that arrives from a mannequin's preset or a copied stand - the switch is about what a player's own hands can do to the torso, which carries the head, the arms and everything worn with it.

The outline is only shown to the posing player. Pick a see-through block so the part stays visible. Bedrock players see particles instead. The controls themselves are listed in Usage.

sneak

A glowing outline around hidden stands while a player sneaks.

sneak:
  require-permission: false
  radius-blocks: 20
  blacklisted-worlds: [spawn, hub, lobby, event, minigame]   # nothing lights up here, even for admins

The outline is sent to the sneaking player alone, so nobody else sees the stands they are looking for.

/boxstand bypass turns the outlines back on for one player in the blacklisted worlds.

ghost-click

Arms and held items that stick out past a stand's hitbox can still be clicked, see Clicking a stand. This turns that off in some worlds.

ghost-click:
  blacklisted-worlds: [spawn, hub, lobby, event, minigame]
  • In these worlds, a punch past a stand's raised arm reaches whatever is behind it. Useful in arenas.
  • Clicking the stand itself still works everywhere.
  • Players with boxstand.ghost-click.bypass, or with /boxstand bypass on, can still click arms there.
  • World names are not case sensitive.