Home

config.yml

plugins/NovaUI/config.yml, as NovaUI ships it. Every setting is explained in its comment. After editing, run /novaui reload (no restart needed). The licence key can also be set from the console with novaui license <key> - see Licence & server seats.

# NovaUI settings. After editing, run /novaui reload (no restart needed).

pack:
  # How players get the HUD resource pack:
  #   self-host - NovaUI runs a small web server (see "http" below) and sends the pack to players itself
  #   external  - you upload plugins/NovaUI/output/pack.zip yourself and put its link in external-url;
  #               NovaUI still sends it to players (with the right sha1)
  #   manual    - NovaUI sends nothing (for example: you merged output/pack.zip into your own server pack)
  mode: self-host
  external-url: ""
  # Send the pack while the player is logging in (before they enter the world), so the HUD is ready at once.
  send-on-login: true
  # Longest time a login waits for the pack, in seconds.
  login-timeout: 60
  # Disconnect players who decline the pack.
  required: false
  prompt: "<gray>This server uses a small resource pack for its HUD."
  description: "NovaUI HUD"
  # Put your own server pack(s) (.zip) in plugins/NovaUI/merge/ and NovaUI merges them into one pack.
  # NovaUI's files win when both packs have the same file.
  merge: true

http:
  # Where the built-in pack web server listens.
  # "auto" = 127.0.0.1 when server-ip in server.properties is 127.0.0.1 (local testing), otherwise all addresses.
  bind: auto
  port: 8165
  # The address players' games download the pack from.
  # "auto" = the address each player typed to join (localhost for a local test, play.yourserver.net for real
  # players), so it usually needs no setup. Set your public IP or domain here if players can't download the pack
  # (for example behind a proxy that changes the address).
  public-host: auto
  # 0 = same as port. Change it when a firewall or panel maps the port to another public port.
  public-port: 0

hud:
  # Where the HUD is drawn:
  #   auto     - (default) pages on a text display that only the player can see, so F1 (hide GUI) doesn't hide
  #              them; the editor on both, so it covers the vanilla hotbar and still shows with F1.
  #   display  - everything on the text display. Survives F1; the vanilla hotbar, crosshair and held item draw
  #              over it.
  #   bossbar  - everything in the boss bar row (the GUI). Hidden by F1.
  render-mode: auto
  # Colour of the hidden boss bar that carries the HUD. Its bar is made invisible in the pack, so pick a colour
  # no other plugin uses for boss bars: pink, blue, red, green, yellow, purple or white.
  bossbar-color: yellow
  # Text sizes the pack contains (multiples of 8; 16 = normal Minecraft text at GUI scale 2 on a 1080p screen).
  text-sizes: [8, 16, 24, 32, 40, 48, 64, 80, 96, 128]
  # Corner radii the pack contains for rounded boxes (even numbers, 2 to 128).
  corner-radii: [2, 4, 6, 8, 10, 12, 16, 20, 24, 32, 48, 64]
  # Only show the HUD to 1.21.11 clients. Needs ViaVersion to tell versions apart; without it everyone gets it.
  require-1-21-11: true
  # Newest resource pack format that gets the HUD shader (75 = 1.21.11). Only raise it for a version you tested.
  shader-max-format: 75

editor:
  # How fast the editor's cursor follows the mouse: canvas pixels per degree of camera turn.
  # 8 feels like a normal desktop mouse at Minecraft's default sensitivity. Also changeable in the editor
  # (Window > Cursor speed).
  cursor-speed: 8
  # Old setting, not used by the full-screen editor.
  steps: [1, 2, 5, 10, 25, 50]

bedrock:
  # Bedrock players (joining through Geyser with Floodgate) can't run the HUD's Java shader. They get:
  #   actionbar - their open pages as one line of text above the hotbar. A page's "bedrock:" setting is its line
  #               (MiniMessage, placeholders); without it the page's texts are joined; "bedrock: none" hides it.
  #   off       - nothing
  # Menus (menus/*.yml) open as Bedrock forms with images for them, and as dialog screens for Java players.
  hud: actionbar

animations:
  # Animation pages that play by themselves. Use a page name (pages/<name>.yml with an "animation:" section),
  # or leave it empty for nothing. The shipped examples are anim_teleport, anim_title and anim_fade.
  on-join: ""
  on-teleport: ""
  on-world-change: ""
  # Teleports shorter than this many blocks (in the same world) don't play on-teleport.
  teleport-min-distance: 8

images:
  # Watch plugins/NovaUI/images/ and rebuild the pack by itself when a PNG is added, changed or removed.
  auto-reload: true
  # Allow /novaui image add <name> <url> to download a PNG (http or https, at most 8 MB).
  allow-download: true

# ---- License ----------------------------------------------------------------------------------------------------
license:
  # Your license key (it looks like XXXX-XXXX-XXXX-XXXX-XXXX). Get it in our Discord with /get-license, then put
  # it here and restart the server, or type "novaui license <key>" in the server console (no restart needed).
  # NovaUI checks the key online and stays switched off without a valid one.
  key: ""