Guide du bâtiment du Compendium

20 mars 2024 09:20

Les informations suivantes sont spécifiques aux Partenaires du marché Roll20.

Ceux qui souhaitent créer des Compendiums devraient avoir une bonne compréhension du système de règles qu'ils aimeraient créer et idéalement avoir une certaine familiarité avec HTML, JSON, l'écriture wiki et/ou l'élaboration de données structurées. Si vous êtes intéressé par une documentation supplémentaire ou la planification d'une réunion avec l'un de nos producteurs de contenu pour une intégration individuelle, veuillez contacter licensing@roll20.net.

Recommandation

Si vous n'êtes pas familier avec l'un des éléments ci-dessus, nous recommandons actuellement de faire appel à l'un de nos entrepreneurs tiers de conversion approuvés pour la création d'extensions de Compendium.

Toute violation ou vandalisme du Compendium entraînera sa suppression.

Page des outils du Compendium

Pour accéder à la page des outils du Compendium, vous devez avoir un accès en modification pour au moins une extension de Compendium. Ces autorisations doivent être définies par un administrateur Roll20; contactez licensing@roll20.net ou soumettez un ticket d'assistance à ce centre d'aide.

Si vous avez la permission de "Propriétaire" du compendium, vous avez accès en modification à toutes les extensions des livres que vous possédez.
Si vous avez la permission de "Éditeur" du compendium, vous avez accès en modification à toutes les extensions dont vous êtes l'éditeur.
Si vous avez la permission de "Adjoint" et êtes un créateur de marché avec au moins une extension de Compendium liée à votre compte, vous avez accès en modification à toutes les extensions dans votre page de gestion des objets.

Sur Roll20, vous pouvez accéder à la page des outils du Compendium en cliquant sur le menu déroulant depuis votre nom dans le coin supérieur droit et en sélectionnant Outils du Compendium.

Compendium Outils Menu Déroulant.jpg

Actuellement, la page des outils du Compendium permet de visualiser ou de supprimer des pages dans un compendium que vous possédez. Cela se fait en sélectionnant d'abord le livre du Compendium, puis l'extension du Compendium et en cliquant sur le bouton Afficher à côté de Voir les pages.

Tout d'abord, choisir.jpg

À partir de là, vous pouvez soit cliquer sur les noms de pages hyperliés pour visiter une page spécifique, soit cliquer sur les cases à cocher à gauche du nom de la page pour les sélectionner. Les pages sélectionnées peuvent être supprimées toutes en même temps en cliquant sur le bouton Supprimer la section. De plus, si vous souhaitez trier par catégorie, vous pouvez le faire en utilisant le menu déroulant sous Catégorie.

À partir d'ici.jpg

Construction d'un Compendium

Création de page

Une fois devenu partenaire du marché Roll20 et ayant reçu l'approbation pour créer des extensions de Compendium, vous aurez accès à un "livre" vide pour commencer à éditer et à remplir de contenu. Pendant le processus de création de la zone de préparation du livre, vous voudrez assembler une liste de catégories nécessaires pour votre système de jeu (Règles, Monstres, Objets, Sorts, etc.). Vous voudrez avoir la structure organisationnelle bien définie avant de commencer le travail sur le Compendium; si vous créez une extension pour un système comme D&D 5e, nous vous fournirons un modèle.

