Skip to content

Kazzababe/ravioli-views

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

53 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Ravioli Views  Maven Central

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 **.


📚 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

repositories {
    mavenCentral()
}

// Only the platform specific dependency is required
dependencies {
    implementation("dev.mckelle:ravioli-views-paper:1.1.18")
}

Gradle • Groovy DSL

repositories {
    mavenCentral()
}

// Only the platform specific dependency is required
dependencies {
    implementation 'dev.mckelle:ravioli-views-paper:1.1.18'
}

Maven

<!-- Only the platform specific dependency is required -->
<dependency>
    <groupId>dev.mckelle</groupId>
    <artifactId>ravioli-views-paper</artifactId>
    <version>1.1.18</version>
</dependency>

Tip The version in the snippets should match the number in the badge above.


🛠️ Example usage

See the example modules within each platform module.


📄 License

Ravioli Views is released under the MIT License — see LICENSE for details.