Aller au contenu principal

Prise en main

BTC Studio développe des extensions pour TypeWriter, le moteur de quêtes et de narration pour serveurs Paper. Cette documentation décrit chaque extension : ce qu'elle fait, comment l'installer, et chaque entrée qu'elle ajoute, champ par champ.

TypeWriter en cinq minutes​

TypeWriter remplace les fichiers de configuration par un panneau web. Vous ouvrez le panneau depuis le serveur (/typewriter connect), construisez des pages composées d'entrées, les reliez entre elles, puis publiez : le serveur applique les changements sans redémarrage.

ConceptDéfinition
PageUn conteneur d'entrées. Les pages de séquence contiennent des dialogues et des actions, les pages statiques contiennent des définitions (artifacts, speakers, définitions de PNJ), les pages manifest contiennent ce qui est toujours actif (audiences, displays), les pages cinématiques contiennent des timelines.
EntréeUne brique de construction, identifiée par son type (par exemple schematic_block). Chaque entrée possède des champs que vous remplissez dans l'inspecteur.
TriggerUn lien d'une entrée vers la suivante : un événement déclenche une action, qui déclenche un dialogue…
FactUne valeur stockée ou calculée par joueur, utilisée dans les critères pour décider si une entrée s'exécute, et modifiée par des modificateurs.
AudienceUn filtre sur les joueurs (dans une région, tenant un objet, à une étape de quête). Les displays comme les nameplates, les faux blocs ou les HUD sont affichés à une audience.
ArtifactDes données persistantes appartenant à une extension (schematics posés, stock de boutique, statistiques).

Les extensions ajoutent de nouveaux types d'entrées à cette boîte à outils. Une fois une extension installée, ses entrées apparaissent dans la barre de recherche du panneau et derrière le bouton + du type de page correspondant.

Installer une extension​

  1. Installez TypeWriter sur un serveur Paper et vérifiez que le panneau s'ouvre.
  2. Téléchargez l'extension : depuis ses releases GitHub pour les extensions gratuites, depuis Voxel ou BuiltByBit pour les extensions payantes. Les boutons se trouvent en haut de chaque page d'extension.
  3. Installez les plugins listés sous Requires sur la page de l'extension.
  4. Placez le JAR dans plugins/Typewriter/extensions/ et redémarrez le serveur.
  5. Ouvrez le panneau : les nouvelles entrées sont disponibles dans la barre de recherche.
Versions

Chaque page d'extension indique la version qu'elle documente et la version de TypeWriter requise. Lorsque vous mettez à jour TypeWriter, mettez à jour ses extensions vers une release compatible en même temps.

S'orienter dans cette documentation​

  • Le catalogue des extensions liste toutes les extensions, avec des filtres par disponibilité et par thème.
  • Chaque page d'extension suit la même structure : présentation, fonctionnalités, installation, premiers pas, commandes, permissions, placeholders, entrées, dépannage.
  • Chaque page d'entrée montre l'entrée telle qu'elle apparaît dans le panneau (identifiant, type, icône) ainsi que le tableau de ses champs avec leur type, leur valeur par défaut et leur description. Ces tableaux sont générés à partir du code source de l'extension : ils correspondent donc au code publié.
DisponibilitéSignification
GratuiteOpen source, téléchargeable depuis GitHub.
PayanteIntégrations premium, vendues sur Voxel et BuiltByBit.
PrivéeTourne sur le réseau BornToCraft avec la version BTC de TypeWriter ; documentée à titre de référence, non distribuée.
BientôtEn développement ; les entrées peuvent encore changer.

Obtenir de l'aide​

Posez vos questions sur le Discord de BTC Studio. Pour un bug dans une extension gratuite, ouvrez une issue sur son dépôt GitHub en indiquant la version de l'extension, la version de TypeWriter et la première erreur du journal du serveur.