Une fois que l'équipe Roll20 vous aura donné l'URL du nouveau livre Compendium, vous créerez de nouvelles pages en ajoutant le nom de la nouvelle page à la fin de l'URL dans la barre d'adresse et en appuyant sur Entrée. (exemple: https://roll20.net/compendium/MyBook/Test Page) Pour les caractères spéciaux comme les espaces, les parenthèses et les apostrophes: une fois que vous appuyez sur Entrée, le nom de la page sera ajusté pour utiliser automatiquement le code HTML des caractères ASCII nécessaires.

NOTE: Veuillez ne pas utiliser de deux-points ":" dans les URL des pages. Ces caractères sont interprétés comme des catégories par l'URL et rendront votre page inutilisable

Puisque la page n'existe pas encore, le Compendium affichera une page qui dit :

Non trouvé : [nom de la page]

Nous n'avons pas actuellement de page correspondant à ce nom. Réessayer ?

Ou peut-être souhaitez-vous créer cette page ?

En dessous se trouvera un menu déroulant pour la catégorie à laquelle vous souhaitez ajouter la page. Si c'est la toute première page, vous n'aurez aucune catégorie disponible à choisir dans le menu déroulant autre que Miscellaneouspour commencer, c'est donc là que vous devriez commencer à ajouter vos propres catégories.

NOTE : Les pages créées dans les catégories Miscellaneous et BookIndex ne peuvent être modifiées que par un développeur Roll20. Veuillez éviter ces catégories.

Une fois que vous avez défini ou ajouté une catégorie à la page, cliquez sur le bouton bleuCréer une pagepour la créer. Cela vous amènera sur la page nouvellement créée pour commencer à l'éditer.

Modification d'une page

Une fois créée, une page du Compendium sera divisée en deux parties distinctes : un Éditeur de texte et ensuite un Tableau des attributs en dessous.

Éditeur de texte

L'éditeur de texte peut basculer entre une version WYSIWYG et une version HTML en cliquant sur le bouton </> qui est le dernier bouton à droite de la barre d'outils de l'éditeur de texte. Assurez-vous de cliquer sur le bouton </> après avoir entré votre HTML pour mettre à jour la page avant de l'enregistrer. L'éditeur de texte est l'endroit où vous incluez les biographies de monstres/classes/races, les capacités et les compétences. Le contenu de la page est lisible en dehors de toute création de blocs statistiques. Utilisez les balises de titre (<h1>, <h2>, <h3>, etc.) de manière cohérente pour découper votre contenu en vue d'une intégration efficace. Il est extrêmement important que la mise en forme du texte soit également maintenue de manière cohérente tout au long du livre Compendium.

Téléchargement d'images

La plupart des modifications peuvent être effectuées à l'adresse web standard "roll20.net". Pour télécharger des images, les URL doivent être modifiées sur "app.roll20.net". Les images peuvent ensuite être glissées dans la zone appropriée et seront téléchargées automatiquement. Le Compendium Roll20 redimensionne et rééchantillonne automatiquement les images. Si cela n'est pas souhaité, la balise HTML de chaque image doit être modifiée.

Liaison dynamique

Vous n'avez pas besoin de créer manuellement des liens de page dans la copie textuelle de vos pages Compendium. La liaison de page est effectuée automatiquement après le lancement d'un Compendium Roll20. Ce processus automatisé parcourt le contenu textuel de chaque entrée du Compendium pour faire correspondre les chaînes avec les titres de page disponibles. Lorsqu'une correspondance est trouvée (le nom de la page et la chaîne doivent être identiques à l'exception de la casse), la chaîne est automatiquement transformée en lien hypertexte vers la page correspondante. Ce processus se produit lorsque le Compendium est en ligne.

Note : L'autolinker peut être grégaire. Faites attention en donnant des noms à des pages avec une expression courante comme "Magic"

Création de pages de listes

Pour de grandes listes de pages pertinentes, de nombreux systèmes de jeu peuvent bénéficier d'une liste consultable.

Créez une nouvelle page. Pour une convention de dénomination, nous suggérons: <Category> Liste. Les pages de talents, de sorts, de monstres, etc. devraient généralement être classées dans la catégorie des listes. Exemple: Liste de sorts
Cliquez sur "Modifier les attributs" et définissez "data-List" sur {"searchTerms":[], "columns":[], "filters":[], "sortables":[]}. Cet attribut devrait déjà être créé par défaut, mais vous devrez peut-être modifier/enregistrer le contenu de la page pour qu'il apparaisse.
Allez dans "Modifier le contenu", définissez "Liste pour catégorie" sur la valeur souhaitée et ajoutez un nouvel attribut de recherche: Attribut = "Catégorie", Valeur = <Name of Category>et Correspondance = "Exacte". N'oubliez pas d'enregistrer vos modifications.
Modification de la liste
- "Colonnes d'affichage de la liste" - Cela contrôle ce qui apparaît sous chaque colonne d'élément. Cela n'est pas utilisé si une carte d'élément a été définie pour la catégorie.
  - "Attribut" - Le nom de l'attribut à afficher.
  - "Ordre" - L'ordre dans lequel cet attribut est affiché.
  - "Remplacement de valeur" - Une chaîne au format .json de paires clé/valeur pour remplacer certaines valeurs.
  - Par exemple, {"0":"Cantrip"} fait en sorte que les sorts de niveau 0 s'affichent comme "Cantrip" dans la liste des résultats.
  - "Triable" - Ceci est obsolète. Le tri est maintenant contrôlé dans la section "Boutons de tri"
