Technique avancée : documenter et packager une activité
|
Ce
tutoriel décrit comment documenter et packager une activité
en vue de sa diffusion
|
|
| 23 Octobre 2004 : Version
Origine du document 26 Octobre 2004 : Ajout Fiche de Trafic d'après l'idée et le document de Stéphane Prouzat. 13 Novembre 2005 : Ajout de restriction sur les noms des fichiers |
|
| Avant-propos | |
| Vous développez des activités pour votre plaisir? | |
| Que vous soyez un spécialiste des chemins de fer qui s'attache à la réalité du scénario de ses activités, que vous fassiez des activités simplement pour le plaisir de parcourir les routes avec les rames que vous aimez ou que vous aimiez les activités particulièrement riches en trafic, faites-en profiter la communauté.. | |
| Si vous pensez que votre activité est 'trop simple' ou 'trop simpliste', dites-vous que dans la communauté TS, bien des joueurs sont allergiques à l'éditeur de mode, et que toute activité prête à l'emploi leur permet de profiter un peu plus du jeu. Donc, n'ayez pas de complexe. | |
| Vous trouverez dans cet article quelques conseils pour documenter et packager vos activités dans les meilleures conditions pour que les autres fans de TS en profitent sans trop de souci d'installation.. | |
| Vous avez des remarques à faire sur cet article, vous avez des astuces à faire partager : participez au forum | |
|
Sommaire |
|
| Principe général | |
| Si vous souhaitez diffuser vos activités, il faut veiller à ce que leur utilisation par d'autres joueurs soit la plus facile possible. | |
|
Tout d'abord, il faut donner le maximum d'informations qui permettront
aux joueurs de choisir ou non d'utiliser votre activité. |
|
| A ce niveau le joueur aura les éléments pour décider s'il est intéressé ou non par votre activité et s'il peut se lancer à la chasse au matériel... | |
| Ensuite, il vous faut nommer les différents
fichiers qui sont nécessaires à votre activité. L'installation de l'activité va installer dans les répertoires de Train Simulator sur l'ordinateur du joueur ces différents fichiers qui viendront s'ajouter à la multitude de fichiers déjà présents. Notre préoccupation est d'indentifier clairement nos nouveaux fichiers pour minimiser le risque d'écraser des fichiers déjà présents et pour permettre au joueur de les supprimer le plus facilement possible après utilisation de l'activité s'il le souhaite. Si vous n'êtes pas familiarisé avec les fichiers d'une activité, lisez d'abord cet article sur les fichiers qui constituent une activité. |
|
| Enfin, il faut packager votre activité
pour pouvoir la diffuser. Deux possibilités vous sont offertes: la version en fichier zip, la version en fichier apk. |
|
| Documentation de l'activité | |
| Documentation du scénario | |
| Le plus simple est de partir de l'écran des caractéristiques générales que propose l'éditeur de mode de TS. | |
 |
Vous précisez ici des informations qui se retrouveront dans TS : le nom complet, la difficulté et le durée. Les boutons 'Modifier la description de l'activité' et 'Modifier le résumé de l'activité' ouvrent les fenêtres ci-dessous. |
 |
 |
| Et voici comment elles sont restituées au moment du jeu | |
 |
Le nom complet, se retrouve dans 2 écrans :
Là, il faut remarquer que TS ajoute son heure interne qui correspond à la sauvegarde. Si votre nom est trop long, ce qui est le cas pour l'activité GP_RHA01 de l'exemple, vous perdez cette précieuse information. Par contre, c'est revenu pour GP_RHA06... Vous trouvez également dans la première fenêtre la difficulté, la durée de l'activité ainsi que le texte que vous avez saisi dans la fenêtre DESCRIPTION de l'activité. La locomotive provient du fichier eng utilisé par le consist du service du joueur.
|
 |
