Comment utiliser PakiesXL

Comment utiliser Pakies XL
(écrit pour la version 0.8.1)

Comme spécifié dans le Discaimer en lançant le programme, cet outil est fait pour être utilisé par des personnes sachant ce qu'elles font.
Cela signifie qu'il ne va pas faire de vérifications contre "les supides erreurs d'utilisation" et considérer que vous avez rentré des données correctes (ce n'est pas forcément le cas partout, mais c'est rare que de tels test soient implémentés).

Il ne demandera également jamais de confirmation lors de l'effacement ou de l'écrasement de fichiers existants.
En résumé, pour parler plus cruement, cet outil n'est pas "noob-proof"...

Toutefois, avec l'aide de ce document, vous devriez avoir toutes les informations pour savoir ce que vous faites et quelles données rentrer à quel endroit afin d'éviter des plantages dus à des erreurs d'utilisation.

Je vais séparer ce tuto en sections représentant des choses que l'on peut faire avec Pakies XL.

0) Fonctionnalités Globales
- Bookmarks (favoris):
Autant dans l'onglet (pas terminé) "Explorer" et l'onglet "Unpacker", il y a dans le coin suppérieur-gauche une liste de répertoires favoris servant à rapidement accéder à vos répertoires contenant des pak/patch/sgbin.
Vous pouvez en rajouter en cliquant d'abord sur "Browse" (parcourrir) juste en dessous de la liste et en pointant vers un repertoire contenant des fichiers pak/patch/sgbin. Une fois le repertoire selectionné, cliquez sur "Add bookmark" et il sera ajouté à la liste.
Pour supprimer un bookmark, selectionnez le en cliquant dessus sur la liste puis cliquez "Remove bookmark".

1) Extraire des données
La première chose à faire avant de pouvoir modder quoi que ce soit est d'extraire les données des "packages", de manière à pouvoir travailler avec ces données avec d'autres outils et ainsi commencer à modder.
Pakies XL a un onglet dédié à l'extraction, l'onglet "Unpacker", permettant d'extraire les données de plusieurs façons différentes.

Il faut vous assurer d'avoir un repertoire contenant des fichiers pak/patch/sgbin listé dans le champs "PAKs Directory". Si ce n'est pas le cas, cliquez sur "Browse" et faites le pointer vers un tel répertoire.
Il faut également spécifier un répertoire valide (donc où vous pouvez écrire et ayant la place pour stocker les données extraites) de destination indiquant où les données seront extraites.

Maintenant, préparons nous à extraire les données. Il y a 3 façons de le faire:
a) Extraire les données depuis un fichier unique:
Vous choisissez un fichier dans la liste puis cliquez "Unpack Files" à gauche des statistiques au bas de l'écran. Le contenu complet du fichier selectionné sera extrait dans le repertoire de destination.
b) Extraire les données depuis toutes les versions du fichier actif:
Vous choisissez un fichier puis cliquez "Unpack all versions", ça extraira dans le repertoire de destination le fichier .pak correspondant au fichier selectionné, puis tous les fichier .patch allant avec dans le bon ordre, vous avez donc la dernière version du contenu extrait.
c) Extraire toute l'installation
Cliquez simplement sur "Unpack everything" sur la droite des statistiques en bas, et préparez vous pour une attente relativement longue (avec des barres de progression), et vous aurez toutes les données du jeu extraites et à jour dans le répertoire de destination.

2) Packer les données
Une fois votre mod prêt pour test (ou pour publication), il est temps de le packer dans un fichier .patch ou .pak. Comme les fichiers sont chargés par ordre alphabétique puis par ordre de patch, je recommanderais de nommer vos fichiers packés avec n'importe quel nom commençant par une lettre située après "l" dans l'alphabet, avec une extention .patch, de cette manière vous serez certain que votre mod sera chargé après tout le reste des données et donc aura la priorité.
Allez maintenant dans l'onglet "Packer / Repacker"...
Remarque: le terme "repacker" a été en quelque sortes généralisé lorsqu'on fait référence au fait de packer les données. ce qui est faux techniquement. Packer c'est packer, et repacker c'est repacker. On parlera plus tard du repacking qui sera expliqué dans la section 4. Cette partie est donc exclusivement consacrée au packing. Ne confondez pas ces deux termes.

La partie de cet onglet qui nous interesse pour l'instant est celle en haut à gauche. "Packing options" (ce nom n'est plus adapté depuis la dernière refonte d'interface. Je le changerai dans la prochaine version).
Dans le premier champs, vous spécifiez le repertoire de destination. Il devrait par défaut être \Paks.

