Pour des raisons de praticité (cohérence multilingue, utilisation des termes utilisés dans l'interface, …), nous utiliserons le terme Template tout au long de la documentation. On pourrait traduire ce terme par Modèle.

Un Template est une des parties centrales du moteur de Geckos. Sans lui, aucune carte ne peut être générée. Mais qu'est-ce qu'un Template, au juste ? Et comment peut-on en concevoir un ?

Un template est un objet JSON. Il s'agit d'une façon de formater de l'information de telle manière que le moteur de Geckos puisse comprendre cette information. Un fichier JSON est un simple fichier texte, que vous pouvez créer en ajoutant un nouveau fichier texte dans un répertoire, et en le nommant par exemple monTemplate.json. Voici un squelette de fichier que vous pouvez réutiliser :

template-base.json

 {
    "description": { },
    "fonts" : [ ],
    "sharedOptions": [ ],
    "styles" : [ ]
 };

La description d'un template est conservée dans un objet nommé description. Quatre propriétés peuvent y être définies :

"description": 
  { 
    "description": "Un template basique pour Pulp Alley", 
    "title":"Pulp Alley", 
    "credits": "par Nicolas Ronvel", 
    "url": "https://github.com/Gulix/geckos/"
  },

Ces informations seront ensuite utilisées pour décrire le template dans l'interface utilisateur de Geckos, quand ce template aura été chargé.

L'élément fonts dans un template est optionnel. Son absence n'empêchera pas un template de fonctionner.

Dans le cas où vous avez besoin d'une police d'écriture spécifique pour votre template, et que vous n'êtes pas certain que les utilisateurs finaux disposent de cette police installée sur leur ordinateur, alors utiliser les polices personnalisées s'avèrera une bonne idée.

Pour une explication sur l'utilisation des polices personnalisées, consultez page qui y est consacrée.

Cet élément est décrit dans la page portant sur le Menu déroulant.

L'élément styles d'un template contient les éléments qui permettront la génération de l'image. Cela inclut la taille de l'image, les champs éditables, les éléments de l'image, …

Chaque template peut inclure plusieurs styles (dans des langues différentes, avec un design différent mais les mêmes données en entrée, …), d'où l'utilisation d'un tableau pour la propriété styles.

Consultez la section Styles pour une description plus complète d'un Style.