https://github.com/shieldcommunity/sternalboard
Lightweight & animated scoreboard, packet-based designed for easy usage
https://github.com/shieldcommunity/sternalboard
api async bukkit minecraft paper scoreboard sideboard spigot
Last synced: 9 months ago
JSON representation
Lightweight & animated scoreboard, packet-based designed for easy usage
- Host: GitHub
- URL: https://github.com/shieldcommunity/sternalboard
- Owner: ShieldCommunity
- License: mit
- Created: 2021-04-09T16:41:04.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2025-07-23T05:36:35.000Z (11 months ago)
- Last Synced: 2025-10-07T15:52:34.890Z (9 months ago)
- Topics: api, async, bukkit, minecraft, paper, scoreboard, sideboard, spigot
- Language: Java
- Homepage: https://www.spigotmc.org/resources/sternalboard-lightweight-animated-scoreboard.89245/
- Size: 652 KB
- Stars: 64
- Watchers: 3
- Forks: 19
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# SternalBoard
Lightweight & Async packet-based multi-version scoreboard using FastBoard API.
## Official Downloads
* [SpigotMC page](https://www.spigotmc.org/resources/sternalboard-lightweight-animated-scoreboard.89245/)
* [Polymart page](https://polymart.org/resource/sternalboard-lightweight.1379)
* [MC-Market page](https://www.mc-market.org/resources/20395/)
## Maintainers
* [xism4](https://github.com/xism4) Main developer
* [jonakls](https://github.com/jonakls) Developer
## Features
* High-performance - Well-known libraries are used by their good resource management and cleanup. In addition to running most features asynchronously.
* Bedrock support - Will look exactly the same as on other platforms with no vision problems
* Tab system - You will be able to modify the header and footer of the player view
* World blacklist - Ability to disable the scoreboard in certain worlds
* Auto tab-completer for modern Paper, legacy, Spigot and forks
* MiniMessage formatting support - Adventure colours like hello
* Packet-based - The plugin will not bug with plugins that use teams
* Animated scoreboard - The scoreboard data is constantly being modified
* Per world scoreboard - Ability to display different scoreboards in selected worlds
* Multi-version plugin - Supports 1.7 to lastest
* Mini-games support - The API was implemented in several mini-games supporting their custom scoreboards
* Simple to use - Very intuitive configuration for new people
* Maximum weight compression thanks to library downloader
* The plugin will start without relying on other plugins
## How to integrate
If you want to integrate SternalBoard to your proyect, you can use Maven and Gradle:
Before nothing, remember that you need jitpack for it (https://jitpack.io/#ShieldCommunity/SternalBoard)
## Maven
```xml
com.github.ShieldCommunity
SternalBoard
2.3.1
compile
```
## Gradle
```gradle
plugins {
id 'com.github.johnrengelman.shadow' version '8.1.1'
}
repositories {
mavenCentral()
}
dependencies {
implementation 'com.xism4.sternalboard:2.3.1'
}
shadowJar {
relocate 'com.xism4.sternalboard', 'you.package.like.scoreboard'
}
```
## Gradle DSL
```kts
plugins {
id("com.github.johnrengelman.shadow") version("8.1.1")
}
repositories {
mavenCentral()
}
dependencies {
implementation("com.xism4:sternalboard:2.3.1")
}
shadowJar {
relocate("com.xism4.sternalboard", "you.yourpackage.like.scoreboard")
}
```
## Manually
You can copy the classes and paste them into your project if you are not yet using a dependency system such as gradle or maven
## How to hook into it
With a simple call you can create your first scoreboard
```java
public class ExampleBoard {
public void setScoreboard(Player player){
SternalBoardHandler board = new SternalBoardHandler(player);
board.updateTitle(ChatColor.GREEN+
"Hypixel.net" //You can make it configurable trough strings tho
);
board.updateLines("Hello", //You can do lines as your version allows!
"shieldcommunity.net",
);
}
}
```
#Servers using SternalBoard
