Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
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: 6 days ago
JSON representation
Scoreboard API for your Minecraft Sponge and Bukkit Plugins, supporting all versions from 1.7 to 1.19.
- Host: GitHub
- URL: https://github.com/minuskube/netherboard
- Owner: MinusKube
- License: apache-2.0
- Created: 2017-05-01T19:27:06.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-10-12T22:37:23.000Z (about 2 years ago)
- Last Synced: 2024-10-30T16:55:06.502Z (14 days ago)
- Topics: bukkit, bukkit-plugin, java, minecraft, plugin, scoreboard, scoreboard-api, spigot, spigot-plugin, sponge
- Language: Java
- Homepage:
- Size: 226 KB
- Stars: 77
- Watchers: 5
- Forks: 20
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE
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).