Le 'partant de' et 'circulant vers' sont recopiés du chemin du service du joueur |
| Enfin lorsque vous lancez l'activité, vous récupérez le RESUME de l'activité |  |
|
|
Vous pourrez ensuite agrémenter votre activité en renseignant l'ordre de service et/ou en affichant des messages pour guider et informer le joueur . N'oubliez pas que si vous avez créé l'activité et que vous savez parfaitement ce qu'il faut faire, le joueur, lui, la découvre et ne sait pas toujours quoi faire. Pour cela vous pouvez utiliser les évènements de l'éditeur de mode. |
| En renseignant soigneusement ces informations, ce qui n'est pas très compliqué, vous aurez déjà tous les éléments à recopier dans votre 'lisez-moi' pour permettre au joueur de se faire une idée de votre scénario. | |
| C'est avec le matériel utilisé par une activité que le joueur rencontre le plus de difficultés car les problèmes potentiels sont multiples | |
|
Le matériel n'est plus disponible sur le net. |
|
| Il n'existe probablement pas de règle
miracle mais quelques précautions peuvent minimiser les problèmes
: - Inspirez-vous des consists livrés avec les matériels - Recherchez sur le net des compositions type - Limitez-vous surtout avec le matériel statique, éliminez si possible ce qui n'est utilisé qu'une fois - Notez les fichiers et les sites lorsque vous faites des téléchargements |
|
| L'idéal, c'est de préparer les
consits avant de rentrer dans l'éditeur de mode avec CONVOI ou
CONBUILDER.. Une bonne solution consiste à utiliser TRAINSTORE en sélectionnant uniquement les consists et les matériels retenus, avant de construire les rames. |
|
|
A partir de là, vous devez fournir une liste complète
de ce que vous avez utilisé : |
|
| Nous verrons plus loin qu'en packageant une activité avec Route Riter, on obtient automatiquement la liste des matériels utilisés. | |
| Pour vous aider à retrouver les fichiers de distribution, vous pouvez utiliser les fonctions de recherche de matériel disponibles sur ce site. | |
| Nommer et renommer les fichiers | |
| Nommer les fichiers | |
|
Votre activité est définie par un certain nombre de fichiers que vous devez nommer avec des noms qui n'écraseront pas les fichiers qui existent déjà sur l'ordinateur du joueur. |
|
|
En fait, les services, les chemins, les trafics sont partagés par toutes les activités, ce qui signifie que si vous partez d'un chemin livré avec une route ou une autre activité et que vous le modifiez, l'activité qui l'utilisait avant vous ne fonctionnera plus. C'est vrai également pour les consists et les autres composants. |
|
| Une méthode simple est de mettre un préfixe
dans le nom de chaque fichier comme par exemple : - GP_COF04.ACT - GP_COF04 SRV01.SRV - GP_COF04 SRV02.SRV - GP_COF04 PAT01.PAT - GP_COF04 PAT02.PAT - GP_COF04 TRAFIC.TRF |
|
|
N'oubliez pas de nommer également les consists selon le même
principe, même si vous utilisez des consists standard livrés
avec les matériels : |
|
| Ainsi, non seulement vous minimiser les risques d'écraser des fichiers déjà existants, mais vous permettez aussi au joueur de supprimer tout ce qui concerne votre activité. | |
| Pour éviter différents
problèmes rencontrés dans MSTS respectez les 2 conseils
suivants : - Les noms de fichiers ne doivent pas dépasser 30 caractères - Les noms de fichiers ne doivent pas contenir de caractères accentués. |
|
| Mais vous avez déjà construit votre
activité, vous avez utilisé des consists et des chemins
existants, vous en avez créer d'autres... Pas de problème, il est encore possible de remettre tout ça en ordre! Nous allons voir maintenant d'où proviennent les noms de fichiers et comment les renommer. |
|
| Sauvegarder les fichiers avant de les renommer | |
| N'étant pas à l'abri d'une erreur dans les manipulations pour renommer les fichiers, ne pouvant jamais garantir le comportement de l'éditeur de mode, il est fortement recommandé de sauvegarder les fichiers de l'activité avant d'entreprendre des modifications significatives. | |
| Dans l'explorateur Windows, on se positionne sur le répertoire de la route |  |
 |
On sélectionne les 4 répertoires ACTIVITIES PATHS SERVICES et TRAFFIC à l'aide du bouton gauche de la souris en maintenant la touche CTRL enfoncée |
 |
On effectue le copier/coller à l'aide des touches CTRL C suivies de CTRL V et l'on obtient la sauvegarde des 4 répertoires. |
| Renommer les fichiers | |
|
Les répertoires étant sauvegardés, vous pouvez
à partir de l'éditeur de mode renommer vos fichiers en
utilisant le bouton 'Utiliser comme modèle' présent
dans les différentes fenêtres de l'éditeur. |
|
|
|
Commençons par le service du joueur et cliquons le bouton 'Utiliser comme modèle' |
 |
