Skip to content

Latest commit

 

History

History
119 lines (82 loc) · 5.29 KB

README.md

File metadata and controls

119 lines (82 loc) · 5.29 KB
Raw

Banner

Downloads Release GitHub 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 editor, created for anyone who works on Spigot-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

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

Chat preview

GUI preview

Animated text preview

  • Use autocompletion to insert elements quicker;

Autocompletion

  • Quickly show colored text;

Quick preview

  • Insert colored text via an editor;

Inline editor

  • 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

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

Tick conversion

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

Fetch information

  • Add variables that are applied during previews;

Add variables

  • 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 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 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:

If you want to make it public, you can add it to the official themes repository following these guidelines.

Downloading

Chorus is downloadable on chorus.iamgio.eu.
Older versions can be found here.
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.
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.
Unauthorized distribution and/or sale are prohibited.