{"id":15398131,"url":"https://github.com/overmighty/croissant","last_synced_at":"2025-04-16T01:12:41.697Z","repository":{"id":57721965,"uuid":"201658081","full_name":"overmighty/croissant","owner":"overmighty","description":"🥐 Lightweight yet useful library for Bukkit/Spigot/Paper plugins.","archived":false,"fork":false,"pushed_at":"2020-09-03T22:04:02.000Z","size":185,"stargazers_count":11,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-16T01:12:36.375Z","etag":null,"topics":["bukkit","bukkit-plugin","command-framework","gradle","gui-framework","java","java-library","library","minecraft","minecraft-plugin","paper","spigot","spigot-plugin"],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/overmighty.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-08-10T16:53:55.000Z","updated_at":"2024-12-13T09:11:20.000Z","dependencies_parsed_at":"2022-09-12T07:51:49.001Z","dependency_job_id":null,"html_url":"https://github.com/overmighty/croissant","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/overmighty%2Fcroissant","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/overmighty%2Fcroissant/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/overmighty%2Fcroissant/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/overmighty%2Fcroissant/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/overmighty","download_url":"https://codeload.github.com/overmighty/croissant/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249178217,"owners_count":21225350,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bukkit","bukkit-plugin","command-framework","gradle","gui-framework","java","java-library","library","minecraft","minecraft-plugin","paper","spigot","spigot-plugin"],"created_at":"2024-10-01T15:41:06.532Z","updated_at":"2025-04-16T01:12:41.680Z","avatar_url":"https://github.com/overmighty.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n    \u003ch1\u003eCroissant\u003c/h1\u003e\n    \u003cblockquote\u003e\n        \u003cp\u003e🥐 Lightweight yet useful library for Bukkit/Spigot/Paper plugins.\u003c/p\u003e\n    \u003c/blockquote\u003e\n    \u003cp\u003e\n        \u003ca href=\"https://bintray.com/overmighty/maven/croissant\"\u003e\n            \u003cimg alt=\"Bintray\" src=\"https://img.shields.io/bintray/v/overmighty/maven/croissant\"\u003e\n        \u003c/a\u003e\n        \u003ca href=\"https://search.maven.org/artifact/com.github.overmighty/croissant\"\u003e\n            \u003cimg alt=\"Maven Central\" src=\"https://img.shields.io/maven-central/v/com.github.overmighty/croissant\"\u003e\n        \u003c/a\u003e\n        \u003ca href=\"https://discord.gg/u2UcCnY\"\u003e\n            \u003cimg alt=\"Discord\" src=\"https://discordapp.com/api/guilds/526906946209447939/embed.png\"\u003e\n        \u003c/a\u003e\n    \u003c/p\u003e\n\u003c/div\u003e\n\n## Introduction\n\nCroissant is a lightweight Java library that provides a **command framework**\nand a **GUI framework** for Bukkit/Spigot/Paper plugins.\n\nHere is a short summary of its features:\n\n- **Command framework**\n    - No need to declare commands in your plugin's plugin.yml file\n    - Automated argument parsing and tab-completion\n    - Arguments are inferred from\n    [method parameters](src/main/java/com/github/overmighty/croissant/command/CommandExecutor.java)\n    - Arguments can be either required or optional, and optional arguments can\n    have default values\n    - Built-in argument types + ability to create your own argument types\n    - Subcommands\n- **GUI framework**\n    - Create interactive GUIs from fake chest inventories\n    - Supports both single-page GUIs and multi-page GUIs with navigation buttons\n    (referred to as \"scrollable GUIs\")\n\nCroissant is currently written against the Paper 1.15.1 API, but supports\nBukkit/Spigot/Paper 1.8.x to 1.15.x.\n\n## Installation\n\nReleases of Croissant are published to a\n[Maven repository on Bintray](https://bintray.com/overmighty/maven/croissant),\nwhich is synced with JCenter and Maven Central.\n\nIf your project is built with Maven or a supported build tool such as Gradle,\nyou can easily add Croissant as a dependency for your project:\n\n#### Maven\n\n```xml\n\u003cdependency\u003e\n  \u003cgroupId\u003ecom.github.overmighty\u003c/groupId\u003e\n  \u003cartifactId\u003ecroissant\u003c/artifactId\u003e\n  \u003cversion\u003e1.0.2\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n#### Gradle (Groovy DSL)\n\n```gradle\nrepositories {\n    jcenter() // or mavenCentral()\n}\n\ndependencies {\n    implementation 'com.github.overmighty:croissant:1.0.2'\n}\n```\n\n[Example Gradle build script](https://github.com/OverMighty/croissant-example/blob/master/build.gradle)\n\n## Usage\n\nThe Croissant Javadoc can be browsed online [here](https://javadoc.io/doc/com.github.overmighty/croissant).\n\nYou can also look at the [example Bukkit plugin](https://github.com/OverMighty/croissant-example)\nto get started with Croissant.\n\n## Support\n\nIf you need help with Croissant, you can join my [Discord server](https://discord.gg/u2UcCnY).\n\n## Building\n\n**JDK 8 or later is required.**\n\nCroissant uses [Gradle](https://gradle.org/) and a Gradle wrapper is included in\nthis repository.\n\nThe following command can be run on Unix-like systems to build Croissant using\nthe Gradle wrapper included in this repository:\n\n```\n$ ./gradlew clean build\n```\n\nOn Windows, the `gradlew.bat` batch script can be used instead of the `gradlew`\nPOSIX shell script.\n\n## License\n\nThis project is licensed under the [MIT license](./LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fovermighty%2Fcroissant","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fovermighty%2Fcroissant","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fovermighty%2Fcroissant/lists"}