Konfiguration · FJX Studios Docs

Die Konfiguration erfolgt über die config.lua. Sie enthält alle anpassbaren Einstellungen und ist die einzige Datei, die du bearbeiten kannst.

Allgemeine Einstellungen

config.lua

lua

-- @section Allgemeine Einstellungen
Config.Debug = false               -- Debug-Modus für zusätzliche Konsolenausgaben aktivieren
Config.UseCommand = true           -- /disclaimer Befehl zum Testen aktivieren
Config.CommandName = "disclaimer"  -- Befehlsname, um den Disclaimer manuell anzuzeigen
Config.ShowOnJoin = true           -- Disclaimer anzeigen, wenn Spieler dem Server beitritt

Config.DebugbooleanStandard: false

Aktiviert detaillierte Konsolenausgaben für die Fehlersuche.

Config.UseCommandbooleanStandard: true

Aktiviert oder deaktiviert den Befehl zum manuellen Anzeigen des Disclaimers.

Config.CommandNamestringStandard: "disclaimer"

Legt den Namen des Befehls fest, mit dem der Disclaimer manuell angezeigt werden kann.

Config.ShowOnJoinbooleanStandard: true

Bestimmt, ob der Disclaimer automatisch angezeigt wird, wenn ein Spieler dem Server beitritt.

Inhaltseinstellungen

config.lua

lua

-- @section Inhaltseinstellungen
Config.Text = "Dieser Server und seine Inhalte sind nicht mit realen Behörden, Marken oder Institutionen verbunden. Alle Organisationen, Logos und Bezeichnungen werden ausschließlich zu Unterhaltungszwecken im Rahmen eines Rollenspiels angezeigt."
Config.SkipText = "Drücke LEERTASTE zum Fortfahren"
Config.Timeout = 15000        -- Dauer in ms, bevor der Disclaimer automatisch schliesst
Config.UpdateInterval = 50    -- Aktualisierungsintervall der Fortschrittsanzeige in ms

Config.Textstring

Der angezeigte Disclaimer-Text.

Config.SkipTextstring

Der Text, der dem Spieler mitteilt, wie er den Disclaimer überspringen kann.

Config.TimeoutnumberStandard: 15000

Die Zeit in Millisekunden, nach der der Disclaimer automatisch geschlossen wird. Standard: 15000 = 15 Sekunden.

Config.UpdateIntervalnumberStandard: 50

Das Intervall in Millisekunden, in dem die Fortschrittsanzeige aktualisiert wird. Niedriger = flüssiger.

Stileinstellungen

Alle Werte in diesem Abschnitt sind CSS-Werte und müssen im gültigen CSS-Format angegeben werden.

config.lua

lua

-- @section Stileinstellungen
Config.Background = {
    Color = "rgba(0, 0, 0, 0.8)",  -- Hintergrundfarbe mit Transparenz
    Blur = false,                   -- Hintergrundunschärfe aktivieren
    BlurAmount = "5px"              -- Stärke der Unschärfe, falls aktiviert
}

Config.Box = {
    Color = "rgba(20, 20, 20, 0.9)",    -- Boxhintergrundfarbe
    BorderRadius = "8px",               -- Abrundung der Boxecken
    MaxWidth = "800px",                 -- Maximale Boxbreite
    Width = "80%",                      -- Boxbreite (Prozentsatz des Bildschirms)
    Padding = "40px",                   -- Innenabstand der Box
    BoxShadow = "0 4px 20px rgba(0, 0, 0, 0.5)" -- Boxschatten
}

Config.TextStyle = {
    Color = "white",                    -- Textfarbe
    FontSize = "18px",                  -- Textgröße
    LineHeight = "1.6",                 -- Zeilenhöhe
    FontWeight = "400",                 -- Schriftstärke (normal)
    FontFamily = "'Segoe UI', Tahoma, Geneva, Verdana, sans-serif"
}

Config.ProgressBar = {
    Height = "6px",                     -- Höhe der Fortschrittsanzeige
    BackgroundColor = "rgba(255, 255, 255, 0.2)",
    BorderRadius = "3px",               -- Abrundung der Ecken
    Colors = {                          -- Farbverlauf
        Start = "#4a90e2",              -- Startfarbe
        End = "#63cdda"                 -- Endfarbe
    }
}

