Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/simplix-softworks/cirrus
Minecraft GUI library for Spigot, BungeeCord and Velocity. Powered by Protocolize v2!
https://github.com/simplix-softworks/cirrus
bukkit bungeecord bungeecord-plugin guis hacktoberfest intellij intellij-plugin java menus minecraft minecraftmenus paper plugin spigot velocity
Last synced: 9 days ago
JSON representation
Minecraft GUI library for Spigot, BungeeCord and Velocity. Powered by Protocolize v2!
- Host: GitHub
- URL: https://github.com/simplix-softworks/cirrus
- Owner: Simplix-Softworks
- License: mit
- Created: 2020-08-14T19:51:41.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-09-07T09:30:46.000Z (2 months ago)
- Last Synced: 2024-09-07T10:48:11.182Z (2 months ago)
- Topics: bukkit, bungeecord, bungeecord-plugin, guis, hacktoberfest, intellij, intellij-plugin, java, menus, minecraft, minecraftmenus, paper, plugin, spigot, velocity
- Language: Java
- Homepage:
- Size: 889 KB
- Stars: 131
- Watchers: 3
- Forks: 4
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Cirrus
[](http://ci.exceptionflug.de/job/Cirrus/) [](https://plugins.jetbrains.com/plugin/15194-cirrus-tooling) [](https://discord.simplixsoft.com/) 
Menu Framework.
Cirrus enables you to develop platform-independent versatile graphical menus for Spigot, BungeeCord, and Velocity! The
goal of Cirrus is to aim for maximum compatibility. Cirrus had been tested on several well-known BungeeCord-Forks as
well on all Spigot versions beginning from 1.16.5 till the latest release. The first-ever way of creating menus for Velocity.
# WIP
Cirrus is currently WIP. The documentation is invalid in parts. We will publish a stable version soon.
Spigot & BungeeCord implementations will work, Velocity implementations are currently very experimental.
We aim to publish documentation & production ready versions in the coming month.
## Version
Current version is:
- Stable: 2.0.0
- Development: 2.1.0-SNAPHOT
## PR
If you have any improvements regarding Cirrus feel free to create a PR. We are happy to review & merge it.
Keep in mind that to use our codestyle as defined in .editorconfig.
## Platforms
On Spigot Cirrus is fully independent of third party plugins. Protocolize is needed only only if Cirrus is used on
proxies like BungeeCord or Velocity.
- Spigot
- BungeeCord
- Velocity (WIP)
## Supported Bukkit Versions
Due to the changes in the API we only officially support 1.16.5-LATEST (which is 1.19 by the time this is written)
Since 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).
## Tooling
Cirrus offers an IntelliJ plugin to enhance the usability of Cirrus. It provides a realtime preview while editing menu
configuration files.
[](https://plugins.jetbrains.com/plugin/15194-cirrus-tooling)
## Requirements
### Protocolize
Cirrus is powered by [Protocolize](https://github.com/Exceptionflug/protocolize). A protocol manipulation library by one
of the Simplix Softworks founders, Exceptionflug. Protocolize enables you to do so much more on BungeeCord/Velocity!
## Installation
Just shade and relocate the platform module into your own plugin. Don't forget to call the `CirrusSpigot`
, `CirrusBungeeCord` or `CirrusVelocity` init method.
### More developer documentation
Check out the [wiki](https://github.com/Simplix-Softworks/Cirrus/wiki) for further information on how to use Cirrus in
your application.