Skip to content
Damnae edited this page Feb 17, 2023 · 7 revisions

Minimal configuration

The Lyrics effect needs a subtitle file that contains the timed lyrics of the song. For this you have to configure its SubtitlesPath field.

Configurable fields

SubtitlesPath

Path to a .sbv, .srt, .ass or .ssa file in your project's folder. These can be made with a tool like aegisub.

FontName

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.

SpritesPath

A path inside your mapset's folder where lyrics images will be generated.

FontSize

The Size of the font. Increasing the font size creates larger images.

FontScale

The Scale of the font. Increasing the font scale does not creates larger images, but the result may be blurrier.

FontColor

The main color of the font.

FontStyle

Bold, italics, etc.

GlowRadius

The size of the glow. Larger sizes are rather slow to generate.

GlowColor

The color of the glow.

GlowAdditive

Whether the glow is additive or not. Additive glow will require generating twice the amount of images.

OutlineThickness

The size of the outline.

OutlineColor

The color of the outline.

ShadowThickness

The size of the shadow.

ShadowColor

The color of the shadow.

Padding

How much extra space is allocated around the text when generating it. Should be increased when characters look cut off.

SubtitleY

The vertical position around which lyrics are centered.

PerCharacter

Whether to generate images per character (Recommended for a smaller mapset size), or per line (Recommended for some languages like Arabic)

TrimTransparency

Whether to remove extra transparency on the edge of the generated images. Should always be on.

EffectsOnly

Whether to only draw the glow, outline and shadow.

Origin

The origin of the lyrics sprites. Has no real effect unless you customize the effect's code.

Clone this wiki locally