https://github.com/kazzababe/ravioli-views
A modern, React-inspired GUI library for Paper/Spigot servers.
https://github.com/kazzababe/ravioli-views
api bukkit chest folia gui gui-api gui-framework inventory inventory-gui library menu minecraft minestom modding papermc spigot spigotmc
Last synced: 9 months ago
JSON representation
A modern, React-inspired GUI library for Paper/Spigot servers.
- Host: GitHub
- URL: https://github.com/kazzababe/ravioli-views
- Owner: Kazzababe
- Created: 2025-06-24T11:01:42.000Z (11 months ago)
- Default Branch: master
- Last Pushed: 2025-09-04T22:11:38.000Z (9 months ago)
- Last Synced: 2025-09-05T00:12:28.042Z (9 months ago)
- Topics: api, bukkit, chest, folia, gui, gui-api, gui-framework, inventory, inventory-gui, library, menu, minecraft, minestom, modding, papermc, spigot, spigotmc
- Language: Java
- Homepage:
- Size: 301 KB
- Stars: 3
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Ravioli Views 
Ravioli Views is a small framework for building inventory‑based UIs in Paper/Spigot plugins.
It exposes a React‑like component model, a diff engine, and lifecycle hooks so you can describe an interface as simple
Java objects instead of slot‑by‑slot code.
For detailed guides, tutorials, and API references, please see the [**wiki
**](https://github.com/Kazzababe/ravioli-views/wiki).
---
## 📚 Modules
| Module | Coordinates | What it contains |
|-----------|-----------------------------------|--------------------------------------------------------------------------------|
| **API** | `dev.mckelle:ravioli-views-api` | Public interfaces, annotations, and functional types. Stable across versions. |
| **Core** | `dev.mckelle:ravioli-views-core` | Diff engine, hooks, state management, and shared utilities. |
| **Paper** | `dev.mckelle:ravioli-views-paper` | Paper‑specific event listeners and helpers that wire the Core into the server. |
*(All modules are available on Maven Central—badge above always shows the latest released version.)*
---
## 📦 Installation
### Gradle • Kotlin DSL
```kotlin
repositories {
mavenCentral()
}
// Only the platform specific dependency is required
dependencies {
implementation("dev.mckelle:ravioli-views-paper:1.1.5")
}
```
### Gradle • Groovy DSL
```groovy
repositories {
mavenCentral()
}
// Only the platform specific dependency is required
dependencies {
implementation 'dev.mckelle:ravioli-views-paper:1.1.5'
}
```
### Maven
```xml
dev.mckelle
ravioli-views-paper
1.1.5
```
> **Tip** The version in the snippets should match the number in the badge above.
---
## 🛠️ Example usage
See the **example** modules within each platform module.
- **Paper** - [`Example Module`](./paper/example)
---
## 📄 License
Ravioli Views is released under the MIT License — see [LICENSE](https://opensource.org/license/mit) for details.