- "Filtrer les attributs" - Cela contrôle les filtres prédéfinis disponibles.
  - "Tout" - Renvoie n'importe quel résultat où la valeur du filtre correspond à n'importe quelle partie de la valeur de l'attribut.
  - "Exact" - Ne renvoie que les résultats où la valeur du filtre correspond exactement à la valeur de l'attribut.
  - "Inverse" - Ne renvoie que les résultats où la valeur du filtre ne correspond pas à la valeur de l'attribut.
  - "Attribut" - Le nom de l'attribut à filtrer par.
  - "Ordre" - L'ordre dans lequel ce filtre est affiché.
  - "Type de filtre" - Le type de saisie pour le filtre.
  - "Valeur par défaut" - La valeur par défaut pour le filtre.
  - "Correspondance" - Comment le filtre renvoie le résultat.
  - "Valeurs d'entrée du filtre" - Pour les types de filtre sélection et multisélection, il s'agit d'une chaîne formatée en .json qui détermine les valeurs disponibles. Si vide, il remplira la sélection avec toutes les valeurs possibles.
- "Boutons de tri" - Pour définir les attributs pouvant être triés.
  - "Alphabétique" - Les résultats sont triés de manière alphabétique, avec les résultats numérotés revenant en premier. "19 ft." et "40 Winks" seraient répertoriés avant "Ale of Drunkening" et "Potion of Sobering", etc.
  - "Numérique" - Les résultats sont triés numériquement. Le code trouvera la première valeur numérique et l'utilisera pour le tri, c'est-à-dire "Speed 30 ft. (15 ft. flying)" sera ensuite analysé comme "30".
  - "Attribute" - Le nom de l'attribut à trier.
  - "Order" - L'ordre dans lequel ce bouton est affiché.
  - "Display Title" - Le texte à afficher dans le bouton, s'il est différent du nom de l'attribut.
  - "Type" - Comment les résultats sont triés.

Tableau des attributs

En dessous de l'éditeur de texte se trouve le tableau des attributs. Cette zone sert à saisir le contenu statique traditionnel qui est cohérent dans toutes vos catégories : classe d'armure, langues, faiblesses, immunités, points de vie, points d'expérience, perception passive, etc., pour les monstres. Poids, type d'objet, classe d'armure, indice de discrétion pour les objets. Type de dégâts, poids, propriétés, dé de dégâts pour les armes. Généralement, ces attributs sont déjà répartis dans un tableau dans votre livre de règles pour les intégrer dans vos entrées de compendium.

Ajout d'attributs

Lorsque vous commencez avec une nouvelle page, aucun attribut ne lui est attribué. Pour commencer à ajouter des attributs, cliquez sur le lienModifier les attributs à droite de l'en-tête des attributs. Cela ne révélera pas seulement les attributs cachés (s'il y en a), mais ajoutera également un nouveau lien en bas du tableau des attributs intitulé+ Ajouter un nouvel attribut.

Un menu déroulant intituléChoisissez un attribut...apparaîtra sur une nouvelle ligne de tableau. Si vous avez déjà créé des attributs sur d'autres entrées, ces attributs apparaîtront comme options dans ce menu déroulant. La première option du menu estCreate new attribute...et c'est probablement celle que vous utiliserez le plus jusqu'à ce que vous ayez créé tous les attributs souhaités.

Capture d'écran du champ Créer un nouvel attribut d'un compendium.png

Une fois sélectionné, un champ vide apparaît à droite du menu déroulant et un champ plus petit apparaît juste en dessous du menu déroulant avec le texte temporaire , "New Attr Name", à l'intérieur. Comme vous pouvez vous y attendre, le champ "New Attr Name" contient le nom de l'attribut que vous souhaitez créer. Le champ vide à droite correspond à la valeur de l'entrée actuelle pour ce nouvel attribut. Dans l'exemple ci-dessus, l'attribut créé garde la trace de l'"élément" d'une entrée. J'attribue à l'élément de cette entrée la valeur "Feu". La valeur d'un attribut peut être numérique ou être une chaîne de caractères.

Continuez à ajouter des attributs selon vos besoins, soit en les créant de toutes pièces, soit en les choisissant dans le menu déroulant. Lorsque vous avez terminé, faites défiler l'écran jusqu'à la rubrique Attributs et à l'endroit où se trouvait le lienEdit Attributes. En mode édition, le libellé de ce lien devientSave Attributes. En cliquant sur ce bouton, vous enregistrez non seulement vos modifications, mais aussi tous les attributs nouvellement créés, de sorte qu'ils puissent être rappelés sur une nouvelle page.

Modification ou suppression d'attributs

