sidebars.yml

sidebars.yml

Rules of setting a sidebar

Mandatory fields:

name: "first-sidebar"

The name that of the sidebar STRING: Enclose string with "" after the colon

header: "My server"

The name that will be displayed as the header of the sidebar STRING: Enclose string with "" after the colon

entries:

The contents of the sidebar
LIST: Use - at the start of every line and enclose string with ""

Optional fields

aliases:

Other names of the sidebar LIST: Use - at the start of every line and enclose string with ""

Limitations

1. 16 lines (Others will not be rendered)
2. 40 characters per line (Theoretically if I re-analyze my code and use team prefix/suffix trickery i think i can get that to 72 chars)
3. No sidebars limit, but too many can cause performance derps

Placeholders

%player%

• Gets the player name

%x%, %x.player%, %y%, %y.player%, %z%, %z.player%

• Gets the location of a player

%balance%, %balance.player%

• Gets the balance of a player

%datetime.HH:mm:ss, dd/MM/yyyy%

• Uses a format to encode the current time (Required)
• Read about format codes here:

1. https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html (Difficulty level: Overwhelming for first time readers)

%timezone%

• Gets your timezone (e.g +00:00)

%region.1%, %region.player.1%

• Gets a region from the player's region list
• Number signifies the rank (1st in the list, 2nd in the list, etc)

%stat.LEAVE_GAME%, %mstat.MINE_BLOCK.STONE%, %estat.MOB_KILLS.CHICKEN%

• Gets a statistic monitored by the Spigot server
• Use mstat for statistics that require a material (A block type)
• Use estat for statistics that require an entity (A mob type)
• Read about possible inputs here: 1 https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Statistic.html

2. https://hub.spigotmc.org/javadocs/spigot/org/bukkit/entity/EntityType.html
3. https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Material.html (Difficulty level: Moderately easy for first time readers)

Tip

Ctrl + f on your browser can help a lot in finding the EntityType/ Material

%afktime%, %afktimeleft%

• Gets time past AFK or AFK time left (Inverse from each other)