L'éditeur de service affiche les caractéristiques du
service du joueur. Avant de sauvegarder ce service, nous pouvons en profiter pour renommer si nécessaire la rame (fichier .con) avec le bouton 'Utiliser comme modèle' sous le nom de la Rame et pour renommer le chemin (fichier .pat) avec le bouton 'Utiliser comme modèle' sous le nom du chemin. |
 |
L'éditeur de rame propose à son
tour de modifier : - le nom de la rame qui sera celui du fichier .con - le nom complet qui est utilisé dans les listes de l'éditeur où l'on choisit une rame Là encore, NOUS N'ECRASONS PAS la rame d'origine. |
|
Pour le nouveau chemin, l'opération est la même avec 2
fenêtres successives. |
|
 |
Pour renommer les services, chemins et consists du trafic, les manipulations sont les mêmes en partant du bouton modifier de la fenêtre du trafic. |
 |
Dans la région 'Selectionner un service' on sélectionne
successivements les services à renommer et l'on revient aux mêmes
fenêtres que pour le service du joueur. |
| Attention au trafic | |
| La gestion du trafic de l'éditeur de mode reste pour
moi un grand mystère. On constate losque l'on développe une activité, qu'il arrive au bout d'un certain nombre de modifications du trafic, que les services de trafic changent de comportement dans la fonction de simulation de l'éditeur : les trains se déplacent de moins en moins vite .. Dans un tel cas, il est recommandé de refaire entièrement le trafic. |
. |
| Comme nous venons de renommer tous les services, chemins et rames, nous allons refaire complètement le trafic par sécurité. | |
|
|
A partir du Modèle de trafic, nous commençons par noter soigneusement tous les horaires des éléments du trafic |
 |
Si nous devons changer le nom du fichier trafic, alors nous mettons 'Aucun' dans la fenêtre de Modèles de trafic |
 |
Si le nom du fichier trafic est bon, alors nous supprimons tous les éléments du trafic. Pour cela, nous faisons un clic droit sur les services et nous choisissons l'option supprimer. Attention à ne pas utiliser le bouton 'Supprimer' de cette fenêtre car il supprime le service affiché dans la fenêtre 'Sélectionner un service sans demander de confirmation! |
| Nous sauvegardons ensuite l'activité sous
son nom définitif. Donnez un nom court, il n'est visible que dans l'explorateur Windows. |
  |
 |
Puis nous quittons COMPLETEMENT les outils TS |
|
|
Nous relançons à nouveau l'éditeur de mode et chargeons notre activité. Nous pouvons alors créer un nouveau trafic avec le bouton 'Nouveau' |
| On obtient alors 2 fenêtres successives. Le nom du
fichier .trf est celui de la première fenêtre 'Nom du modèle
de trafic' |
  |
|
|
Si dans l'étape précédente nous avons gardé le trafic d'origine en ayant supprimé les services du trafic, alors nous cliquons sur 'Modifier' |
 |