Vous ne pouvez pas supprimer les attributs tant qu'ils n'ont pas été sauvegardés. Une fois la sauvegarde effectuée, vous pouvez cliquer à nouveau sur le lienEdit Attributespour revenir en mode édition. Lorsque vous passez la souris sur un attribut créé ou ajouté précédemment, un stylo et une icône de corbeille apparaissent sur le côté droit de la ligne de l'attribut. En cliquant sur l'icône du stylo, vous ouvrez à nouveau l'attribut afin de pouvoir le modifier, tandis que l'icône de la corbeille supprime l'attribut. N'oubliez pas de cliquer surSave Attributespour quitter le mode édition et enregistrer vos modifications.

Importation de pages à partir de fichiers JSON de Compendium

La page des Outils du Compendium inclut une méthode alternative de création d'extensions de Compendium qui peut être beaucoup plus rapide que la création manuelle de pages.

L'importateur JSON du Compendium vous permet de définir un nombre quelconque de pages dans un fichier JSON, puis de télécharger ce fichier pour créer instantanément ces pages dans l'extension de Compendium souhaitée.

Pour commencer à importer le contenu du Compendium, vous devrez d'abord formater vos données de page de Compendium dans un fichier .json selon la spécification JSON du Compendium de Roll20. L'exemple suivant illustre le schéma JSON complet du Compendium:

code block 1.JPG

Ce JSON de Compendium définit trois pages: "Manoir hanté", "Cimetière" et "Squelette effrayant". Les deux premières pages sont dans la catégorie "Lore", tandis que la page "Squelette effrayant" est dans la catégorie "Monstres".

Remarquez comment les deux premières pages sont définies comme "TITRE_DE_LA_PAGE": "HTML_DE_LA_PAGE", tandis que la page "Squelette effrayant" est définie avec un format légèrement plus complexe:

code block 2.JPG

Le format plus simple utilisé par "Manoir hanté" et "Cimetière" est un raccourci lorsque vous voulez simplement importer du contenu HTML, tandis que le format "étendu" est requis lorsque vous souhaitez également importer des attributs.

Une fois votre fichier JSON de Compendium prêt, accédez à la page des Outils du Compendium de Roll20, puis utilisez les menus déroulants pour sélectionner l'extension de Compendium dans laquelle vous souhaitez importer.

Une fois que vous avez sélectionné une extension, cliquez sur le bouton "Afficher" à côté de l'en-tête "Importer des pages depuis JSON" pour révéler l'interface d'importation JSON.

Ensuite, utilisez le bouton "Parcourir" pour télécharger le fichier JSON de Compendium depuis votre ordinateur. Enfin, cliquez sur "Importer les pages" et attendez quelques instants que le processus soit terminé. Lorsque l'importation est terminée, vous verrez un en-tête "Pages créées" et/ou un en-tête "Pages mises à jour". Sous chacun de ces en-têtes, vous verrez une liste de toutes les pages qui ont été créées/mises à jour par l'importation JSON.

Intégration du compendium

La fonctionnalitéRoll20 Compendiumest un répertoire d'informations telles que les règles, les sorts, les objets et les monstres pour certains systèmes de jeu à licence ouverte. En indiquant que votre feuille est compatible avec un compendium, les joueurs auront un accès direct à ce compendium dans la barre latérale droite pendant le jeu.

Désignation de la compatibilité de votre feuille

Pour indiquer la compatibilité avec un recueil, il suffit d'inclure le nom abrégé du recueil dans le champ "compendium" de votre fichiersheet.json. Pour un exemple, voyez le fichiersheet.json de la feuille OGL de la 5ème édition par Roll20sur Github.

Si vous utilisez une feuille personnalisée, un paramètre de la page Paramètres du jeu vous permet de sélectionner manuellement un recueil à utiliser pour votre jeu.

Activation de la fonctionnalité "glisser-déposer" pour votre feuille

En plus de la compatibilité de base, vous avez la possibilité d'indiquer à Roll20 comment les informations du Compendium peuvent être incluses directement dans votre feuille. Cela permet aux joueurs de glisser-déposer une entrée du compendium directement dans votre feuille, et Roll20 remplit les valeurs que vous spécifiez. Pour ce faire, vous devez ajouter la classe compendium-drop-targetà la balisediventourant la section que vous souhaitez compléter. Pour les sections qui se répètent, placez-la à l'intérieur de la balisefieldset. Ensuite, ajoutez l'attributaccept="Attribute Name"à une ou plusieurs balisesinput, select, textarea . Voici un exemple simple qui serait compatible avec l'entréeFireballdu Compendium SRD de la 5e édition.

