-
Notifications
You must be signed in to change notification settings - Fork 34
Lyrics Effect
The Lyrics effect needs a subtitle file that contains the timed lyrics of the song. For this you have to configure its SubtitlesPath
field.
Path to a .sbv
, .srt
, .ass
or .ssa
file in your project's folder. These can be made with a tool like aegisub.
The name of a system font, or the path to a font relative to your project's folder.
It is preferable to add fonts to the project folder and use their file name rather than installing fonts.
A path inside your mapset's folder where lyrics images will be generated.
The Size of the font. Increasing the font size creates larger images.
The Scale of the font. Increasing the font scale does not creates larger images, but the result may be blurrier.
The main color of the font.
Bold, italics, etc.
The size of the glow. Larger sizes are rather slow to generate.
The color of the glow.
Whether the glow is additive or not. Additive glow will require generating twice the amount of images.
The size of the outline.
The color of the outline.
The size of the shadow.
The color of the shadow.
How much extra space is allocated around the text when generating it. Should be increased when characters look cut off.
The vertical position around which lyrics are centered.
Whether to generate images per character (Recommended for a smaller mapset size), or per line (Recommended for some languages like Arabic)
Whether to remove extra transparency on the edge of the generated images. Should always be on.
Whether to only draw the glow, outline and shadow.
The origin of the lyrics sprites. Has no real effect unless you customize the effect's code.
Need help with something that isn't in the wiki? Try contacting Damnae in osu! or Discord.