https://github.com/dani-error/lumina
☀️ Asynchronous, high-performance Minecraft Tab List & Scoreboard library
https://github.com/dani-error/lumina
api bukkit kotlin library minecraft paper scoreboard tablist
Last synced: about 2 months ago
JSON representation
☀️ Asynchronous, high-performance Minecraft Tab List & Scoreboard library
- Host: GitHub
- URL: https://github.com/dani-error/lumina
- Owner: Dani-error
- License: mit
- Created: 2025-06-25T13:11:27.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-06-25T14:08:53.000Z (12 months ago)
- Last Synced: 2025-06-25T14:25:23.238Z (12 months ago)
- Topics: api, bukkit, kotlin, library, minecraft, paper, scoreboard, tablist
- Language: Kotlin
- Homepage:
- Size: 26 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Features
- **Supports Bukkit & forks** (incl. Folia) via **PacketEvents**
- **Fake skin & ping** support
- **Client support**: 1.7.10+ | **Server**: 1.8+
- **Character limit**: 48 (≤ 1.12)
- **Header/Footer** with multiline support
- **Animations** for scoreboard & tablist
- **No flickering**
- **Kotlin DSL** with full type safety
---
## Usage
Gradle (Kotlin DSL)
```kotlin
repositories {
mavenCentral()
}
dependencies {
implementation("io.github.dani-error.lumina::1.0.0")
}
```
_Replace `` with one of the modules listed below._
Maven
```xml
io.github.dani-error.lumina
MODULE
1.0.0
```
_Replace `MODULE` with one of the modules listed below._
Gradle (Groovy DSL)
```groovy
repositories {
mavenCentral()
}
dependencies {
implementation 'io.github.dani-error.lumina::1.0.0'
}
```
_Replace `` with one of the modules listed below._
Additional Repositories
You may need to add the following if you rely on transitive dependencies:
- `https://repo.papermc.io/repository/maven-public/` (PaperLib)
- `https://repository.derklaro.dev/releases/` (ProtocolLib via Derklaro’s repo; can also use JitPack)
- `https://repo.codemc.io/repository/maven-releases/` (PacketEvents)
- `https://s01.oss.sonatype.org/content/repositories/snapshots/` (for snapshot-only dependencies)
Shading
To avoid conflicts when multiple plugins ship the same dependencies, shade/relocate these packages:
- `io.papermc.lib`
- `io.github.retrooper`
- `com.github.retrooper`
- `dev.dani.lumina`
---
## Modules
| Module Name | Artifact ID | Description |
|-------------|-------------|---------------------------------------------------------------|
| API | `api` | Core Lumina API (no platform-specific code). |
| Common | `common` | Abstract API implementations for building new platforms. |
| Bukkit | `bukkit` | Full Bukkit (and forks) implementation—includes API & Common. |
All of them published in [maven central](https://central.sonatype.com/search?q=io.github.dani-error.lumina).
---
## Documentation
Full API reference and usage examples are available on the [docs site](https://github.com/Dani-error/lumina/wiki).
## Contributing
Contributions are welcome! To get started:
1. Fork this repository.
2. Create a feature branch:
```bash
git checkout -b feature/
```
3. Make your changes in Kotlin (follow existing style).
4. Commit and push to your fork, then open a Pull Request against `main`.
Please include a short description of your changes. For larger features, open an issue first to discuss.
---
## License
This project is MIT-licensed. See [LICENSE](./LICENSE) for details.