Skip to content

Latest commit

 

History

History
115 lines (89 loc) · 3.44 KB

README.md

File metadata and controls

115 lines (89 loc) · 3.44 KB
Raw

SternalBoard

image

Lightweight & Async packet-based scoreboard using FastBoard API, implementing animations, tab and supporting all versions.

Official Downloads

Maintainers

Features

  • Fully bedrock support - Other plugins have's strange view problems
  • Tab system for header and footer - Customize your player's tab view
  • World blacklist - If you don't want the scoreboard appear on some worlds you can!
  • Auto tab-completer for modern Paper, legacy, Spigot and forks
  • MiniMessage formatting support - Intutive colours like hello
  • Automatic dependency download to avoid high weights - Also makes all Minecraft versions support
  • Not dependency based - Doesn't need other software to run properly
  • Packet-based - The plugin will not bug with plugins that use teams
  • Animated scoreboard - With all tasks running asynchronous
  • Per world scoreboard - Optimal for multi-games
  • Gradient scoreboard support - 1.16 up
  • Multi-version scoreboard - Supports 1.7 to lastest
  • Mini-games support, such as "koths, skywars, bedwars"
  • Simple to use, for people who are relatively new to the industry
  • Ready to run on large servers, with no animation limits

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

        <dependency>
            <groupId>com.github.ShieldCommunity</groupId>
            <artifactId>SternalBoard</artifactId>
            <version>2.2.9</version>
            <scope>compile</scope>
        </dependency>

Gradle

plugins {
    id 'com.github.johnrengelman.shadow' version '7.1.2'
}

repositories {
    mavenCentral()
}

dependencies {
    implementation 'com.github:shieldcommunity:2.2.9'
}

shadowJar {
    relocate 'com.shieldcommunity.sternalboard', 'you.yourpackage.like'
}

Gradle DSL

plugins {
    id("com.github.johnrengelman.shadow") version("7.1.2")
}

repositories {
    mavenCentral()
}

dependencies {
    implementation("com.github:shieldcommunity:2.2.9")
}

shadowJar {
    relocate("com.shieldcommunity.sternalboard", "you.yourpackage.like")
}

Manually

If you just don't want to use a dependency-manager, you can copy our api classes to your proyect.

How to hook into it

With SternalBoard, it's really easy to set your first scoreboard!

Either you can use our method of #setBoard, or manually.

public class ExampleBoard {

    public void setYourScoreboard(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!
                "Bye",
                "Hello again :)"
        );
    }
}

#Servers using modern SternalBoard

ResourceHolders statics