Si vous voulez faire des expériences, vous pouvez modifier "Sign package for version" ou "Package version", mais vous n'avez pas besoin de vous faire c... euh, de vous ennuyer avec ces 2 champs pour que cela fonctionne. Gardez juste à l'esprit que si vous signez votre mod pour une version plus grande que l'actuelle, cela ne fonctionnera pas. De toutes façons, le numéro de version est lu dans votre jeu à chaque lancement du programme, il devrait donc toujours correspondre à la version actuelle de Cities XL par défaut.
In the first field, you specify the output path, it will default to \Paks.
"Include single packages for repackaging" est au mauvais endroit ici... et de toutes façons, je le supprimerai à la prochaine version, cette option est obsolète. Laissez la activée et ignorez la.
"Disable memory warnings" devrait également être déplacé par la suite, mais celui là restera. Il sera expliqué dans la section 4.

Maintenant le "Quick Packer"...
C'est facile... Vous selectionnez un repertoire source contenant un répertoire "data" qui coontient les données que vous voulez mettre dans votre mod, et vous spécifiez un nom de fichier pour le package final... Ensuite vous cliquez "Create pack" et voilà, votre mod est prêt à l'usage. Si le repertoire de destination spécifié plus haut est \Paks et que votre mod fonctionne, lancez simplement le jeu et amusez-vous.

3) Gestion des projets
Maintenant que l'on sait comment extraire et packer les données, il est temps de se soucier de rendre les choses faciles et rapide pour gérer nos mods, car lorsqu'on developpe plusieurs mods, on ne veut pas à chaque fois refaire les étapes décrites aux sections 1) et 2), n'est-ce pas ?
C'est pourquoi j'ai implémenté la gestion des projets. Cela fonctionne de la manière suivante:
- Vous créez un projet, en spécifiant toutes les données lui correspondant, les répertoires source et destination, version, infos sur le mod (pour rendre les choses plus faciles pour créer un modèle de sujet pour forum)...
- Quand vous travaillez sur un mod qui a un projet crée pour lui, choisissez simplement le nom de fichier du projet dans la liste, cela affichera toutes les infos du projet et vous permettra de les modifier et rapidement effectuer certaines opérations sur eux (sauver les modifs, ouvrir dans l'explorateur windows, dans l'explorateur interne (pas terminé, fonctionne partiellement mais vous devriez éviter de l'utiliser pour l'instant), packer le projet...)
Du coup, quand vous avez 10 projets, c'est un bon moyen pour recommencer à travailler dessus facilement et rapidement.

Créer un projet:
Il faut remplir les champs, en voici une description dans l'ordre où ils apparaissent:
- Project filename: C'est le nom du fichier dans lequel seront stockées les informations sur le projet, c'est également le nom qui apparaîtra dans la liste à gauche. Il devrait se terminer par ".pxp" mais si ce n'est pas le cas, ça sera rajouté lors de la sauvegarde, ne vous inquiétez donc pas pour ça.
- Project Directory: Indique le répertoire qui sera utilisé comme répertoire source pour le packer. les mêmes conditions s'appliquent donc à ce champs (doit contenir un repertoire "data" avec les fichiers du mod).
- Packed filename: Nom du fichier .pak/.patch/.sgbin, si vous ne spécifiez pas d'extention, le fichier résultant n'aura pas d'extention, n'oubliez donc pas d'en spécifier une parmi les 3 indiquées.
- Pack Ver: Numéro de version du format de package, doit être 2 ou 3 sinon ne fonctionnera pas.
- Build: Numéro de version du jeu à utiliser pour singner le mod. Décrit dans la section 2), doit être une valeur entre 0 et le numéro de version actuel.
- Name / version: Nom du mod, et version du mod. Utilisé uniquement pour générer un modèle de sujet de forum.
- Tous les champs en dessous sont également des informations de "génération de sujet" et leur nom devrait être suffisement parlant.

Intéragir avec les projets:

