Utiliser le CLI de Loreline
Le CLI de Loreline est un petit outil en ligne de commande qui travaille sur vos fichiers .lor. Il vous permet de jouer une histoire directement dans votre terminal, de préparer les fichiers de traduction ou encore de donner à votre histoire un identifiant reconnu par les archives de fiction interactive.
Vous cherchez comment écrire vos histoires ? L'application recommandée est Loreline Writer, et l'extension VS Code est une autre option si vous utilisez déjà VS Code. Le CLI sert à jouer vos histoires et à automatiser quelques tâches autour d'elles.
Installer le CLI
Téléchargez l'archive correspondant à votre système (v0.11.0) :
Décompressez cette archive. L'outil est le fichier loreline (loreline.exe sous Windows), à la racine. Vous y trouverez aussi un dossier cpp, qui ne sert qu'à utiliser Loreline depuis C++ : vous pouvez l'ignorer.
Ouvrez un terminal dans le dossier où vous avez décompressé l'archive, et vérifiez que tout fonctionne :
# macOS et Linux
./loreline version
# Windows
loreline.exe version
La commande affiche la version de Loreline.
Les exemples qui suivent sont écrits
loreline .... Si vous lancez l'outil depuis son dossier, tapez./loreline ...sur macOS et Linux. Vous pouvez aussi ajouter ce dossier à votrePATH, pour quelorelinefonctionne depuis n'importe où.
Avec haxelib
Si vous avez déjà installé Haxe, vous pouvez aussi récupérer le CLI avec haxelib :
haxelib install loreline
haxelib run loreline play CoffeeShop.lor
Toutes les commandes de ce guide fonctionnent de la même façon, avec haxelib run loreline à la place de loreline.
Jouer une histoire
Pour jouer une histoire dans votre terminal :
loreline play CoffeeShop.lor
L'histoire démarre à son premier beat. La narration et les dialogues s'affichent ligne par ligne, et quand l'histoire arrive à un choix, les options sont numérotées :
Une odeur de café flotte dans la salle.
Barista: Salut ! Qu'est-ce que je te sers ?
1. Un espresso, s'il te plaît.
2. Juste de l'eau, merci.
>Tapez le numéro d'une option et appuyez sur Entrée pour la choisir. L'histoire continue jusqu'à sa fin.
Les options dont la condition est fausse sont masquées. Pour les voir quand même, ajoutez --show-disabled : elles s'affichent en gris et peuvent être choisies. C'est pratique pour vérifier une branche sans avoir à préparer l'état qui la débloque.
loreline play CoffeeShop.lor --show-disabled
Traduire une histoire
loreline translate ajoute des clés de traduction à votre script et crée les fichiers de traduction :
loreline translate CoffeeShop.lor --auto-ids
loreline translate CoffeeShop.lor --lang en
Toute la démarche est expliquée dans le guide de localisation.
Donner un IFID à votre histoire
Un IFID est l'identifiant unique d'une œuvre de fiction interactive. Les archives et catalogues comme l'IFDB s'en servent pour distinguer les histoires. Loreline le range dans le bloc de métadonnées de votre script.
Pour donner un nouvel IFID à votre histoire :
loreline ifid CoffeeShop.lor
Loreline crée l'IFID, l'écrit dans le bloc metadata (en ajoutant le bloc en haut du fichier s'il n'existe pas encore), puis l'affiche. Le reste du fichier reste tel que vous l'avez écrit.
Si votre histoire a déjà un IFID, par exemple venant d'une version précédente faite avec un autre outil, donnez-le pour le garder :
loreline ifid CoffeeShop.lor 448E73DF-2D2F-47E7-A494-A46B40D4CFB3
Et pour simplement afficher un nouvel IFID, sans modifier aucun fichier :
loreline ifid
Pour les développeuses et développeurs
Quelques commandes s'adressent à celles et ceux qui construisent des outils ou des jeux autour de Loreline.
Exporter un script en JSON
Pour afficher le script tel que Loreline le lit (beats, choix, lignes, etc.) en JSON, pour les outils qui ont besoin de la structure d'une histoire :
loreline json CoffeeShop.lor
Lancer le serveur de langage
Pour lancer le serveur de langage de Loreline, qui permet d'ajouter suggestions, vérifications et infos au survol à tout éditeur compatible avec le Language Server Protocol :
loreline lsp
Pour aller plus loin
- Guide d'écriture : apprenez le langage de script Loreline depuis zéro.
- Localisation : traduisez vos histoires dans d'autres langues.
- Utiliser Loreline avec VS Code : écrivez vos scripts avec prévisualisation en direct et vérification des erreurs.