Écrire des packs de créatures

Un pack de créatures rassemble les illustrations des créatures qu'on affronte en Game Mode. Quand un pack est choisi, un ennemi pour lequel il a une illustration est dessiné avec elle sur le plateau de combat, au lieu d'un pion rond. L'illustration est tournée dans la direction du dernier déplacement de l'ennemi et dessinée à la taille propre de la créature. Un ennemi pour lequel le pack n'a pas d'illustration garde son pion. Consulte Combats tactiques et terrain pour voir le rendu en jeu.

Un pack est un seul fichier JSON (.creatures.json). Le plus simple pour en créer un est l'onglet Creatures (créatures) de Pixelforge, un outil externe qui construit le fichier à partir d'une image par créature. Ce guide décrit le fichier lui-même, pour qui construit ses packs autrement.

Utiliser un pack

Avant de commencer, crée ou télécharge un fichier .creatures.json. Pixelforge est une application de création distincte, qui ne fait pas partie de Marinara.

1. Ouvre l'onglet Creatures de Pixelforge.
2. Pour charger un fichier, choisis Import a creature pack file (importer un fichier de pack de créatures). Pour un pack que tu as créé dans Pixelforge, choisis Save to the library (enregistrer dans la bibliothèque).
3. Choisis Use for fights (utiliser pour les combats).

Un seul pack dessine tous les combats. Pour revenir aux pions, retire le pack choisi ou choisis Use tokens instead (utiliser plutôt les pions).

Le fichier

{
  "creaturePackVersion": 1,
  "id": "my-monsters",
  "name": "My monsters",
  "version": 1,
  "author": "Robin",
  "tileSize": 48,
  "sheets": [{ "id": "s1", "png": "data:image/png;base64,iVBORw0KGgo...", "width": 2048, "height": 1536 }],
  "creatures": [
    {
      "id": "goblin",
      "match": ["5e-2014/creatures/goblin", "Goblin"],
      "size": "small",
      "w": 1,
      "h": 2,
      "frames": 1,
      "variants": [
        { "sheet": "s1", "x": 0, "y": 0 },
        { "sheet": "s1", "x": 1, "y": 0 }
      ]
    }
  ]
}

Planches

Le png d'une planche doit être une data URL PNG : data:image/png;base64, suivi du base64, et de rien d'autre. Un lien vers une image située ailleurs est refusé, tout comme ce qui suit le base64. Ainsi, un pack ne peut jamais afficher que ses propres images. width et height doivent être la taille réelle du PNG ; le moteur les lit dans l'en-tête de l'image et refuse un pack dont les planches indiquent autre chose.

Une créature

Vol

Une créature dotée de fly est dessinée à partir de son bloc de vol, avec ses images d'animation jouées dans l'ordre 0, 1, 2, 1, tant qu'elle est représentée en l'air dans un combat. C'est le cas si elle a l'une de ces caractéristiques :

• une vitesse de vol et aucune vitesse de marche ;
• le vol stationnaire ;
• une position au-dessus du sol ;
• un vol effectué pendant ce tour (un pas que seul son vol permet, par exemple au-dessus de l'eau).

Sinon, elle est dessinée à partir de son apparence, comme auparavant.

Un pack de carte d'Experience dont les packs de créatures ont des illustrations de vol nécessite Capability API 1.352.

Ce que désigne match

• Une créature d'ensemble de règles : <catalog>/<entry> (par exemple creatures/goblin) correspond à cette entrée de bestiaire dans n'importe quel ensemble de règles. <ruleset>/<catalog>/<entry> (par exemple 5e-2014/creatures/goblin) ne lui correspond que dans cet ensemble de règles.
• Un nom : correspond à un ennemi par son nom. La casse et la ponctuation sont ignorées, tout comme un nombre final : "Goblin 2" est donc un gobelin.

Un combattant issu du bestiaire d'un ensemble de règles est reconnu d'abord par son entrée, puis par son nom. Si deux créatures correspondent à la même chose, celle qui est listée en premier dans le pack l'emporte ; le moteur le signale à l'importation du pack.

Tailles

Les images d'animation se comptent en cases, et une créature est dessinée debout sur le bas de sa case, centrée : une grande créature domine donc les cases qui l'entourent. Ces tailles rendent bien sur la grille de 48 pixels :

Le bloc : lignes et images d'animation

Chaque apparence est un bloc sur sa planche. Un bloc compte frames images d'animation en largeur et 4 lignes en hauteur, et chaque image fait w sur h cases. Les lignes sont les orientations, dans cet ordre :

1. bas (vers le spectateur)
2. gauche
3. droite
4. haut (vu de dos)

Une créature immobile (frames: 1) est une seule colonne des quatre orientations. Une créature qui marche (frames: 3) aligne sur chaque ligne pas, repos et pas, comme dans une planche de sprites de marche classique. Chaque bloc doit tenir entièrement dans sa planche ; le moteur nomme tout bloc qui dépasse du bord.

Apparences

Une créature qui a plusieurs apparences (d'autres vêtements, couleurs ou armes) en attribue une à chacun de ses combattants. Un combattant garde la même apparence chaque fois qu'il est dessiné, et deux gobelins d'un même combat peuvent être différents. Toutes les apparences d'une créature ont la même taille.

Dans l'onglet Creatures de Pixelforge, Add looks (ajouter des apparences), à côté d'une créature, ajoute d'autres images de la même taille que la première, jusqu'à huit en tout.