Config.SkipInfo = {
    Color = "rgba(255, 255, 255, 0.6)", -- Textfarbe für den Überspringshinweis
    FontSize = "14px",                  -- Schriftgröße
    MarginTop = "10px"                  -- Oberer Abstand
}

Hintergrund — `Config.Background`

Parameter	Typ	Beschreibung
`Color`	string	Hintergrundfarbe des Disclaimer-Fensters (CSS)
`Blur`	boolean	Aktiviert oder deaktiviert den Unschärfeeffekt
`BlurAmount`	string	Stärke des Unschärfeeffekts (CSS)

Box — `Config.Box`

Parameter	Typ	Beschreibung
`Color`	string	Hintergrundfarbe der Box (CSS)
`BorderRadius`	string	Abrundung der Ecken (CSS)
`MaxWidth`	string	Maximale Breite der Box (CSS)
`Width`	string	Relative Breite der Box (CSS)
`Padding`	string	Innerer Abstand der Box (CSS)
`BoxShadow`	string	Schatten der Box (CSS)

Text — `Config.TextStyle`

Parameter	Typ	Beschreibung
`Color`	string	Farbe des Disclaimer-Texts (CSS)
`FontSize`	string	Größe des Texts (CSS)
`LineHeight`	string	Zeilenhöhe (CSS)
`FontWeight`	string	Schriftstärke (CSS)
`FontFamily`	string	Schriftart (CSS)

Fortschrittsanzeige — `Config.ProgressBar`

Parameter	Typ	Beschreibung
`Height`	string	Höhe der Fortschrittsanzeige (CSS)
`BackgroundColor`	string	Hintergrundfarbe der Fortschrittsanzeige (CSS)
`BorderRadius`	string	Abrundung der Ecken (CSS)
`Colors.Start`	string	Startfarbe des Farbverlaufs (CSS)
`Colors.End`	string	Endfarbe des Farbverlaufs (CSS)

Überspringshinweis — `Config.SkipInfo`

Parameter	Typ	Beschreibung
`Color`	string	Farbe des Hinweistexts (CSS)
`FontSize`	string	Größe des Hinweistexts (CSS)
`MarginTop`	string	Oberer Abstand des Hinweistexts (CSS)

Animationen

config.lua

lua

-- @section Animationen
Config.Animations = {
    FadeOutDuration = 1000,             -- Ausblendungsdauer in Millisekunden
    ProgressBarTransition = "0.1s"      -- Übergangsgeschwindigkeit der Fortschrittsanzeige
}

Parameter	Typ	Beschreibung
`FadeOutDuration`	number	Dauer in Millisekunden, bis der Disclaimer ausgeblendet ist
`ProgressBarTransition`	string	Übergangsgeschwindigkeit der Fortschrittsanzeige (CSS)

Events

config.lua

lua

-- @section Events
Config.Events = {
    Shown = "disclaimer:shown",         -- Event beim Anzeigen des Disclaimers
    Closed = "disclaimer:closed"        -- Event beim Schliessen des Disclaimers
}

Parameter	Typ	Beschreibung
`Shown`	string	Name des Events, das beim Anzeigen ausgelöst wird
`Closed`	string	Name des Events, das beim Schliessen ausgelöst wird

Exports

config.lua

lua

-- @section Exports
Config.Exports = {
    ShowDisclaimer = "ShowDisclaimer"   -- Name der Export-Funktion
}

Parameter	Typ	Beschreibung
`ShowDisclaimer`	string	Name der Export-Funktion, mit der sich der Disclaimer anzeigen lässt

Aufruf aus einer anderen Resource:

lua

exports["fjx_disclaimer"]:ShowDisclaimer()

Vollständige config.lua

Komplette Datei anzeigen

config.lua

lua

-- @type Config
Config = {}

-- @section Allgemeine Einstellungen
Config.Debug = false -- Debug-Modus für zusätzliche Konsolenausgaben aktivieren
Config.UseCommand = true -- /disclaimer Befehl zum Testen aktivieren
Config.CommandName = "disclaimer" -- Befehlsname, um den Disclaimer manuell anzuzeigen
Config.ShowOnJoin = true -- Disclaimer anzeigen, wenn Spieler dem Server beitritt

