JDR-Bot

Outils pour utilisateurs

Outils du site

Piste : • objets • linter-export • syntaxe-base • variables
fr:yaml:options

Différences

Ci-dessous, les différences entre deux révisions de la page.

Lien vers cette vue comparative

Les deux révisions précédentesRévision précédente
Prochaine révision		Révision précédente
fr:yaml:options [2026/08/31 21:23] – Wiki : fins de pages homogènes, liens Discord retirés cyrilfiestafr:yaml:options [2026/10/18 23:53] (Version actuelle) – Relecture 4.17 : clarifications, exemples et typographie cyrilfiesta
Ligne 4: Ligne 4:
  
 ===== En-tête du scénario ===== ===== En-tête du scénario =====
- 
-L'en-tête YAML contient les paramètres globaux du scénario. Voici les clés disponibles : 
  
 <code yaml> <code yaml>
-titre: "Mon Scénario · v1.0 · (v_nbparties_o_v parties)"+id: mon-scenario 
 +langue: fr 
 +titre: "Mon scénario"
 description: | description: |
-  Une description libre affichée au survol de la carte scénario +  Description affichée dans le catalogue et dans le standalone. 
-  et dans le header de l'export standalone.+categorie: fiction 
 +tags-scenario: [aventure, humour]
 markdown: none markdown: none
 </code> </code>
  
-⚠ Ne pas utiliser ''|'' dans le titre - utiliser ''·'' ou ''—''.+''id:'' identifie durablement le scénario. Il devient obligatoire avec les [[fr:yaml:succes|succès]] ou les [[fr:yaml:variables|variables persistantes ''_p'']]. Une traduction garde le même ID pour partager sa progression. 
 + 
 +''langue:'' vaut ''fr'' ou ''en''. Les dossiers officiels ''scenarios/'' et ''scripts/'' déterminent déjà leur langue sans avoir besoin d'ouvrir chaque fichier, mais cette clé est utile pour un scénario importé ou hébergé ailleurs. 
 + 
 +''categorie:'' accepte ''fiction'', ''escape-game'', ''tutoriel'', ''exemple'' ou ''divers''. ''tags-scenario:'' est une liste libre utilisée notamment par les statistiques et les succès globaux. 
 + 
 +Ne mettez pas ''<nowiki>|</nowiki>'' dans le titre : ce caractère sert de séparateur dans le catalogue.
  
 ===== markdown: ===== ===== markdown: =====
- 
-Contrôle le rendu global du texte de toutes les salles : 
  
 ^ Valeur ^ Rendu ^ ^ Valeur ^ Rendu ^
-| ''fix'' | Bloc monospace - défaut si absent | +| ''fix'' | Bloc monospace | 
-| ''none'' | Texte brut |+| ''none'' | Texte normal avec formatage en ligne |
 | ''bold'' / ''italic'' / ''quote'' | Style global | | ''bold'' / ''italic'' / ''quote'' | Style global |
-| ''story'' | Active les blocs sémantiques narratifs | +| ''story'' | Blocs narratifs | 
-| ''py'' / ''yaml'' / ''js'' / … | Bloc code coloré | +| ''py'' / ''yaml'' / ''js'' / ... | Bloc de code coloré |
- +
-===== Style global (taille, police, fond) =====+
  
-Ces valeurs servent de défaut à tous les textes web/desktop. Chaque salle peut les remplacer localement :+===== Style global =====
  
 <code yaml> <code yaml>
Ligne 39: Ligne 42:
 </code> </code>
  
-===== options: - boutons permanents =====+Ces valeurs servent de défaut aux textes Web et Desktop. Une salle peut les remplacer.
  
-Le bloc ''options:'' définit des boutons affichés en permanence dans la **toolbar** (en haut du jeu, pas dans les choix de navigation) :+===== options: - boutons permanents =====
  
 <code yaml> <code yaml>
 options: options:
-  rafraichir: "🔄"      # réaffiche la salle courante +  rafraichir: "Rafraîchir" 
-  inventaire: "🎒"      # affiche l'inventaire +  inventaire: "Inventaire" 
-  precedent: "↩️"       # retour salle précédente +  precedent: "Précédent" 
-  v_score_v: "⭐"       # affiche la valeur de la variable "score" +  v_score_v: "Score" 
-  accueil: "🏠"         # accès direct à la salle "accueil"+  accueil: "Accueil" 
 +  url1: "https://cyril-fiesta.fr/jdr-bot-wiki/|Wiki"
 </code> </code>
  