Nous sélectionnons le service à insérer Cette manipulation est à refaire pour tous les services du trafic. |
| Il ne reste plus qu'à sauvegarder l'activité une dernière fois et tester le résultat avec TS. | |
|
|
Les commandes Enregistrer et Enregistrer sous sauvegardent votre activité dans le fichier .act La commande 'Calculer et enregistrer' sauvegarde également votre activité dans le fichier .act mais créer aussi le fichier .asv dont le fonctionnement est discutable et n'est pas nécessaire à l'utilisation de l'activité. Il arrive même que la présence de ce fichier provoque des plantages de TS, en particulier lorsque le service du joueur débute avec une vitesse initiale. Le mieux, c'est de ne pas le générer et donc de préférer la commande Enregistrer. |
| En résumé, lorsque vous définissez
les services, chemins et rames, les fenêtres vous proposent les
2 zones : - Nom : qui détermine le nom du fichier : respectez ici la règle du préfixe. - Nom complet qui est une zone libre utilisée dans les listes de valeurs à l'intérieur de l'éditeur de mode |
|
| Packager une activité | |
| Pour packager une activité, il y a en gros 2 méthodes : le fichier zip produit à la main ou avec Route Riter et le fichier apk obtenu avec l'éditeur de mode. | |
| Un mini sondage effectué sur ce site montre
que la préférence des joueurs est pour le fichier zip mais
le fichier apk a quelques adeptes. Comme la production du fichier apk est instantanée, rien n'empêche de la joindre dans le fichier zip! |
|
|
Voici maintenant un récapitulatif de ce que nous allons joindre
à notre activité : |
|
| Gardez à l'esprit que même si votre
activité est superbe, c'est d'abord la facilité d'installation
et d'accès aux matériels qui en feront la qualité,
c'est le premier travail que devra effectuer le joueur avant de l'utiliser! Il est très important de fournir le Lisez-moi et la liste du matériel avec le plus de précisions possibles |
|
| Exemple de fichiers Lisez-moi Fiche de Trafic et Liste de Matériel | |
| Le fichier lisez-moi | |
| Le fichier lisez-moi va reprendre les caractéristiques de l'activité et donner des informations sur la route, l'auteur de l'activité, la procédure d'installation. | |
| Voici un exemple de fichier lisez-moi.htm | |
| Vous y trouvez toutes les informations citées
dans cette article. Donnez une adresse mail où vous joindre en cas de difficulté avec votre activité. |
|
| Vous remarquerez que l'utilisation des préfixes pour tous les fichiers de l'activité permettront au joueur de les supprimer s'il le souhaite | |
| Fiche de Trafic | |
| La fiche de trafic est une idée de Stéphane Prouzat qui m'a communiqué ce document suite à des discussions sur la façon de tester l'activité créée par une autre personne. | |
| Voici cette fiche de trafic | |
| Nous y retrouvons toutes les gares du parcours, avec ou sans arrêt, le comportement des carrés et les services de trafic croisés ou doublés. | |
| En joignant cette fiche au packaging de l'activité, non seulement le joueur pourra mieux se rendre compte de ce qui l'attend, mais pourra également pendant le jeu se caler sur les horaires prévu et ainsi profiter au maximum du trafic. | |
| C'est par contre un travail supplémentaire important pour le créateur, c'est donc à lui de voir. | |
| La liste du matériel | |
| Encore une fois, c'est la partie la plus délicate
pour le joueur, c'est là que les meilleures volontés se
découragent! Soyez donc le plus complet possible. |
|
| Voici un exemple de liste de matériel qui contient toutes les informations utiles pour aider le joueur | |
| Si vous utilisez la fonction 'Proposer une activité' de ce site, vous pouvez générer automatiquement cette liste sous la même forme et la joindre à votre activité. | |
| Création fichier apk et fichier zip | |
| Le fichier apk | |
 |
Le fichier apk s'obtient tout simplement en sélectionnat l'option 'Lot d'activités' à partir du menu fichier de l'éditeur de mode. |
|
|
Par défaut, le répertoire proposé est
celui de l'activité. On donne le nom, le tour est joué. Par commodité, donnez le même nom que celui de l'activité. |
| Le fichier zip | |
| Le fichier zip peut s'obtenir automatiquement à partir de route riter (captures à partir de la version 6.1.22) : | |
|
Dans Route Riter On sélectionne l'onglet 'Activité/Matériels' |
 |
| On obient un tableau complet de l'activité avec la barre de boutons ci-contre (pour plus d'informations sur les fonctions de Route Riter avec les activités voir l'article Route Riter et les Activités) |  |
 |
En choisissant le bouton 'Packager l'activité' Route
Riter demande le nom du fichier zip à créer et affiche la
fenêtre ci-dessous. Donnez le même nom que celui de l'activité. |
 |
|
| Route Riter prépare automatiquement la
liste de tous les fichiers nécessaires au fonctionnement de l'activité. Gardez les options proposées par Route Riter pour générer les chemins relatifs ROUTES et TRAINS afin que le joueur n'ait plus qu'à les copier dans son répertoire Train Simulator. |
|
| Au passage, il est facile de vérifier
ici que tous nos fichiers commencent bien par le même préfixe. Sinon, il est encore temps de corriger. |
|
 |
Vous remarquerez dans la liste des fichiers que Route Riter a créé un fichier 'GP_COF04_RollingStockNeeded.txt'. Ce fichier contient tous les matériels utilisés par votre activité, ce qui facilitera au joueur la recherche des matériels déjà présents sur son ordinateur. |
 |
En cliquant sur le bouton 'Quit', le fichier zip est créé! Il ne nous reste plus qu'à y ajouter nos 3 fichiers complémentaires (apk, lisez-moi et liste du matériel) en les faisant glisser de l'explorateur vers le fichier zip. |
 |
Et voilà le contenu du fichier zip.
|
|
Voilà, nous avons terminer ce chapitre,
n'hésitez plus à diffuser
vos activités
|
|
 |
|
|
|
|
