Aller au contenu

Référence des réglages

Libretto expose sa configuration à travers plusieurs pages de Project Settings (et quelques pages de Editor Preferences pour les comportements locaux à la machine). Chaque page est adossée à une classe de réglages dans le code source du plugin. Cette référence liste, par classe, les propriétés configurables avec leur nom réel, leur signification et leur valeur par défaut fournie.

Où résident réellement les valeurs par défaut d'un plugin

Unreal ne fusionne qu'un seul fichier ini pour un plugin : son Default<PluginName>.ini. Pour Libretto, ce fichier est Config/DefaultLibretto.ini. Un config nommé d'après un sous-module (par exemple DefaultSequenceGenerator.ini ou DefaultTextToSpeech.ini) ne serait jamais chargé. C'est pourquoi plusieurs classes de réglages Libretto déclarent Config = "Libretto" bien qu'elles résident dans des modules différents — afin que leurs valeurs par défaut fournies soient lues depuis DefaultLibretto.ini comme tout autre réglage Libretto.

Concrètement, des valeurs par défaut telles que ProjectCameraRules (Sequence Generator) et les DefaultTTSCulture / MSVoiceCharacterTable de MSVoice (Text To Speech) sont définies dans DefaultLibretto.ini, et non dans les initialiseurs de header. Toutes peuvent être surchargées par projet depuis la page Project Settings correspondante ; les surcharges de votre projet sont écrites dans le Config/DefaultGame.ini de votre projet (ou l'ini par projet approprié).

Les valeurs par défaut dans les tableaux ci-dessous

« Default » est la valeur utilisée lorsque rien ne la surcharge. Lorsque la valeur par défaut effective provient de DefaultLibretto.ini plutôt que de l'initialiseur C++, cela est signalé dans la ligne.


Project Settings ▸ Libretto

Adossée à ULBRDialogueCoreSettings (module LBRCore). Les réglages globaux du plugin : où résident les dialogues et les assets générés, les règles de priorité/volume à l'exécution, les flags par défaut, les classes d'UI et les extenders du panneau de détails.

Chemins

Property Signification Default
DialoguesDirectory Dossier racine contenant les dialogues qui sont générés et livrés dans le jeu (les dialogues peuvent résider dans des sous-dossiers). /Game/Dialogues
AdditionalDialogueScanRoots Racines de contenu supplémentaires (points de montage, par ex. /MyPlugin) scrutées à la recherche de dialogues au démarrage, en plus du plugin Libretto et de /Game. Définissez cette valeur si vous conservez des dialogues dans votre propre plugin, afin que leurs gameplay tags soient générés au démarrage. Un plugin peut auto-enregistrer sa propre racine via son Config/DefaultLibretto.ini (+AdditionalDialogueScanRoots=/MyPlugin). (vide — aucun scan supplémentaire)
GeneratedSequencesDirectory Dossier où le générateur écrit les Level Sequences. /Game/Libretto/DialogueSequences
GeneratedTempSequencesDirectory Dossier pour les Level Sequences des dialogues hors du Dialogues Directory. /Game/Libretto/DialogueSequences/TEMP_DIALOGUES
TextToSpeechDirectory Dossier où le générateur recherche les répliques vocales générées par TTS. /Game/Libretto/TextToSpeech
VoiceLinesDirectory Dossier où le générateur recherche les répliques vocales de dialogue. /Game/Libretto/Voices
LipSyncDirectory Dossier dans lequel vous placez les animations de LipSync. /Game/Libretto/LipSync

Exécution

Property Signification Default
DefaultPosture Descripteur de posture par défaut utilisé pour tous les personnages. /Libretto/Postures/PDA_LBRRelaxed
DialoguePriorities Liste ordonnée des classes de priorité de dialogue du projet (la prio 0 l'emporte sur la prio 1). vide dans le header ; DefaultLibretto.ini fournit BP_DialoguePriority_Cinematic, _Stage, _3C.
DialoguePrioritiesRelations Relations entre les catégories de priorité. (vide)
RuntimeFlagsToVolumeModifier Modificateurs de volume par flag d'exécution (Default / Animation / Voice). Le volume est rafraîchi manuellement via RefreshAudioVolume sur la DialogueInstance (au démarrage, ou lors d'un passage en muffled/muted). Muffled → 0.1 / 0.1 / 0.1 ; Muted → 0 / 0 / 0

Flags par défaut

Property Signification Default
DefaultSubdialogueFlags Flags appliqués à chaque subdialogue sauf s'il porte Libretto.Flags.Subdialogue.NoDefault. (aucun défini)
DefaultLineFlags Flags appliqués à chaque réplique sauf si elle porte Libretto.Flags.Lines.NoDefault. (aucun défini)

UI

Property Signification Default
WidgetChoiceDefaultClass Widget de Choice créé lorsqu'un Choice n'a aucun flag. (header : non défini ; DefaultLibretto.ini définit DefaultLBRDialogueChoiceWidget_WBP)
WidgetChoiceMapClass Table associant flag de Choice → classe de widget de choix, créée lorsque les flags du Choice correspondent. (vide)
WidgetSubtitleClass Classe de widget de sous-titre (doit implémenter LBRDialogueSubtitle). (header : non défini ; DefaultLibretto.ini définit LBRSimpleSubtitleWidget)

Document

Property Signification Default

Localisation

Property Signification Default
BaseCulture La culture depuis laquelle la plupart des cultures étrangères sont traduites. Peut être la culture native, ou vide. en
LocalizationTargetNamesToCheckDuplicate Cibles de localisation vérifiées pour les doublons. (vide)

Audio

Property Signification Default
AudioAssetClass Abstraction des fichiers d'assets audio, pour prendre en charge différents moteurs audio. LBRUnrealAudioAsset

Extenders

Property Signification Default
LinePropertiesExtender Classe étendant le panneau de détails des lignes avec des métadonnées supplémentaires. (non défini)
SubdialoguePropertiesExtender Classe étendant le panneau de détails des subdialogues. (non défini)
DialoguePropertiesExtender Classe étendant le panneau de détails des dialogues. (non défini)

Appliquer un changement d'Extender

Après avoir modifié un Extender, fermez puis rouvrez tout Dialogue ouvert pour que les nouvelles propriétés apparaissent.

Éditeur

Property Signification Default
ToolbarWidgetsFolderDirectory Les enfants directs de type Editor Utility Widget dans ce dossier sont ajoutés au menu déroulant de la barre d'outils Libretto. /Libretto/Tools/ToolbarWidgets

Editor Preferences ▸ Libretto (local)

Adossée à ULBRDialogueCoreLocalSettings (module LBRCore). Locale à la machine, non partagée via le contrôle de source (conteneur Editor).

Property Signification Default
bLogDebug Active les logs de débogage de Libretto. false
bSynchronizeSourceControlOnRenamedAudioAndLipSync Lors du renommage d'un Dialogue, synchronise aussi le contrôle de source sur ses fichiers audio et LipSync. Peut être très lent. true

Project Settings ▸ Libretto – Sequence Generator

Adossée à ULBRSequenceGeneratorSettings (module LBRSequenceGenerator). Contrôle la façon dont les séquences de dialogue et les caméras sont générées. Déclare Config = "Libretto" afin que ses valeurs par défaut se chargent depuis DefaultLibretto.ini (voir l'encadré d'information ci-dessus).

Property Signification Default
SequenceDirectorClass Classe Sequence Director utilisée pour générer et jouer les séquences de dialogue. LBRSequenceDirector
bCreateLoopSequences Si vrai, les choix sont suivis d'une séquence en boucle. true
ProjectCameraRules Preset de règles de caméra par défaut (une ligne de DataTable LBRCameraRulesPreset) utilisé lors de la génération des caméras d'une séquence. header : non défini (→ caméras aléatoires) ; DefaultLibretto.ini définit la ligne BasePreset de DT_CameraRulesPresets. Surchargeable par stage (CameraRulesStageOverride) ou par instance.
MinShotLength Longueur minimale d'un plan de caméra généré (secondes). 2.0
MaxShotLength Longueur maximale d'un plan de caméra généré (secondes). 9.0
FolderNamesToSave Noms de sous-dossiers non nettoyés lors de la régénération d'une séquence. VFX, Audio
SequenceColors Couleurs utilisées par les sous-séquences affichées dans Sequencer. 5 couleurs (violet, bleu, marron, olive, jaune)
LipSyncSubsystemName Nom du sous-système LipSync à utiliser. (vide)
bAutoComputeSequenceTimes Lors de la mise à jour des frames marquées par ID, redimensionne aussi toutes les durées de sous-séquences pour épouser leurs sections. true
TrackGenerators Classes générant les pistes de Sequencer. Générateurs de pistes Animation, Audio, Camera, Event, LipSync, Subtitle
AssetGenerators Classes générant les assets (voix, anims…). Générateurs MSVoice, ElevenLabs
VoskModelPath Vosk Model Folder (Word Analysis) : dossier du modèle de reconnaissance vocale vosk qui cale les gestes sur les mots-clés, absolu ou relatif au projet. Vide = calage ignoré. vosk est optionnel et installé par vos soins — voir Gestes calés sur les mots-clés. (vide)

Project Settings ▸ Libretto – Text To Speech

Adossée à ULBRTextToSpeechSettings (module LBRTextToSpeechEditor). Configure les fournisseurs TTS. Déclare Config = "Libretto" afin que les valeurs par défaut de MSVoice se chargent depuis DefaultLibretto.ini ; les tokens d'API restent vides et sont définis par projet.

Property Signification Default
TextToSpeechSubsystem Nom du sous-système Text To Speech à utiliser (choisi parmi GetTTSOptions). (vide)
ElevenLabsAPIToken Votre token d'API ElevenLabs — requis pour utiliser votre propre quota de personnages. (Avancé.) ""
CharacterVoicesTable DataTable associant chaque personnage à une voix ElevenLabs. (non défini)
DefaultTTSCulture Langue/locale par défaut pour l'audio MSVoice (API vocale Windows) généré lorsqu'une ligne de personnage n'en spécifie pas. Détermine à la fois la sélection de voix et la langue parlée (par ex. en-US, fr-FR). en-US (également défini dans DefaultLibretto.ini)
MSVoiceCharacterTable DataTable (lignes de FLBRMSVoiceCharacterDesc) associant chaque personnage à une voix Windows / langue / prosodie pour le générateur MSVoice. Laissez non défini pour choisir automatiquement une voix par personnage selon le genre + la culture par défaut. header : non défini ; DefaultLibretto.ini pointe vers le contenu d'exemple DT_MSVoices (une soft ref livrée avec le plugin).

Project Settings ▸ Libretto – GPVars

Adossée à ULBRGPVarSettings (module LBRTags). Amorce l'arbre des GPVar au démarrage.

Property Signification Default
DefaultGPVarsNodes Nœuds GPVar par défaut (table de FGPTagPath → FGPVarNode) créés pour le projet. (vide)

Il existe aussi un compagnon local à la machine, ULBRGPVarLocalSettings (Editor Preferences ▸ Libretto – GPVars), avec la même table DefaultGPVarsNodes pour les valeurs par défaut purement locales.


Project Settings ▸ Libretto – Asset Management

Adossée à ULBRAssetManagementSettings (module LBRFoundation). Conventions de préfixe de nommage utilisées par l'outillage de gestion des assets.

Property Signification Default
PersistentLevelPrefix Préfixe attendu sur les niveaux persistants (map). header : vide ; DefaultLibretto.ini définit MAP_
SubLevelPrefix Préfixe attendu sur les sous-niveaux. header : vide ; DefaultLibretto.ini définit L_

Note

La table complète des préfixes par classe (PrefixByClassName, par ex. BP_, DT_, M_…) est une table plus large définie dans DefaultLibretto.ini et consommée via GetAllPrefixes / GetPrefixes. Elle n'est pas exposée ici comme propriété individuelle de Project Settings.


Project Settings ▸ Libretto – Dialogue Editor

Adossée à ULBRDialogueEditorSettings (module LBRDialogueEditor). Règles de format automatiques et configuration du texte enrichi de l'aperçu.

Property Signification Default
RuleByCulture Table culture → data asset LBRFormatRules. Ajoutez une entrée par langue pour appliquer les règles de format automatiques de cette langue. (vide)
RulesWithoutCulture Un data asset LBRFormatRules appliqué quelle que soit la culture. (non défini)
RichTextDecoratorClasses Classes de décorateurs de texte enrichi utilisées par le panneau Text Preview. (vide)
RichTextStyleSet Jeu de styles de texte enrichi (une DataTable RichTextStyleRow) pour le panneau Text Preview. (non défini)

Voir aussi

La création des règles de format et l'aperçu en texte enrichi sont traités dans Dialogue Editor ▸ Automatic format rules.


Editor Preferences ▸ Libretto – Dialogue Editor (local)

Adossée à ULBRDialogueEditorLocalSettings (module LBRDialogueEditor). Comportement de l'éditeur local à la machine : déclencheurs de vérification orthographique, aides à l'édition et couleurs du Dialogue Editor. Rechercher « Dialogue Editor » dans les Editor Preferences vous permet aussi de réassigner le raccourci clavier de chaque commande.

Vérificateur orthographique

Property Signification Default
bLaunchCheckSpellerAtModification Lance le vérificateur orthographique sur une ligne à mesure qu'elle est modifiée. true
bLaunchCheckSpellerAtStart Lance le vérificateur orthographique sur l'ensemble du dialogue à son ouverture. false

Édition

Property Signification Default
bCreateElseWithIf Crée automatiquement une ligne ELSE lors de la création d'une ligne IF. true
bOpenSubdialogueOnDoubleClick Si vrai, ouvrir un subdialogue nécessite un double-clic ; si faux, un simple clic. false

Couleurs

Property Signification Default
bUseCustomColors Utilise les couleurs ci-dessous au lieu des couleurs par défaut d'Unreal. true
KeyWord Couleur des mots-clés (IF, REPLY…). S'applique même avec les couleurs par défaut d'Unreal. (221, 221, 221)
TextHighlight Couleur du texte surligné. (0, 0, 8)
TextCharacter1 Couleur du premier personnage. (255, 211, 114)
TextCharacter2 Couleur du deuxième personnage. (6, 214, 160)
TextCharacter3 Couleur du troisième personnage. (242, 92, 84)
TextCharacter4 Couleur du quatrième personnage. (186, 165, 255)
TextCharacter5 Couleur du cinquième personnage. (112, 244, 137)
TextCharacterNone Couleur lorsqu'une ligne n'a aucun personnage. (255, 0, 255)
ConditionLabel Couleur du label d'une condition. (119, 177, 255)
ActionLabel Couleur du label d'une action. (119, 177, 255)
TreeGotoDestination Arrière-plan de la destination d'un GoTo lorsqu'une ligne GoTo est sélectionnée. (8, 8, 8)
TreeSameSequence Arrière-plan des lignes de la même séquence que la ligne sélectionnée. (4, 4, 4)
TreeWarning Arrière-plan des lignes portant un avertissement. (90, 0, 0, 128)
PlayingAudio Arrière-plan de la ligne dont l'audio est en cours de lecture. (32, 84, 51, 128)
ShouldNotBeDisplayed Couleur de repli pour tout ce qui ne devrait pas être affiché. (255, 0, 255)

Priority Editor

Property Signification Default
DialoguePriorityContextTagGroups Groupes de tags de contexte disponibles pour l'éditeur de priorités (chacun avec un flag CanHaveNone). Groupe NPC-in-both (CanHaveNone = true) ; groupe Player-in-both/new/running (CanHaveNone = false)
DialoguePriorityGridTitleHeaderCellBackgroundColor Grille de priorités — arrière-plan de la cellule d'en-tête de titre. quasi-noir (0.0103…)
DialoguePriorityGridTitleHeaderCellForegroundColor Grille de priorités — avant-plan de la cellule d'en-tête de titre. gris (0.521…)
DialoguePriorityGridPriorityHeaderCellBackgroundColor Grille de priorités — arrière-plan de la cellule d'en-tête de priorité. gris foncé (0.130…)
DialoguePriorityGridPriorityHeaderCellForegroundColor Grille de priorités — avant-plan de la cellule d'en-tête de priorité. quasi-noir (0.0103…)
DialoguePriorityGridContextHeaderCellBackgroundColor Grille de priorités — arrière-plan de la cellule d'en-tête de contexte. gris (0.198…)
DialoguePriorityGridContextHeaderCellForegroundColor Grille de priorités — avant-plan de la cellule d'en-tête de contexte. quasi-noir (0.0103…)
DialoguePriorityOutcomesColors Couleur d'arrière-plan par issue (indexée par ELBRDialoguePriorityOutcome). une couleur par issue (Default, Play, PlayMuffled, PlayMuted, Interrupt, Muffle, Mute, Ignore, Pause)
DialoguePriorityOutcomesForegroundColors Couleur de texte par issue, dessinée par-dessus la couleur d'issue. une couleur par issue
DialoguePriorityOutcomesIcons Texture d'icône par issue. textures T_PriorityOutcome_* sous /Libretto/Tools/Textures (Default n'en a aucune)