-^ Clé ^ Valeur ^ Effet ^ +^ Clé ^ Effet ^ 
-| ''rafraichir'' | emoji | Réaffiche la salle courante | +| ''rafraichir'' | Réaffiche la salle courante | 
-| ''inventaire'' | emoji | Affiche l'inventaire | +| ''inventaire'' | Affiche l'inventaire | 
-| ''precedent'' | emoji | Retour salle précédente (si disponible) | +| ''precedent'' | Retourne à la salle précédente | 
-| ''v_nom_v'' | emoji | Affiche la valeur et description de la variable ''nom'' | +| ''v_nom_v'' | Affiche la valeur et la description de la variable | 
-| ''id_salle'' | emoji | Accès direct à la salle (n'apparaît pas si on y est déjà) |+| ''id_salle'' | Donne un accès direct à une salle | 
 +| ''urlN'' | Ouvre le lien placé avant le caractère ''<nowiki>|</nowiki>'' |
  
-===== Liens externes dans options: (v4.9) =====+Si une clé pointe vers un objet ou un meuble de la salle plutôt que vers une salle, JDR-Bot déclenche automatiquement ''examiner'' dessus.
  
-Une option dont la valeur commence par ''http://'' ou ''https://'' ouvre un lien externe :+===== Variables globales =====
  
-<code yaml> +''vars:'' contient les nombres et ''vars_texte:'' les textes. Les suffixes ''_p'' et ''_o'' déterminent leur persistance. ''vars_online:'' reste compatible mais n'est plus recommandé. Voir [[fr:yaml:variables|Variables]].
-options: +
-  url1: "https://cyril-fiesta.fr/jdr-bot-wiki/|📚 Wiki" +
-  url2: "https://discord.gg/jdrbot|💬 Discord" +
-</code> +
- +
-La clé (''url1'', ''url2''…) est libre. Le ''|'' sépare l'URL du label affiché sur le bouton. +
- +
-Sur web/desktop : ouvre dans un nouvel onglet. Sur Discord/terminal : affiche l'URL en texte. +
- +
-===== Fallback examiner (v4.9) ===== +
- +
-Si une option ''id_salle'' pointe vers un nom qui correspond à un objet/meuble de la salle courante (plutôt qu'une salle), le moteur déclenche automatiquement ''examiner'' dessus. +
- +
-===== vars:, vars_texte:, vars_online: ===== +
- +
-Variables déclarées au niveau racine, initialisées au lancement. Voir [[fr:yaml:variables|Variables]].+
  
 ===== ordre_evenements_globaux: ===== ===== ordre_evenements_globaux: =====
  
-Par défaut, les événements globaux s'exécutent **après** les événements locaux. Pour les exécuter avant :+Les événements globaux sont vérifiés après les événements locaux par défaut. Pour les vérifier avant :
  
 <code yaml> <code yaml>
Ligne 89: Ligne 78:
 </code> </code>
  
-Les valeurs acceptées sont ''avant'' et ''apres''. La valeur par défaut est ''apres''.+Les valeurs acceptées sont ''avant'' et ''apres''.
  
- +===== URL directe de lancement =====
- +
-===== URL directe de lancement (v4.9) ===== +
- +
-Il est possible de lancer directement un scénario depuis une URL, sans passer par l'accueil :+
  
 <code> <code>
Ligne 102: Ligne 87:
 </code> </code>
  
-  * Résolution automatique : ''.yaml'' en priorité, puis ''.txt'' - aucune extension à spécifier +Le moteur cherche d'abord un dossier portant ce nom, puis un fichier YAML et enfin un fichier TXT. ''lang=en'' choisit le catalogue anglais.
-  * Uniquement les scénarios du dossier officiel ''scenarios/'' +
-  * Retour à l'accueil normal après la partie +
-  * ''&lang=en'' lance directement la version anglaise (interface et catalogue compris) - v4.13 +
-  * Idéal pour des liens de partage directs dans des annonces ou pages de présentation +
  
-===== ui: - mode d'interface (v4.13) =====+===== ui: - mode d'interface =====
  
-Change l'interface de jeu côté joueur : ''cartes'', ''plein-ecran'', ''deck'', ''phone''. La clé existe au niveau du scénario et au niveau d'une salle, tout comme ''masquer_saisie:'' qui contrôle la barre de commande. Détails sur [[fr:ui:presentation|Modes d'interface]].+''ui:'' choisit ''cartes'', ''plein-ecran'', ''deck'' ou ''phone''. La clé fonctionne au niveau du scénario ou d'une salle, comme ''masquer_saisie:''. Voir [[fr:ui:presentation|Modes d'interface]].
  
 <code yaml> <code yaml>
Ligne 118: Ligne 98:
 </code> </code>
  
-Le mode téléphone ajoute deux clés d'en-tête : ''phone_accueil:'' (salle du bouton Accueil) et ''phone_forme:'' (portrait, paysage, tablette) - voir [[fr:ui:phone|Mode téléphone]].+Le mode téléphone ajoute ''phone_accueil:'' et ''phone_forme:''. Voir [[fr:ui:phone|Mode téléphone]].
  
 ===== montrer-type: ===== ===== montrer-type: =====
  
-Pour le [[fr:yaml:glisser-deposer|glisser-déposer]], ''montrer-type: true'' affiche visuellement les rôles source, cible et mixte. L'option peut être définie au niveau du scénario ou seulement dans une salle.+Pour le [[fr:yaml:glisser-deposer|glisser-déposer]], ''montrer-type: true'' distingue les éléments source, cible et mixte. L'option peut être globale ou propre à une salle.
  
-<code yaml> +===== Catalogue et liens de scénario =====
-montrer-type: true+
  
-salles: +Les liens publics reprennent le titre et la description du scénario. Si sa description n'est pas renseignée, celle de ''liste_scenarios.txt'' sert de repli. 
-  - id: atelier + 
-    montrer-type: true +Les tags du catalogue, déclarés dans ''liste_scenarios.txt'', peuvent être libres : ils sont affichés sur les cartes et pris en compte par la recherche. Les tags connus conservent leurs traductions et leurs onglets. Ils sont distincts des [[fr:yaml:tags|tags de salles]], qui ajoutent des comportements au scénario. 
-    texte: "{{cle:>cle}} {{porte:$porte}}"+ 
 +===== Écho des commandes (4.17) ===== 
 + 
 +<code yaml> 
 +echo_commandes: false
 </code> </code>
 +
 +L'écho est désactivé par défaut. ''true'' affiche les commandes et clics de boutons dans le fil du jeu. Une salle peut remplacer le réglage global.
 +
 +Les listes ''raccourcis:'' existent aussi à la racine et par salle : voir [[fr:yaml:raccourcis|Clavier, souris et manette]]. Le mode téléphone ajoute ''phone_orientation_auto:'' : voir [[fr:ui:phone|Orientation du téléphone]].
  
fr/yaml/options.1788204214.txt.gz · Dernière modification : de cyrilfiesta