Text Objects

Text

Text object used for rendering text with regular ttf/otf fonts.

All of the chat formatting codes are supported (color, bold, italic, underline, strikethrough)

## object name, you can set this to anything that is unique
text1:
  ## object type, in this case text
  type: text
  ## x and y positions relative to the parent
  position: 0 0 
  ## the horizontal alignment of the object (left/center/right)
  alignment: left
  ## the vertical alignment of the object (top, center, bottom)
  vertical-alignment: top  
  ## the text
  text: 'Welcome to the server %player_name%'
  ## formatting to use (possible settings: legacy, minimessage)
  formatting: legacy
  ## text capitalization (possible settings: default, uppercase, lowercase)
  capitalization: default
  ## font name of the font the text should use (Impact, Calibri, etc.)
  font: Default
  ## size of text
  font-size: 45
  ## if text is bold
  bold: false
  ## if the text is italic
  italic: false  
  ## color of text
  color: white
  ## the spacing between letters, shouldn't be changed unless the font spacing is wrong. The value should be between -0.3 and 0.1
  spacing: 0.0
  ## the color of the outline (no outline if color isn't set)
  outline-color: none
  ## the stroke width of the outline
  outline-stroke: 2.0
  ## base line ensures the text is consistently positioned when the text content changes
  use-base-line: true  ## functions that the object executes when clicked

Pixel Text

Simple Minecraft style pixel text renderer, useful when a more "native" looking text is desired.

Pixel Text has better performance than regular text renderer, so using it is recommended when the text contains placeholders that update frequently.

Supported formatting codes (color, bold)

## object name, you can set this to anything that is unique
pixeltext1:
  ## object type, in this case pixel text
  type: pixel_text
  ## x and y positions relative to the parent
  position: 0 0
  ## the horizontal alignment of the object (left/center/right)
  alignment: left
  ## the vertical alignment of the object (top, center, bottom)
  vertical-alignment: top
  ## the text
  text: 'Welcome to the server %player_name%'
  ## formatting to use (possible settings: legacy, minimessage)
  formatting: legacy
  ## text capitalization (possible settings: default, uppercase, lowercase)
  capitalization: default
  ## by how many times character/font size is multiplied
  font-scale: 1
  ## color of text
  color: black
  ## should the text have a shadow
  shadow: false

Auto Font Size Text

Maximum font size that can fit in the set size is automatically calculated. This is primarily useful for text containing placeholders that change.

Other properties and features are identical to the regular Text object.

## object name, you can set this to anything that is unique
autotext1:
  ## object type, in this case auto font size text
  type: auto_font_size_text
  ## x and y positions relative to the parent
  position: 0 0
  ## width and height of the object
  size: 128 64
  ## the horizontal alignment of the object (left/center/right)
  alignment: left 
  ## the vertical alignment of the object (top, center, bottom)
  vertical-alignment: top  
  ## the text
  text: 'Welcome to the server %player_name%'
  ## formatting to use (possible settings: legacy, minimessage)
  formatting: legacy
  ## text capitalization (possible settings: default, uppercase, lowercase)
  capitalization: default
  ## font name of the font the text should use (Impact, Calibri, etc.)
  font: Default
  ## if text is bold
  bold: false
  ## if the text is italic
  italic: false  
  ## color of text
  color: white
  ## the spacing between letters, shouldn't be changed unless the font spacing is wrong. The value should be between -0.3 and 0.1
  spacing: 0.0
  ## the color of the outline (no outline if color isn't set)
  outline-color: none
  ## the stroke width of the outline
  outline-stroke: 2.0
  ## base line ensures the text is consistently positioned when the text content changes
  use-base-line: true