Skip to main content

Documentation Index

Fetch the complete documentation index at: https://velas.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

VelaBoard is a flexible Minecraft Scoreboard API designed for Spigot plugin developers. It removes the complexity of working directly with Bukkit’s low-level scoreboard API, giving you a clean interface to create sidebars, manage teams, and react to scoreboard events with minimal code.

​
What VelaBoard provides

  • Player sidebars — per-player HUD panels with up to 15 configurable lines
  • Shared sidebars — one sidebar displayed to multiple players simultaneously
  • Team management — groups of players and entities with colors, prefixes, collision rules, and name tag visibility
  • Bukkit events — cancellable events fired when sidebars are shown or players join teams
  • Fluent API — method chaining for concise team and sidebar configuration

​
How it works

VelaBoard is implemented as a Spigot plugin that your plugin depends on. Once loaded, your plugin accesses the API through the ScoreboardAPI singleton: 
ScoreboardHandler handler = ScoreboardAPI.getHandler();
Scoreboard board = handler.createScoreboard();
board.addPlayer(player);

PlayerSidebar sidebar = board.createPlayerSidebar("§6My Plugin");
sidebar.setLine(0, "§7Welcome, §f" + player.getName());
sidebar.setPlayer(player);
sidebar.show();

Installation

Add VelaBoard to your Maven or Gradle project.

Quick Start

Build your first sidebar in minutes.

Core Concepts

Understand Scoreboards, Sidebars, and Teams.

API Reference

Full reference for every class and method.