Sidebars

Sidebars

Sidebars appear on the side of the player's screen.

They are better for showing several lines of event information.

Basic example:

sidebar:
  enabled: true
  title: "&b&l{event_display}"
  lines:
    - "&7Time: &f{time_left}"
    - "&7Score: &a{score}"
    - "&7Rank: &e#{rank}"

---

Sidebar settings

Setting	Description
enabled	Enables or disables the sidebar
title	Sidebar title
lines	Sidebar lines

---

Sidebar placeholders

Sidebars support normal EventForge placeholders.

Common placeholders:

{event}
{event_display}
{time_left}
{elapsed}
{score}
{rank}
{participants}
{player}
{var:key}

Example:

sidebar:
  enabled: true
  title: "&b&l{event_display}"
  lines:
    - "&8&m----------------"
    - "&7Time: &f{time_left}"
    - "&7Score: &a{score}"
    - "&7Rank: &e#{rank}"
    - "&7Players: &f{participants}"
    - "&8&m----------------"

---

Simple sidebar example

sidebar:
  enabled: true
  title: "&b&l{event_display}"
  lines:
    - "&7Time: &f{time_left}"
    - "&7Score: &a{score}"
    - "&7Rank: &e#{rank}"

---

Detailed sidebar example

sidebar:
  enabled: true
  title: "&b&l{event_display}"
  lines:
    - "&8&m----------------"
    - "&7Time Left:"
    - "&f{time_left}"
    - ""
    - "&7Your Score:"
    - "&a{score}"
    - ""
    - "&7Your Rank:"
    - "&e#{rank}"
    - ""
    - "&7Participants:"
    - "&f{participants}"
    - "&8&m----------------"

---

Sidebar with variables

variables:
  event_color: "&b"
  sidebar_footer: "&7Good luck!"

sidebar:
  enabled: true
  title: "{var:event_color}&l{event_display}"
  lines:
    - "&8&m----------------"
    - "&7Time: &f{time_left}"
    - "&7Score: &a{score}"
    - "&7Rank: &e#{rank}"
    - ""
    - "{var:sidebar_footer}"
    - "&8&m----------------"

---

Player sidebar toggle

Players can toggle event UI with:

/events toggle

Permission:

eventforge.player.toggle

This is useful for players who do not want sidebars or event displays on their screen.

---