Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/minuskube/netherboard

Scoreboard API for your Minecraft Sponge and Bukkit Plugins, supporting all versions from 1.7 to 1.19.
https://github.com/minuskube/netherboard

bukkit bukkit-plugin java minecraft plugin scoreboard scoreboard-api spigot spigot-plugin sponge

Last synced: about 2 months ago
JSON representation

Scoreboard API for your Minecraft Sponge and Bukkit Plugins, supporting all versions from 1.7 to 1.19.

Awesome Lists containing this project

README

        

# Netherboard

Scoreboard API for your Minecraft Sponge and Bukkit Plugins.
**You can use this as a Plugin, or just add it to your dependencies.**

## Features:
- Works for all the **Bukkit** versions since **1.7** (even **1.17**!).
- Works with **Sponge**! (Tell me if a version is not compatible)
- No blinking!
- Max characters per line:
- **1.7:** 16 (Working on it to allow 48 characters)
- **1.8+**: 40 (Working on it to allow 72 characters, *not sure if possible, we'll see*)

## TODO:
- Allow more characters per line (Using teams)

## Examples:
### Bukkit

Create a board:
```java
BPlayerBoard board = Netherboard.instance().createBoard(player, "My Scoreboard");
```

Create a board with your own Scoreboard object:
```java
BPlayerBoard board = Netherboard.instance().createBoard(player, scoreboard, "My Scoreboard");
```

Get a player's board:
```java
BPlayerBoard board = Netherboard.instance().getBoard(player);
```

When you have your board, you can do whatever you want with it:
```java
// Set a line
// If there is already a line with this score, it will replace it.
board.set("Test Score", 5);

// Set all the lines
// This will remove all the existing lines then set the new ones
board.setAll(
"First Line",
"Second Line",
"Third Line",
"Fourth Line",
"Fifth Line"
);

// Get a line from its score
board.get(5);

// Remove a line
board.remove(5);

// Change the name of the board
board.setName("My New Scoreboard");

// Clear the board
board.clear();

// Delete the board
board.delete();
```

### Sponge
Same thing than Bukkit, but the object is called `SPlayerBoard` and the methods requires `Text` objects instead of `String` ones.
*NB: With Sponge, please do not create boards for different players with the same `scoreboard`.*

## Usage
To use the Netherboard API, either:
- put it in the `plugins` folder of your server, add it to your dependencies in your plugin.yml (e.g. `depend: [Netherboard]`) and add it to the dependencies in your IDE.
- add it to the dependencies in your IDE and include it in your plugin jar.

You can download the latest version on the [Releases page](https://github.com/MinusKube/Netherboard/releases) on Github.

You can also use a build system:
### Gradle
```gradle
repositories {
mavenCentral()
}

dependencies {
compile 'fr.minuskube:netherboard-bukkit:1.2.3'

// Or if you use Sponge:
// compile 'fr.minuskube:netherboard-sponge:1.2.3'
}
```

### Maven
```xml

fr.minuskube
netherboard-bukkit



1.2.3

```

## Issues:
If you have a problem with the API, or you want to request a feature, make an issue [here](https://github.com/MinusKube/netherboard/issues).