LA SYNTAXE

La syntaxe : où l'art d'écrire des trucs qu'un logiciel va comprendre correctement, et, accessoirement ne pas faire planter^^

Les noms des fichiers TOUJOURS :

• sans espace, les remplacer par des "_" (underscore)
• sans accent ni caractères spéciaux
• capitale ou minuscule n'a pas d'incidence
• idem pour les noms de dossiers.

Le contenu/code des fichiers :

• Les règles peuvent varier d'un type de fichier à un autre mais globalement : les accents et caractères spéciaux sont à bannir, sauf espaces réservés (entre guillements anglo-saxons en général, ou dans la localisation).
• Les lignes vierges ne sont pas tolérées pour les fichiers .csv
• Une ligne précédée d'un # est désactivée (commentée en jargon).
• Les indentations n'ont pas d'incidence mais aident à la lisibilité. Cela laisse néanmoins quelques libertés pour éclaircir le code.
• une généralité : respecter la syntaxe originelle. pas de fioriture, pas d’extravagance, pas d'expérimentation folle : le logiciel est borné, et le code fait rarement preuve de souplesse.
  
  
  

LA LOCALISATION

La localisation est l'ensemble des textes affichés en jeu. Sans localisation, le code brut apparaîtrait en jeu. Ce qui veut dire que la plupart des ajouts en termes de modding requiert l'usage de localisation, voilà pourquoi nous allons traiter ce point dès à présent.
C'est par la localisation aussi que passe la traduction.
Les fichiers de la localisation sont au format .csv : "comma separated values", autrement dit "vlauers séparées par des (points)-virgules". Ce format peut être lu et éditer soit avec un tableur, soit avec un éditeur de texte.

exemple de code.

#CODE;ENGLISH;FRENCH;GERMAN;;SPANISH;;;;;;;;;x
PROV130;Troyes;Troyes;Troyes;;Troyes;;;;;;;;;x
PROV131;Sens;Sens;Sens;;Sens;;;;;;;;;x
PROV132;Auxerre;Auxerre;Auxerre;;Auxerre;;;;;;;;;x
PROV133;Saintois;Saintois;Saintois;;Saintois;;;;;;;;;x
PROV134;Sundgau;Sundgau;Sundgau;;Sundgau;;;;;;;;;x
PROV135;Bourgogne;Bourgogne;Bourgogne;;Borgoña;;;;;;;;;x
PROV136;Dijon;Dijon;Dijon;;Dijon;;;;;;;;;x
PROV137;Nevers;Nevers;Nevers;;Nevers;;;;;;;;;x
PROV138;Orléans;Orléans;Orléans;;Orléans;;;;;;;;;x

la première ligne explique le fonctionnement, ce qui est pratique. diverses annotations se retrouvent dans beaucoup de fichiers, merci Paradox !
Ici nous avons donc :

• le code ou tag : il s'agit du code brut issu des fichiers. Soumis aux règle de syntaxe du code comme cité plus haut.
• une colonne de texte par langue (je dis colonne car ouvert dans un tableur ça s'affiche en colonne). Syntaxe libre.
• un certain nombre de points-virgules et donc de colonne. conserver le même nombre que la vanille au minimum.
• un "x" final, indispensable, qui signifie fin de la ligne et retour à la ligne. aucun caractère n'est toléré après ce "x" (un espace est un caractère).
• lignes vierges non tolérées.
• une ligne commentée doit malgré tout contenir la série de ";" et le "x" final.

La modification :

Ces fichiers peuvent être ouverts ou modifiés avec un éditeur de texte (je conseille notepad++ ou notepad), ou un tableur (microsoft Excel ou openoffice Calc). Attention avec ce dernier, à l'ouverture dé-sélectionner "champs entre guillemets comme texte".
L'utilisation du tableur est moins sécurisante car on a vite faite de faire un truc qui ne va pas plaire au fichier tableur modifiant la structure du fichier (ajout de formules et autres). Un éditeur de texte est plus sécurisé et suffisant dans bien des cas.

Quand utiliser un tableur ? Lorsque des opérations de copier-coller sont nécessaires (copie incrémentée, sélection et copie d'une cellule d'un coup), ou pour l'usage du correcteur orthographique.

Quand utiliser un éditeur de texte ?Indispensable pour coder, un peu moins pour les fichiers de localisation. Pour les modifs rapides et mineures. Pour le travail en simultané sur plusieurs fichiers (liste d'onglets des fichiers ouverts, seconde vue), très utile.Pour la recherche dans un dossier ou sous-dossier (sous dossier event par exemple pour trouver le code ou un exemple de son utilisation dans la vanille). Rapidité d'ouverture, mise à jour instantanée en cas de modification avec un autre programme, conserve les derniers fichier ouverts et plein d'autres petites choses qui facilitent la vie du moddeur.

L'organisation des fichiers vous pouvez ajouter vos modification dans un des fichiers existants si ça vous dit, mais sinon créer un fichier séparé et propre est toujours recommandé (souhaitable pour tous les fichiers d'un mod quand c'est possible).
Si une occurrence de code apparait à la fois dans un fichier de la vanille et dans un fichier additionnel, la ligne prise en compte sera celle du fichier le plus récent (dernière occurrence rencontrée à la lecture).

Les variables il existe un certain nombre de variables (GetTitledFirstName et cie) qui permettent de la souplesse dans la rédaction en allant chercher d'autres éléments de textes (noms de titre, de personnes etc). Vous les retrouverez disséminés dans les fichiers d'origines.

Les codes Principalement des codes pour donner une couleur (§Yxxx§ pour doré par ex) ou un effet de mise en forme du texte.

Divers Si l'espace entre deux points-virgules est laissé vierge, le jeu affiche le code brut. Nombre de mod anglo-saxons mettent "FRENCH" dans la colonne pour le français, affichant ainsi FRENCH partout, sympa le coup bas... alors que le code brut ou un copié collé du texte anglais ferait l'affaire. Vous pouvez ajouter d'autres langue si ça vous chante.


Prochain épisode, finies les généralités car on passera à un cas pratique !

>> Discussions et commentaires sur notre forum