Skip to content

A python script to convert karaoke subtitles into the ultrastar format.

Notifications You must be signed in to change notification settings

WarwickAnimeSoc/KaraLuxer

Repository files navigation

KaraLuxer

A python script to port songs from Karaoke Mugen to the Ultrastar file format for use with. To perform the inverse use ultrastar2ass.

As Karaoke Mugen does not feature pitch mapping, only timings will be generated by the script. Pitches can be automatically generated from the mapped file using Ultrastar Pitch (Accuracy will vary per map).

How to run

Manual

To run the script you will need Python 3.

Required packages for the script can be installed using pip install -r requirements.txt. FFMPEG must be present on the system for the script to work. You can either place a FFMPEG binary in a subfolder named tools or have it accessible on your PATH.

The script can be used from the command line via karaluxer.py or with a GUI via kl_gui.py.

Compiled Executable

Compiled executables can be found on the releases page. The executables only include the GUI.

Compiling using pyinstaller

To compile the GUI version of the program run pyinstaller kl_gui.spec. To compile correctly, a FFMPEG binary must be placed in the tools subfolder, as well as pitchnet_2020_12_14.onnx which can be found on the Ultrastar Pitch Repo

TODO

  • Improve Duet/Style support.
    • Change Duet mode to support combining styles into duet parts.
    • Change Style filter mode to support removing only specific styles.
  • Make popup UIs (Style and Line selection) more general to avoid code repetition.
    • Both popups are functionally the same, they could be combined into one.
  • Better handling of special characters.
    • Requires testing Vocaluxe to see where we can and can't include special characters (e.g. Filenames, Notes, Metadata)

About

A python script to convert karaoke subtitles into the ultrastar format.

Resources

Stars

Watchers

Forks

Contributors 4

  •  
  •  
  •  
  •  

Languages