<fieldset class="repeating_spells"><div class="compendium-drop-target"><input type="text" name="attr_SpellName" accept="Name" /><input type="text" name="attr_SpellDamage" accept="Damage" /><select name="attr_SpellSchool accepter="School"><valeur de l'option="Abjuration">Abjuration</option><valeur de l'option="Conjuration">Conjuration</option><valeur de l'option="Divination">Divination</option><valeur de l'option="Enchantement">Enchantement</option><valeur de l'option="Evocation">Evocation</option><valeur de l'option="Illusion">Illusion</option><valeur de l'option="Nécromancie">Nécromancie</option><valeur de l'option="Transmutation">Transmutation</option></select><type d'entrée="checkbox" name="attr_SpellRitual" value="Yes" accept="Ritual"></div></fieldset>

Le<Attribute Name>dansaccept="<Attribute Name>"doit correspondre au nom d'un attribut de la section inférieure de l'entrée du compendium. Consultez chaque Compendium pour obtenir la liste des attributs disponibles.
Pour les balisesinputettextarea, la valeur du Compendium sera directement insérée.
Pour les balisesinput[type=checkbox]etinput[type=radio], la case sera cochée/radio sélectionnée si la valeur du recueil correspond exactement à l'attribut value de la balise.
Pour les balisesselect, l'optionqui correspond à la valeur du Compendium dans l'attribut value OU dans le texte à l'intérieur de la balise option sera sélectionnée.
Vous pouvez utiliseraccept="Content"si vous souhaitez recevoir le contenu en clair de l'entrée (le contenu situé au-dessus de l'en-tête "Attributes").
Vous pouvez utiliseraccept="data"si vous souhaitez recevoir tous les attributs d'une page de recueil au format json.

Notez que le processus de modification de ces valeurs déclenchera des événements locaux (Sheet Worker) et distants (API) exactement comme si l'utilisateur avait lui-même saisi les données à la main. Vous pouvez donc également créer des entrées cachées pour accepter les données du Compendium, puis traiter ces données à l'aide de Sheet Workers si vous souhaitez mieux contrôler la manière dont les données sont présentées. Voir la section sur les sorts dans la feuille OGL de5ème éditionpour un exemple avancé de ce processus.

Boutons du compendium

Le bouton du compendium peut être utilisé pour ouvrir une entrée du compendium directement à partir d'une feuille de personnage, de la même manière que si vous cliquiez sur une entrée du compendium in-app. Il peut s'agir d'un moyen plus pratique d'accéder aux règles et aux descriptions. Par exemple, pour un sort, le bouton "Compendium" peut être utilisé pour afficher facilement la description complète de ce sort.

La syntaxe est la suivante :<button type="compendium" value="<entryname>">. Voici quelques exemples valables :

<type de bouton="compendium" valeur="Bard"></bouton>

Il s'agit d'une syntaxe valide, mais comme il existe à la fois une classe et un monstre dans le compendium intitulé "Barde", la fenêtre résultante vous présentera un choix d'entrées au lieu d'aller directement à l'une d'entre elles.

<type de bouton="compendium" valeur="Classes:Bard"></button>

C'est la syntaxe préférée. En spécifiant la catégorie, vous vous assurez qu'il n'y aura qu'une seule correspondance.

<type de bouton="compendium" valeur="Classes:Bard#Spellcasting"></button>

L'ajout d'un "#" suivi d'un titre de sous-titre entraîne l'ouverture de la fenêtre directement dans cette section. Cet exemple ouvrira l'entrée pour la classe Barde, en faisant défiler la section Lancer des sorts. Si aucune section portant ce nom n'est trouvée, la fenêtre s'ouvrira en défilant vers le haut. Le fait de glisser une entrée depuis le recueil contient un attribut spécifique à ce bouton,uniqueName, une chaîne contenant à la fois le nom de la catégorie et celui de l'entrée, ce qui garantit qu'il n'y aura qu'une seule correspondance dans le recueil. Ainsi, la syntaxe de ce bouton dans une section de dépôt du recueil est la suivante :

<type de bouton="compendium" name="attr_infoButton" accept="uniqueName"></button>

Vous pouvez également ajouter une sous-section à cet attribut via sheetworker. Ainsi, si l'objet extrait du compendium est un monstre et que vous souhaitez que le bouton s'ouvre directement sur la section "Actions", vous pouvez définir la valeur du bouton comme suit :uniqueName + "#Actions".

Voir aussi

Compendium- Comment gérer les compendiums en général
Création de fiches de personnage- Autres aspects de la création de fiches de personnage
5th Edition OGL by Roll20 - Une feuille qui intègre l'accès au Compendium