Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/overmighty/croissant
🥐 Lightweight yet useful library for Bukkit/Spigot/Paper plugins.
https://github.com/overmighty/croissant
bukkit bukkit-plugin command-framework gradle gui-framework java java-library library minecraft minecraft-plugin paper spigot spigot-plugin
Last synced: 28 days ago
JSON representation
🥐 Lightweight yet useful library for Bukkit/Spigot/Paper plugins.
- Host: GitHub
- URL: https://github.com/overmighty/croissant
- Owner: overmighty
- License: mit
- Created: 2019-08-10T16:53:55.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-09-03T22:04:02.000Z (about 4 years ago)
- Last Synced: 2024-10-05T22:58:09.455Z (about 1 month ago)
- Topics: bukkit, bukkit-plugin, command-framework, gradle, gui-framework, java, java-library, library, minecraft, minecraft-plugin, paper, spigot, spigot-plugin
- Language: Java
- Size: 181 KB
- Stars: 12
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Croissant
🥐 Lightweight yet useful library for Bukkit/Spigot/Paper plugins.
## Introduction
Croissant is a lightweight Java library that provides a **command framework**
and a **GUI framework** for Bukkit/Spigot/Paper plugins.
Here is a short summary of its features:
- **Command framework**
- No need to declare commands in your plugin's plugin.yml file
- Automated argument parsing and tab-completion
- Arguments are inferred from
[method parameters](src/main/java/com/github/overmighty/croissant/command/CommandExecutor.java)
- Arguments can be either required or optional, and optional arguments can
have default values
- Built-in argument types + ability to create your own argument types
- Subcommands
- **GUI framework**
- Create interactive GUIs from fake chest inventories
- Supports both single-page GUIs and multi-page GUIs with navigation buttons
(referred to as "scrollable GUIs")
Croissant is currently written against the Paper 1.15.1 API, but supports
Bukkit/Spigot/Paper 1.8.x to 1.15.x.
## Installation
Releases of Croissant are published to a
[Maven repository on Bintray](https://bintray.com/overmighty/maven/croissant),
which is synced with JCenter and Maven Central.
If your project is built with Maven or a supported build tool such as Gradle,
you can easily add Croissant as a dependency for your project:
#### Maven
```xml
com.github.overmighty
croissant
1.0.2
```
#### Gradle (Groovy DSL)
```gradle
repositories {
jcenter() // or mavenCentral()
}
dependencies {
implementation 'com.github.overmighty:croissant:1.0.2'
}
```
[Example Gradle build script](https://github.com/OverMighty/croissant-example/blob/master/build.gradle)
## Usage
The Croissant Javadoc can be browsed online [here](https://javadoc.io/doc/com.github.overmighty/croissant).
You can also look at the [example Bukkit plugin](https://github.com/OverMighty/croissant-example)
to get started with Croissant.
## Support
If you need help with Croissant, you can join my [Discord server](https://discord.gg/u2UcCnY).
## Building
**JDK 8 or later is required.**
Croissant uses [Gradle](https://gradle.org/) and a Gradle wrapper is included in
this repository.
The following command can be run on Unix-like systems to build Croissant using
the Gradle wrapper included in this repository:
```
$ ./gradlew clean build
```
On Windows, the `gradlew.bat` batch script can be used instead of the `gradlew`
POSIX shell script.
## License
This project is licensed under the [MIT license](./LICENSE).