Avant tout, choisissez un projet dans la liste, ensuite vous pouvez modifier toutes les informations (n'oubliez pas de cliquer "save" pour enregistrer les modifications).
Maintenant, voici ce que vous pouvez faire à part modifier les informations (en cliquant sur le bouton correspondant):
- Copy pre-made thread into clipboard: Prepare un modèle de sujet de forum, prêt à être collé mais pas à être posté, quelques modifications seront sans doute necessaires, comme par exemple le lien de download et eventuellement l'ajout de screenshots... mais ça m'a quand même beaucoup aidé (je suis quelqu'un de très flémard)
- Open in Explorer: Cette option apparaitra uniquement si le projet a déjà été packé, et fonctionne avec un fichier packé, alors si vous avez fait des modifs à votre mod, n'oubliez pas de le packer avant d'utiliser cette fonction, sinon les modifications ne seront pas inclues. De toutes façons, l'Explorer n'est pas encore terminé, je ne recommande donc pas que vous l'utilisiez pour manipuler vos mods pour l'instant. Si vous voulez quand même essayez, je recommande grandemenet de faire un backup du ou des fichier(s) concerné(s) avant.
- Open in Win Explorer: Ouvre le répertoire du projet dans l'explorateur windows, de manière à pouvoir accéder à son contenu et le parcourir, modifier, y rajouter des fichiers... N'oubliez pas de packer les données avant de lancer le jeu pour terter après avoir fait des modifications de cette façon.
- Save Project: Enregistre les modifications faites aux infos du projet.
- Pack Project: Packe le contenu du répertoire du projet dans le fichier packé spécifié. Le repertoire de destination est le même que celui indiqué dans la section 2)
- Save and Pack: Si vous avez réelement besoin d'aide à propos de ce point, vous devriez peut être songer à dormir un peu plus...

4) Repacking data
Il est maintenant temps d'expliquer ce que le terne "Repacking" signifie réelement.
Repacking signifie extraire les données puis ensuite les packer à nouveau dans une nouvelle "structure packée", mais sans en modifier ou affecter les données...

A quoi ça sert exactement ?
Je l'ai inclus à des fins experimentales uniquement. Le problème avec le système de MC est que les anciens fichiers ne sont jamais supprimés, ce qui engendre un gachis de place.

Comment ça marche ?
Basiquement, ça prend une liste des fichiers .PAK installés, et pour chaque fichier pak (ou pour celui selectionné, selon la méthode de repack selectionnée), va extraire le contenu du fichier pak correspondant ainsi que tous les patch lui correspondant (comme lors d'un "unpack all versions"), effacer les fichiers .patch, et packer le contenu extrait dans un unique fichier .pak.

Avantages du repacking:
- Vous gagnez de la place sur votre disque dur (pas énormément, mais tout de même un peu, il aurait été possible de libérer plus d'espace en compressant plus de données, mais cela aurait rallongé le temps de chargement et requis plus de ram lors du chargement du jeu. Pourrait également "gacher" de l'espace en ne compressant aucun fichier, mais certains doivent être compressés, et il n'y a pas de réel avantage à ne rien compresser du tout)
- Vous avez un répertoire Paks\plus "propre" (du fait qu'il n'y a plus des tonnes de fichiers .patch)
- Vous pouvez théoriquement avec certains paramètres rendre le chargement du jeu plus rapide, mais la différence est très difficile à remarquer.

Inconvéniants:
- Cela ne devrait pas mais PEUT toutefois interférer avec le procédé de mises à jour du jeu dans certaines situations.
- C'est une opération longue, et ne vaut pas forcément la peine de perdre ce temps.
- Si votre ordinateur plante au mauvais moment, cela pourrait corrompre otre installation du jeu et vous forcer à le réinstaller.
- Selon la ram disponible sur votre système, vous ne pourrez peut-être pas repacker certains fichiers... particulièrement all_sgbin qui est assez imposant.

Par défaut, il y a un avertissement qui s'affiche si vous ne disposez pas d'assez de ram pour repacker un fichier, toutefois, vous pouvez désactiver cet avertissement en cochant "Disable Memory Warnings" dans "Packing options".

La partie Repacking se trouve dans le coin inférieur droit de l'onglet "Packer / Repacker".

Il y a 2 méthodes pour repacker:

a) Vous voulez repacker un fichier pak spécifique avec tous ses patchs
Selectionnez ce fichier dans la liste, puis cliquez "Start repacking this pack and its patches".
b) Vous voulez repacker toute votre installation et être débarasser de tous ces affreux fichiers .patch.
Cliquez simplement "Repack Everything" (Disable Memory Warnings coché recommandé).

Je recommande de faire un backup de tout votre repertoire Paks avant de l'essayer. Il devrait être fiable, mais on n'est jamais à l'abris de quelque chose d'inatendu... Une coupure d'electricité, un crash du système d'exploitation, un météore qui se pète la gueule sur votre PC... qu'importe...

5) Explorer et modifier un mod
Cette partie expliquera comment fonctionne l'onglet Explorer / Editor, mais je la remplirai quand (et si) je terminerai cette partie dans le programme.