https://github.com/ultrastar-deluxe/format

UltraStar Format Specification
https://github.com/ultrastar-deluxe/format

composer karaoke performous singstar specification standardization ultrastar ultrastardeluxe ultrastardx ultrastarplay versioning vocaluxe yass

Last synced: 2 days ago
JSON representation

UltraStar Format Specification

• Host: GitHub
• URL: https://github.com/ultrastar-deluxe/format
• Owner: UltraStar-Deluxe
• License: mit
• Created: 2023-08-28T19:33:13.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-11-08T14:40:46.000Z (6 days ago)
• Last Synced: 2024-11-08T15:34:27.970Z (6 days ago)
• Topics: composer, karaoke, performous, singstar, specification, standardization, ultrastar, ultrastardeluxe, ultrastardx, ultrastarplay, versioning, vocaluxe, yass
• Homepage: https://usdx.eu/format
• Size: 5.51 MB
• Stars: 12
• Watchers: 11
• Forks: 2
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# UltraStar Format Specification

This specification contains a set of rules and requirements that dictate what an UltraStar textfile is and how each item should be interpreted.

## The problem

The idea for this specification came up within the [UltraStar* Creators Community Discord](https://discord.gg/tNEXZw2QJX) as we've been roaming free following some guidelines posted at many places on the internet for over a decade.

Many programs (creator software, website hosts and karaoke software) try their best effort to support the respective tags and NoteTypes to support all the features we want. But it's been long enough and we need to standardize things to sustain the future of our precious format.

Currently there are thousands of textfiles laying around unversioned and some with problematic tags which are hard to comprehend or built support for.

There are several communities out there who do not talk to eachother so it's hard to come up with a definitive system. Let's bond together and see if we can make the best out of this format we all love.

## The endgoal

The endgoal for this project would be to:

* [ ] Bring the different communities on par with eachother to increase the quality of the produced textfiles

* [ ] Versionise the format so we can improve and add features to it

* [ ] Give each Tag or NoteType a definition and how it should be working

## Involved parties

Since the text format was introduced a little bit more than a decade ago alot of projects got to know and support it.

We'd like to give these projects a little bit of appreciation by linking to their respective GitHub page or website.

### Karaoke software

* [UltraStar Online](http://ultrastaronline.com/)

* [UltraStar Deluxe](https://github.com/UltraStar-Deluxe/USDX)

* [Performous](https://github.com/performous/performous)

* [UltraStar World Party](https://github.com/ultrastares/ultrastar-worldparty)

* [Vocaluxe](https://github.com/Vocaluxe/Vocaluxe)

* [MyLittleKaraoke](https://www.mylittlekaraoke.com/)

* [UltraStar Play / Melody Mania](https://github.com/UltraStar-Deluxe/Play)

### UltraStar Song Creator software

* [Yass](https://github.com/SarutaSan72/Yass)

* [Yass Reloaded](https://github.com/DoubleDee73/Yass)

* [Composer](https://github.com/performous/composer)

* [Karedi](https://github.com/Nianna/Karedi)

* [UltraStar Creator](https://github.com/UltraStar-Deluxe/UltraStar-Creator)

* [UltraSinger](https://github.com/rakuri255/UltraSinger)

### UltraStar Textfiles hosting

* [USDB](https://usdb.animux.de)

* [UltraStar-ES](http://ultrastar-es.org/)

### Management Software

* [USDB Syncer](https://github.com/bohning/usdb_syncer)

* [UltraStar Manager](https://github.com/UltraStar-Deluxe/UltraStar-Manager)