HowTo

Installation

Pour installer, créer tout d'abord un dossier dans lequel vous voulez installer le soft. Y placer ensuite l'archive Soft_vXrY.tar.gz. Puis lancer la décompression avec la commande :

% tar -xzf Soft_vXrY.tar.gz.

Maintenant deux choix s'offrent à vous : soit vous avez toutes les librairies nécessaires et vous voulez installer la version GUI, auquel cas vous faites :

% ./configure

% make

Si vous souhaitez juste la version console, lancer alors l'installation :

% sh install

Voilà, maintenant tous les programmes utiles ont été compilés, les différents dossiers créés. Les scripts shell ont été mis en mode exécutables.

Prérequis

Pour pouvoir profiter du soft, un compilateur C++ et LaTeX doivent être installés sur votre machine. Un interpréteur python est également nécessaire. Inutile de dire que sous Wind*** c'est même pas la peine d'essayer sans une grande maîtrise et un sang-froid hors du commun ;-)

Nécessite la librairie boost sur votre machine (depuis la version 2.2) que vous pouvez installer facilement :

OS	command
Fedora	% yum install boost boost-devel
Mandriva	% urpmi boost boost-devel
Debian	% apt-get boost boost-devel
Mac	installer le repo ici et suivre les instructions en bas de cette page

Mise à jour

Attention, vérifier que vous avez la version 1.7 de l'outil de mise à jour : lancer % ./Update.py -v, et "ADD Updater, version 1.7" doit apparaître à l'écran.

Télécharger le fichier Update.tar.gz, le décompresser dans le dossier d'installation du soft avec la commande:

% tar -xzf Update.tar.gz

Ensuite, rendre exécutable ce script (en python) de la manière suivante:

% chmod u=rwx Update.py

Créer le dossier patch (avec une minuscule) au besoin

% mkdir patch

Dès maintenant, chaque mise à jour se fera de la manière suivante :

• Télécharger le patch Patch_vXrY.tar.gz
• Le mettre dans votre dossier patch, et le décompresser par la commande:

% tar -xzf Patch_vXrY.tar.gz

• Ensuite, dans le dossier d'installation, entrer la commande:

% ./Update.py

• Si tout se passe bien, le message "Mise à jour terminée" s'affiche et tout marche bien, le soft est prêt à fonctionner. Dans le fichier changelog.txt la liste des fichiers modifiés est affichée.

Pour savoir quelle version du programme est actuellement installée sur votre machine, lancer

% ./Update -V

Une petite aide de l'updater est disponible avec l'option -h.

Si l'exécution donne beaucoup de sortie sur terminal, il suffit d'ouvrir Update.py avec votre éditeur favori et de vérifier les lignes suivantes :

DEBUG = False;
CONTROL = False;

Programmes créés

Les programmes sont lancés à partir de scripts shell (eh oui, de nouveau), qui ont les mêmes noms, à l'extension près. Ces scripts gèrent non seulement le lancement, mais aussi le réglage des variables nécessaires à la bonne exécution des programmes. L'appel direct à un programme, sans passer par le script dédié peut donc provoquer un plantage à l'exécution. La commande pour lancer un programme est simplement :

% ./Nom_du_programme arguments

Programme	utilisation
NouveauJoueur	crée un nouveau Perso, puis le sauve dans un format lisible pour le reprendre plus tard. A exécuter pour construire votre feuille de perso. Attention, si le nom de votre personnage contient un apostrophe, le faire précéder dans la saisie par un backslash "\". Ex: Bob l'Eponge devient Bob l\'Eponge.
EcrireJoueur	crée les fichiers .tex finaux. Le script de lancement gère aussi la compilation et l'affichage de la feuille de perso.
EvolutionJoueur	fait évoluer le joueur, c'est à dire permet l'augmentation des XP et PP, fait passer les niveaux.
AjouterSorts	permet de paramétrer les sorts accessibles au perso.
ApercuJoueur	permet de faire un affichage succinct des compétences et capacités du personnage.

Contrôle lors de l'exécution

Par le biais du fichier CONFIG, il est possible de paramétrer les différents niveaux de sortie des multiples fonctions utilisées. Le fichier contient une brève explication des différents niveaux utilisés. Pour une utilisation normale, tous les niveaux sont réglé sur "BLANK". Si un bug survient, ces paramètres aident à en identifier la cause.

Que faire en cas de bug?

• Quel est le programme incriminé?
• Ouvrir le fichier CONFIG et mettre les niveaux de sortie sur FUNC, puis relancer le programme, afin de connaître la fonction qui cause le crash du programme.
• Poster sur la page des [BugsConnus] le nom du programme, le nom de la fonction qui plante et comment est-ce arrivé.

Paramétrage de la sortie

Comme tout le monde n'aime pas le dvi (pas très portable c'est vrai) et que surtout tout le monde n'utilise pas kdvi, j'ai mis un script (en python) qui permet de changer le format et le programme utilisé ensuite pour lire les feuilles de perso créées. Si votre seul but est d'imprimer vite fait les feuilles, je conseille de laisser le format par défaut (dvi donc). Pour pouvoir ouvrir ses feuilles de perso sur n'importe quelle bécane, alors là ben c'est le pdf, c'est clair! Si vous êtes un gros moche :P, y'a possibilité de faire du postscript (ps). Pour le programme de lecture, entrez simplement la commande que vous lanceriez dans votre terminal: si vous êtes un fan de ghostview, entrez gv, acroread pour Acrobat Reader, etc...

La commande à lancer pour paramétrer tout ça est %./OUTPUT.py.