-- @section Inhaltseinstellungen
Config.Text = "Dieser Server und seine Inhalte sind nicht mit realen Behörden, Marken oder Institutionen verbunden. Alle Organisationen, Logos und Bezeichnungen werden ausschließlich zu Unterhaltungszwecken im Rahmen eines Rollenspiels angezeigt." -- Textinhalt des Disclaimers
Config.SkipText = "Drücke LEERTASTE zum Fortfahren" -- Text für die Überspringen-Schaltfläche
Config.Timeout = 15000 -- Dauer in Millisekunden, bevor der Disclaimer automatisch geschlossen wird (Standard: 15000 = 15 Sekunden)
Config.UpdateInterval = 50 -- Aktualisierungsintervall für die Fortschrittsanzeige in Millisekunden (niedriger = flüssiger)

-- @section Stileinstellungen
Config.Background = {
    Color = "rgba(0, 0, 0, 0.8)", -- Hintergrundfarbe mit Transparenz
    Blur = false, -- Hintergrundunschärfe aktivieren
    BlurAmount = "5px" -- Stärke der Unschärfe, falls aktiviert
}

Config.Box = {
    Color = "rgba(20, 20, 20, 0.9)", -- Boxhintergrundfarbe
    BorderRadius = "8px", -- Abrundung der Boxecken
    MaxWidth = "800px", -- Maximale Boxbreite
    Width = "80%", -- Boxbreite (Prozentsatz des Bildschirms)
    Padding = "40px", -- Innenabstand der Box
    BoxShadow = "0 4px 20px rgba(0, 0, 0, 0.5)" -- Boxschatten
}

Config.TextStyle = {
    Color = "white", -- Textfarbe
    FontSize = "18px", -- Textgröße
    LineHeight = "1.6", -- Zeilenhöhe
    FontWeight = "400", -- Schriftstärke (normal)
    FontFamily = "'Segoe UI', Tahoma, Geneva, Verdana, sans-serif" -- Schriftfamilie
}

Config.ProgressBar = {
    Height = "6px", -- Höhe der Fortschrittsanzeige
    BackgroundColor = "rgba(255, 255, 255, 0.2)", -- Hintergrundfarbe der Fortschrittsanzeige
    BorderRadius = "3px", -- Abrundung der Ecken der Fortschrittsanzeige
    Colors = { -- Farbverlauf
        Start = "#4a90e2", -- Startfarbe
        End = "#63cdda" -- Endfarbe
    }
}

Config.SkipInfo = {
    Color = "rgba(255, 255, 255, 0.6)", -- Textfarbe für den Überspringshinweis
    FontSize = "14px", -- Schriftgröße für den Überspringshinweis
    MarginTop = "10px" -- Oberer Abstand für den Überspringshinweis
}

-- @section Animationen
Config.Animations = {
    FadeOutDuration = 1000, -- Ausblendungsdauer in Millisekunden
    ProgressBarTransition = "0.1s" -- Übergangsgeschwindigkeit der Fortschrittsanzeige
}

-- @section Events
Config.Events = {
    Shown = "disclaimer:shown", -- Event ausgelöst, wenn der Disclaimer angezeigt wird
    Closed = "disclaimer:closed" -- Event ausgelöst, wenn der Disclaimer geschlossen wird
}

-- @section Exports
Config.Exports = {
    ShowDisclaimer = "ShowDisclaimer" -- Name der Export-Funktion zum Anzeigen des Disclaimers
}

Allgemeine Einstellungen #

Inhaltseinstellungen #

Stileinstellungen #

Hintergrund — Config.Background #

Box — Config.Box #

Text — Config.TextStyle #

Fortschrittsanzeige — Config.ProgressBar #

Überspringshinweis — Config.SkipInfo #

Animationen #

Events #

Exports #

Vollständige config.lua #

Allgemeine Einstellungen

Inhaltseinstellungen

Stileinstellungen

Hintergrund — `Config.Background`

Box — `Config.Box`

Text — `Config.TextStyle`

Fortschrittsanzeige — `Config.ProgressBar`

Überspringshinweis — `Config.SkipInfo`

Animationen

Events

Exports

Vollständige config.lua