A flicker-free scoreboard library with support of text up to 48 characters.
Branch: master
Clone or download
TigerHix Merge pull request #1 from DDynamic/patch-1
Remove unneeded dependency
Latest commit 9096ec0 Jun 3, 2016
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src/main Initial commit Sep 5, 2015
.gitignore Initial commit Sep 5, 2015
LICENSE Initial commit Sep 5, 2015
README.md Update README.md Sep 5, 2015
pom.xml Remove unneeded dependency Jun 3, 2016

README.md

ScoreboardLib

A flicker-free scoreboard library with support of text up to 48 characters.

What is ScoreboardLib?

ScoreboardLib is a flexiable library for adding pretty, animated scoreboards to your plugin without requiring you to figure out how to get rid of random flickers or limitations. This library is introduced to dealt with following problems in the original API and similar libraries:

  • Scoreboards cannot display text of more than 16 characters.
  • Scoreboards cannot display the same text more than once.
  • The scoreboard is flickering all the time.
  • Random disappearance of lines.

Any screenshots?

Preview

Other reasons to use ScoreboardLib?

  • Simple to use. You just have to decide the user interface, ScoreboardLib already got the backend handled.
  • Displays up to 48 characters instead of 16.
  • Easy to implement animated text with help of ScrollableString and HighlightedString.
  • Designed to be scalable and flexible.
  • Performant. ScoreboardLib doesn't create a scoreboard every time the content is updated.
  • Can be used as a standalone plugin, or be shaded into your project.

How do I add it to my project?

Simply add the following to your pom.xml.

<repository>
  <id>tiger-repo</id>
  <url>http://repo.tigerhix.me/content/repositories/snapshots/</url>
</repository>

<dependency>
  <groupId>me.tigerhix.lib</groupId>
  <artifactId>scoreboard</artifactId>
  <version>1.0.1-SNAPSHOT</version>
</dependency>

Now you are able to create your own pretty scoreboards.

How do I use it?

First, you have to decide whether you use ScoreboardLib as a standalone plugin, or you just go shade it into your own plugin. For the latter case, you have to add following code to your onEnable():

ScoreboardLib.setPluginInstance(this);

To let ScoreboardLib holds a reference to your plugin and hence able to schedule tasks, register events, etc.

For the scoreboard itself, here is an usage example:

for (Player player: getServer().getOnlinePlayers()) {
	Scoreboard scoreboard = ScoreboardLib.createScoreboard(player)
		.setHandler(new ScoreboardHandler() {

    		private final ScrollableString scroll = new ScrollableString(Strings.format("&aThis string is scrollable!"), 40, 0);
    		private final HighlightedString highlighted = new HighlightedString("This string is highlighted!", "&6", "&e");
    
    		@Override
    		public String getTitle(Player player) {
    			return null;
    		}
    
    		@Override
    		public List<Entry> getEntries(Player player) {
    			return new EntryBuilder()
    				.next("    " + scroll.next())
    				.next("    " + highlighted.next())
    				.blank()
    				.next("    &b&lCURRENT TIME MILLIS")
    				.next("    " + System.currentTimeMillis())
    				.blank()
    				.next("    &c&lCURRENT NANO TIME")
    				.next("    " + System.nanoTime())
    				.blank()
    				.next("    &7This line is equivalent to another line")
    				.next("    &7This line is equivalent to another line")
    				.blank()
    				.build();
    		}

	    })
	    .setUpdateInterval(2l);
	scoreboard.activate();
}

Which would display a scoreboard as shown in the above gif to all online players.

To remove the scoreboard, use:

scoreboard.deactivate();

That's really much of it. If you want to extend the functionalities somehow, simply create a new class that extends SimpleScoreboard, and start overriding methods, creating constructors, etc.

License

ScoreboardLib is licensed under the GNU Lesser General Public License (Version 3).