Utiliser Loreline avec VS Code

L'application recommandée pour écrire des scripts Loreline est Loreline Writer, mais vous pouvez aussi utiliser l'extension VS Code si vous êtes déjà à l'aise avec cet éditeur.

Si vous utilisez déjà Visual Studio Code (VS Code en abrégé), l'extension Loreline vous offre la coloration syntaxique, une prévisualisation en direct de votre histoire et des outils d'édition, le tout au même endroit. VS Code est un éditeur de texte gratuit disponible sur Windows, Mac et Linux.

Si vous voulez simplement essayer Loreline sans rien installer, vous pouvez utiliser l'Atelier en ligne directement dans votre navigateur.

Capture d'écran de l'extension Loreline pour VS Code

Installer VS Code

Rendez-vous sur le site officiel de Visual Studio Code et téléchargez la version correspondant à votre système.

Ne vous laissez pas intimider par le slogan « AI code editor » de VS Code. Vous n'avez pas besoin d'utiliser de fonctionnalités liées à l'IA, et nous n'en utiliserons aucune ici. C'est simplement un éditeur de texte gratuit sur lequel notre extension Loreline fonctionne.

Télécharger VS Code →

Ouvrez l'installateur et suivez les instructions. Une fois installé, lancez VS Code. Vous devriez voir un écran d'accueil.

Installer l'extension Loreline

Ajoutons maintenant le support de Loreline à VS Code :

  1. Cliquez sur l'icône Extensions dans la barre latérale gauche (elle ressemble à quatre petits carrés).
  2. Dans la barre de recherche en haut, tapez Loreline.
  3. Cliquez sur Installer sur l'extension Loreline.

C'est tout ce qu'il y a à faire. VS Code sait désormais travailler avec les fichiers .lor. L'extension suit la langue d'affichage de VS Code, en anglais ou en français.

Juste au dessus, la vidéo montre pas à pas comment installer l'extension VS Code de Loreline. On peut voir qu'avant installation, VS Code ne reconnait pas la syntaxe du fichier .lor, et qu'une fois Loreline installé, la coloration syntaxique apparaît, et on peut même appuyer sur l'icône ▶ (Play) pour jouer le script !

Vous pouvez aussi retrouver l'extension sur le VS Code Marketplace.

Créer votre premier fichier .lor

Vérifions que tout fonctionne :

  1. Dans VS Code, ouvrez un dossier où vous souhaitez garder vos scripts : Fichier → Ouvrir un dossier.
  2. Dans la barre latérale gauche, faites un clic droit et choisissez Nouveau fichier. Nommez-le par exemple MonHistoire.lor.
  3. Tapez quelques lignes, par exemple :
barista: Salut ! Comment ça va aujourd'hui ?

Le texte devrait s'afficher en couleurs. Cela signifie que l'extension fonctionne.

Pour apprendre le langage Loreline, rendez-vous dans le Guide d'écriture. Il vous accompagnera pas à pas.

Fonctionnalités

Vérifier vos scripts

Pendant que vous écrivez, l'extension lit tout votre script, avec les fichiers qu'il importe, et relève les erreurs avant même que vous le jouiez : un nom déclaré nulle part, un beat qui n'existe pas, une fonction que l'application qui fait tourner l'histoire ne fournit pas, un beat auquel rien ne mène. Survolez le texte souligné pour voir ce qui ne va pas. Quand une correction existe, une ampoule apparaît : cliquez dessus, ou appuyez sur Ctrl+. (Cmd+. sur Mac), pour l'appliquer. Par exemple, une faute de frappe comme $gol propose de la remplacer par $gold, ou de déclarer gol dans votre state.

Déclarer ce que le script utilise

Les vérifications reposent sur une règle simple : tout ce que votre script utilise est déclaré quelque part, dans le script, dans un fichier qu'il importe, ou par Loreline.

Désactiver des vérifications

Un commentaire qui commence par // @ change les vérifications pour une ligne, un fichier, ou un fichier et tout ce qu'il importe :

// @ignore-all unreachable-beat
// @ignore-in-file unknown-name

beat Start
  // @ignore unknown-name
  L'application renseigne $playerName avant cette ligne.

@ignore désactive une vérification, @check l'active, et @hint, @info, @warn ou @error choisissent son niveau. Le nom d'une vérification est celui affiché avec le problème, par exemple unknown-name. Sans nom, une directive s'applique à toutes les vérifications.

Configuration

Tous les paramètres se trouvent sous l'espace de noms loreline dans VS Code. Ouvrez les Paramètres (Ctrl+,) et recherchez « loreline ».

Décorations visuelles

Paramètre Description
loreline.enableChoiceDecoration Active les décorations visuelles sur les lignes d'options de choix.
loreline.enableChoiceBackground Affiche une couleur de fond sur les lignes d'options de choix.
loreline.enableChoiceColor Applique une couleur de texte aux lignes d'options de choix.
loreline.choiceBackgroundColor Couleur de fond personnalisée pour les options de choix (hex).
loreline.choiceTextColor Couleur de texte personnalisée pour les options de choix (hex).
loreline.enableTextStatementDecoration Active le style sur les lignes de texte narratif.
loreline.textStatementItalic Affiche le texte narratif en italique.
loreline.textStatementColor Couleur pour les lignes de texte narratif.
loreline.pluralPipeColor Couleur pour le séparateur pipe dans les expressions plurielles.
loreline.textStatementEscapeColor Couleur des échappements (\x, $$, ##) dans le texte narratif.
loreline.textStatementTagColor Couleur du contenu des tags dans le texte narratif.
loreline.choiceMarkupColor Couleur des échappements et du contenu des tags dans les options de choix.
loreline.whenBackgroundColor Couleur de fond des en-têtes de règles when.
loreline.whenOncePrefixColor Couleur du - des règles when jouées une seule fois.

Quand un réglage de couleur est laissé vide, l'extension choisit une valeur par défaut adaptée au thème actif. Une valeur personnalisée s'applique aux deux thèmes, clair et sombre.

Prévisualisation

Paramètre Description
loreline.previewAutoOpenImportedFiles Quand la prévisualisation exécute du code dans un fichier .lor importé, ce fichier est automatiquement ouvert dans l'éditeur. Désactivez si vous préférez ne pas ouvrir des fichiers automatiquement.
loreline.previewLineDelay (bientôt disponible) Délai en millisecondes avant que la prévisualisation passe à la ligne de dialogue ou de narration suivante (600 par défaut). Mettez 0 pour afficher le texte instantanément jusqu'au prochain choix.
loreline.previewWaitForClick Si activé, chaque ligne de dialogue ou de narration dans la prévisualisation attend un clic pour continuer, au lieu d'avancer automatiquement.

Vérifications

Réglage Description
loreline.analysis.enabled Vérifie les scripts pendant l'écriture. Activé par défaut.
loreline.analysis.onType Vérifie pendant la frappe, et pas seulement à l'ouverture ou à l'enregistrement d'un fichier.
loreline.analysis.strict Signale les noms déclarés nulle part comme des erreurs, comme // @error-all unknown-name, undeclared-assignment.
loreline.analysis.translations Vérifie aussi les clés de traduction.
loreline.analysis.rules L'affichage de chaque vérification, par son nom, par exemple { "unreachable-beat": "off" }. Les directives des scripts l'emportent sur ce réglage.

Pour aller plus loin