Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/iamgio/chorus

:pencil: The first editor for Spigot configurations.
https://github.com/iamgio/chorus

bukkit editor javafx kotlin minecraft spigot yaml yaml-editor

Last synced: about 1 month ago
JSON representation

:pencil: The first editor for Spigot configurations.

Awesome Lists containing this project

README

        


Banner

![Downloads](https://img.shields.io/github/downloads/iamgio/chorus/total.svg) [![Release](https://img.shields.io/github/release/iamgio/chorus.svg)](https://chorus.iamgio.eu) [![GitHub license](https://img.shields.io/github/license/iAmGio/chorus)](https://github.com/iAmGio/chorus/blob/master/LICENSE)

> This is going to be Chorus' last major release.
> I'm extremely thankful for the support this software has received and I'm glad you enjoyed it!
> However, 5 years (as of 2023) have passed since its initial release, and I feel the need to move on to some new,
> exciting projects that would teach me new things along the way.
> After all, this is what coding is:
> 5-years-ago me made some design choices that I would not have picked now,
> but I guess that's how you grow up: you fail and learn,
> and I'm proud of what Chorus has taught me.

## What is Chorus?
Chorus is an easy-to-use and lightweight [YAML](http://yaml.org/) editor, created for anyone who works on [Spigot](https://spigotmc.org)-based Minecraft servers.
Thanks to its features, Chorus is perfect to edit configurations quickly and easily.

## Why Chorus?
**Chorus has a lot of features that will help you edit your configuration with extreme ease:**


* Edit **remote files** (SFTP and FTP);

![SFTP](https://i.imgur.com/hbDH51r.png)

* Show **previews** of **chat**, **title**, **scoreboard**, **item**, **GUI**, **sign**, **action bar**, **boss bar**, **mob bar**, **MOTD** and **animated text**;

![Chat preview](https://i.imgur.com/wHnDKvA.png)

![GUI preview](https://i.imgur.com/ENLn206.png)

![Animated text preview](https://i.imgur.com/RkKJMPm.gif)

* Use **autocompletion** to insert elements quicker;

![Autocompletion](https://i.imgur.com/PvvNhs5.png)

* Quickly show colored text;

![Quick preview](https://i.imgur.com/N2MrEMD.png)

* Insert colored text via an **editor**;

![Inline editor](https://i.imgur.com/coRGKGt.png)

* Insert **items** by name/ID;
* Insert **particles** by name;
* Insert **effects** by name/ID;
* Insert **sounds** by name;
* Insert **entities** by name;
* Insert **enchantments** by name/ID;

![Insert item](https://i.imgur.com/TbRM1L9.png)

* Convert milliseconds, seconds, minutes, hours, days to **ticks** and vice-versa;

![Tick conversion](https://i.imgur.com/o8pQhmJ.png)

* Fetch information of items, effects, entities, enchantments;
**Pro tip:** CTRL + click the game element;

![Fetch information](https://i.imgur.com/Rak3cUa.png)

* Add **variables** that are applied during previews;

![Add variables](https://i.imgur.com/Fg0FC69.png)

* View complete path of any key by hovering it;
* **Auto-save** your files (with customizable delays);
* Replace **TABs** with **spaces**;

## Writing your own add-on
Since 1.3, Chorus supports custom **JavaScript add-ons**.
Check out the official [wiki](https://github.com/iAmGio/chorus/wiki) for API documentation.
Although an official marketplace is not ready yet, you can publish your add-ons by submitting your files to the [add-ons repository](https://github.com/iAmGio/chorus-addons) following the instructions given in its README.
In order to load an add-on, place the .js file inside the `chorus/addons` folder.

## Creating your own theme
Chorus supports custom themes. If you want to create your own, create a folder into chorus/themes named as your theme's name.
In this folder, you have to create the following files:
* **{name}.css**, to style the main view;
* **{name}-highlight.css** to style keywords;
* **{name}-settings.css** to style setting view;

_Note: {name} must be the same as your folder's name._

To see the structure of a style file, take a look at this theme:
* [Main](https://github.com/iAmGio/chorus/blob/master/src/assets/styles/light.css)
* [Highlight](https://github.com/iAmGio/chorus/blob/master/src/assets/styles/light-highlight.css)
* [Settings](https://github.com/iAmGio/chorus/blob/master/src/assets/styles/light-settings.css)

If you want to make it public, you can add it to the official [themes repository](https://github.com/iAmGio/chorus-themes) following [these](https://github.com/iAmGio/chorus-themes/blob/master/README.md) guidelines.

## Downloading
Chorus is downloadable on [chorus.iamgio.eu](https://chorus.iamgio.eu).
Older versions can be found [here](https://github.com/iAmGio/chorus/releases).
Make sure you have Java 8 or above installed.

#### Windows
Download chorus-X.X.X.exe, move it to the desired installation folder and run it.

#### macOS
**ARM:** Download chorus-X.X.X-arm.app.zip
**Intel:** Download chorus-X.X.X-x86.app.zip
Extract the .app file, move it to the Applications folder and open it.

#### Linux
Download chorus-X.X.X.jar, move it to the desired installation folder and run it.

### Donating
I worked so hard on this project.
If you like this software, or just want to support me, I'd really enjoy [donations](https://paypal.me/giogar).
By donating, you'll be added to the 'Donors List' accessible from the program.

### License
Chorus and its source code are under GPL-3 license. For further information, check [LICENSE](https://github.com/iAmGio/chorus/blob/master/LICENSE).
Unauthorized distribution and/or sale are prohibited.