{"id":18400599,"url":"https://github.com/simplix-softworks/cirrus","last_synced_at":"2025-05-07T15:52:05.821Z","repository":{"id":39930215,"uuid":"287612933","full_name":"Simplix-Softworks/Cirrus","owner":"Simplix-Softworks","description":"Minecraft GUI library for Spigot, BungeeCord and Velocity. Powered by Protocolize v2!","archived":false,"fork":false,"pushed_at":"2024-09-07T09:30:46.000Z","size":910,"stargazers_count":135,"open_issues_count":4,"forks_count":5,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-31T11:35:40.499Z","etag":null,"topics":["bukkit","bungeecord","bungeecord-plugin","guis","hacktoberfest","intellij","intellij-plugin","java","menus","minecraft","minecraftmenus","paper","plugin","spigot","velocity"],"latest_commit_sha":null,"homepage":"","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/Simplix-Softworks.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-08-14T19:51:41.000Z","updated_at":"2025-02-23T05:54:47.000Z","dependencies_parsed_at":"2024-08-18T15:23:38.507Z","dependency_job_id":"9b2ba2ea-c905-416b-a79d-f92266e03191","html_url":"https://github.com/Simplix-Softworks/Cirrus","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Simplix-Softworks%2FCirrus","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Simplix-Softworks%2FCirrus/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Simplix-Softworks%2FCirrus/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Simplix-Softworks%2FCirrus/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Simplix-Softworks","download_url":"https://codeload.github.com/Simplix-Softworks/Cirrus/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252911621,"owners_count":21824055,"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","bungeecord","bungeecord-plugin","guis","hacktoberfest","intellij","intellij-plugin","java","menus","minecraft","minecraftmenus","paper","plugin","spigot","velocity"],"created_at":"2024-11-06T02:35:03.692Z","updated_at":"2025-05-07T15:52:05.801Z","avatar_url":"https://github.com/Simplix-Softworks.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://i.imgur.com/vmfZcvS.png\" /\u003e\n\u003c/p\u003e\n\n\n# Cirrus\n[![Build Status](http://ci.exceptionflug.de/buildStatus/icon?job=Cirrus)](http://ci.exceptionflug.de/job/Cirrus/) [![JetBrains IntelliJ Plugins](https://img.shields.io/jetbrains/plugin/v/15194-cirrus-tooling)](https://plugins.jetbrains.com/plugin/15194-cirrus-tooling) [![Discord](https://img.shields.io/discord/752533664696369204?label=Discord)](https://discord.simplixsoft.com/) ![GitHub](https://img.shields.io/github/license/Exceptionflug/Protocolize)\n\nMenu Framework.\nCirrus enables you to develop platform-independent versatile graphical menus for Spigot, BungeeCord, and Velocity! The\ngoal of Cirrus is to aim for maximum compatibility. Cirrus had been tested on several well-known BungeeCord-Forks as\nwell on all Spigot versions beginning from 1.16.5 till the latest release. The first-ever way of creating menus for Velocity.\n\n# WIP\n\nCirrus is currently WIP. The documentation is invalid in parts. We will publish a stable version soon.\nSpigot \u0026 BungeeCord implementations will work, Velocity implementations are currently very experimental.\nWe aim to publish documentation \u0026 production ready versions in the coming month.\n\n## Version\nCurrent version is:\n- Stable: 2.0.0\n- Development: 2.1.0-SNAPHOT\n\n## PR\n\nIf you have any improvements regarding Cirrus feel free to create a PR. We are happy to review \u0026 merge it.\nKeep in mind that to use our codestyle as defined in .editorconfig.\n\n## Platforms\n\nOn Spigot Cirrus is fully independent of third party plugins. Protocolize is needed only only if Cirrus is used on\nproxies like BungeeCord or Velocity.\n\n- Spigot \n- BungeeCord\n- Velocity (WIP)\n\n## Supported Bukkit Versions\n\nDue to the changes in the API we only officially support 1.16.5-LATEST (which is 1.19 by the time this is written)\nSince Cirrus is designed to be mostly version independent, older versions will likely function as well but they are deprecated (so we won't attempt to resolve issues with these versions).\n\n## Tooling\n\nCirrus offers an IntelliJ plugin to enhance the usability of Cirrus. It provides a realtime preview while editing menu\nconfiguration files.\n\n[![JetBrains IntelliJ plugins](https://img.shields.io/jetbrains/plugin/d/15194-cirrus-tooling)](https://plugins.jetbrains.com/plugin/15194-cirrus-tooling)\n\n![Tooling](https://i.imgur.com/88pvZ8G.gif)\n\n## Requirements\n\n### Protocolize\n\nCirrus is powered by [Protocolize](https://github.com/Exceptionflug/protocolize). A protocol manipulation library by one\nof the Simplix Softworks founders, Exceptionflug. Protocolize enables you to do so much more on BungeeCord/Velocity!\n\n## Installation\n\nJust shade and relocate the platform module into your own plugin. Don't forget to call the `CirrusSpigot`\n, `CirrusBungeeCord` or `CirrusVelocity` init method.\n\n### More developer documentation\n\nCheck out the [wiki](https://github.com/Simplix-Softworks/Cirrus/wiki) for further information on how to use Cirrus in\nyour application.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimplix-softworks%2Fcirrus","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsimplix-softworks%2Fcirrus","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimplix-softworks%2Fcirrus/lists"}