Configuration

Highly Customizable

The resource is highly configurable via config.lua. All settings are well-documented and easy to modify.

Quick Start

Most users can start with the default settings. Only modify what you need!

Global Settings

Setting	Description	Default
Config.Position	Where subtitles appear. Options: 'bottom', 'top'	'bottom'

Animation Settings

Config.EnableTypewriter = false      -- Enable typewriter effect (letter by letter)
Config.TypewriterSpeed = 30          -- Speed in ms per character
Config.FadeInDuration = 300          -- Fade in duration in ms
Config.FadeOutDuration = 300         -- Fade out duration in ms
Config.DisplayDuration = 5000        -- Default display time in ms
Config.DefaultAnimation = 'fade'     -- 'fade', 'slide', 'bounce', 'glow'

Avatar Settings

Avatar URLs

When using avatars, make sure to use direct image URLs (ending in .png, .jpg, .webp).

Config.EnableAvatar = true           -- Enable/disable avatar display
Config.AvatarSize = 40               -- Avatar size in pixels
Config.DefaultAvatar = ''            -- Default avatar URL (empty = no avatar)

Speaker Settings

Setting	Description	Default
Config.DefaultSpeakerColor	Default hex color for speaker names	'#ffffff'
Config.DefaultSpeakerName	Fallback name if none provided	'Unknown'

Visual Style

Config.Style = {
    background = 'rgba(0, 0, 0, 0.85)',
    borderColor = 'rgba(255, 255, 255, 0.2)',
    borderWidth = '1px',
    fontSize = '18px',
    borderRadius = '10px',
    maxWidth = '600px',           -- Maximum width of subtitle box
    maxCharsPerLine = 60          -- Characters before line break
}

Multi-Speaker Settings

Config.EnableMultiSpeaker = true          -- Allow multiple simultaneous subtitles
Config.MaxSimultaneousSubtitles = 3       -- Maximum subtitles displayed at once

CSS Values

Style options use standard CSS values. Use any valid CSS for colors, sizes, etc.