# Configuration Everything lives in `plugins/Sign/config.yml`. Edit it, then run `/sign reload` to see the change. There's a `version` field at the top. Leave it alone, it's how Sign updates your file when you upgrade. ## The basics | Setting | Default | What it does | |---|---|---| | `nametags.enabled` | `true` | Turn Sign off and you get ordinary Minecraft nametags back | | `nametags.show-self` | `true` | Whether you see your own nametag above your head | | `nametags.update-interval` | `20` | How often nametags refresh, in ticks. 20 is once a second | | `nametags.visibility-distance` | `32` | How far away a nametag is still visible, in blocks | Lowering `update-interval` makes things like a health display react faster, at the cost of a little more work for the server. Once a second is fine for most servers. Go to `5` if you want health that visibly keeps up with a fight. ## What's written on it ```yaml nametags: display: lines: - "<gray>{player}" - "<red>❤ <white>{health}" ``` Top line first. Style them with MiniMessage, so colours, gradients and hover text all work. Two placeholders are built in: | Placeholder | Gives you | |---|---| | `{player}` | Their name | | `{health}` | Their current health, like `20` | With PlaceholderAPI installed, any placeholder you already use works here too. ### Showing a line only sometimes Wrap it in a condition: ```yaml lines: - "<gray>{player}" - "<condition:'%player_is_op%'><gold>OP</condition>" - "<red>❤ <white>{health}" ``` When the placeholder comes back `true` the line shows. Otherwise it's skipped entirely, and the lines below move up. No empty gap. Any line that ends up empty is hidden the same way, so you never get a floating blank. ## How it looks | Setting | Default | What it does | |---|---|---| | `display.text-shadow` | `true` | Drop shadow behind the text | | `display.see-through` | `false` | Whether the nametag shows through walls | | `display.support-crouching` | `true` | Sneaking dims the nametag and stops it showing through walls | | `display.condense-holograms` | `false` | `true` puts every line in one box. `false` gives each line its own, which makes backgrounds sit tighter to the text | | `display.text-alignment` | `center` | `left`, `right` or `center` | | `display.background` | `default` | A hex colour like `#FFFFFF`, or `transparent`, or `default` | | `display.billboard` | `center` | How it turns to face people: `fixed`, `vertical`, `horizontal` or `center` | `billboard: center` is the usual choice, where the nametag always faces the viewer. `vertical` keeps it upright but lets it turn, which reads better on very tall nametags. ## Size ```yaml display: scale: x: 1 y: 1 z: 1 ``` `1` is normal. Raise all three together to make nametags bigger, or drop them to around `0.75` for something subtler. ## A full example ```yaml version: 1 nametags: enabled: true show-self: true update-interval: 20 visibility-distance: 32 display: lines: - "<gray>{player}" - "<red>❤ <white>{health}" text-shadow: true see-through: false support-crouching: true condense-holograms: false text-alignment: "center" background: "default" billboard: "center" scale: x: 1 y: 1 z: 1 ``` ## Upgrading from an older version Sign updates your config for you on startup when it's out of date. Coming from version `0`, `update-interval` gets converted from seconds to ticks, and `support-crouching` and `condense-holograms` are added with their defaults. Nothing for you to do. ## Related Pages - [[Sign/Server Owners/Overview]], what Sign does - [[Sign/Server Owners/Commands]], the three commands