    FreedroidRPG : Lisez-moi
   ----------------------

0. Sommaire
=========
  1. Introduction
  2. Installer & Jouer
  3. Contrôles de base
  4. Problèmes connus
  5. Résolution d'écran
  6. FAQ
     - Divers
     - Graphismes
     - Sons
     - Éditeur de niveau & Développeur
  7. Contactez-nous
  8. Licence


1. Introduction
================
 Le jeu raconte l'histoire d'un monde ravagé par un conflit entre les 
 robots et leurs maîtres humains. Joue Tux dans une quête pour sauver
 le monde de robots rebelles mortels ; ils ne connaissent aucune pitié. 
 Tu as à choisir quel chemin tu veux emprunter, la liberté de choix
 est partout dans le jeu.

 FreedroidRPG dispose d'un système de combat temps réel avec des armes
 distantes et de corps-à-corps, assez semblable au jeu propriétaire Diablo. Il propose un
 système innovant de programmes pouvant être utilisés pour prendre
 le contrôle des robots ennemis, modifier leur comportement, ou améliorer les
 caractéristiques personnelles. Tu peux utiliser plus de 150 objets divers, et
 combattre d'innombrables ennemis sur le chemin vers ta destinée. Un système 
 avancé de dialogues sert de base à l'histoire et à une réelle immersion dans ce
 jeu de rôle.

 Le jeu est complet, totalement jouable, et permet plus de 10 heures
 de plaisir. Il est toujours activement développé, et toute aide est bienvenue, 
 dans divers domaines. Les personnes ayant - ou désirant acquérir - des compétences en
 programmation, création de cartes ou de dialogues trouveront en FreedroidRPG un
 projet très actif dans lequel exprimer leur créativité.

2. Installer & Jouer
===========
 Pour une aide plus général avec l'installation, se référer au fichier INSTALL situé dans le même dossier que celui-ci.
 Instructions spécifique pour Ubuntu : http://ubuntuforums.org/showthread.php?p=6127097#post6127097

 Pour démarrer le jeu, il suffit normalement de lancer l’exécutable.
 Pour les options avancées, exécuter "freedroidRPG --help" (dans un terminal) pour récupérer une liste des options disponible en ligne de commande.


3. Contrôles de base
============
 Mouvement
 
  Le jeu est contrôlé en utilisant la souris. Click gauche vers l'endroit où tu veux bouger. Maintiens
  le bouton appuyé pour continuer à bouger dans cette direction. Maintenir la touche CTRL te permet de courir.

 Attaque 

  Un clic gauche sur un ennemi amène Tux à s'approcher du robot et déclenche une attaque avec
  l'arme courante. Si c'est une arme à feu, Tux reste sur place et tire sur le robot.

 Fonctions spéciales

  Cliquer avec le bouton droit de la souris pour activer les compétences sélectionnées.

 Touches par défaut (la plupart des touches peuvent être redéfinies dans le panneau des raccourcis clavier - F1)

  Échap ... Afficher le menu principal
  F1 ... Afficher les raccourcis clavier
  F2 ... Basculer le mode plein-écran (Linux seulement)
  F3 ... Sauvegarder
  F4 ... Charger
  F5-F12 ... Choisir rapidement les programmes 1 à 8

  I ... Afficher l'inventaire
  C ... Afficher le personnage
  S ... Afficher les compétences
  Espace ... Fermer tous les panneaux ouverts
  Q ... L'historique des quêtes
  0-9 ... Utiliser les items 0 à 9 de l'inventaire rapide

  P ... Pause
  Enfoncer A ... Attaquer tout en restant à la même position
  Enfoncer Majuscule ... Garder la cible courante sélectionnée pendant les déplacements
  Tab ... Basculer l'affichage de l'auto-carte (si disponible)

  R ... Recharger
  Enfoncer Ctrl ... Courir
  U ... Basculer le mode "toujours courir"

  Enfoncer X ... Afficher la description des items au sol
  Z ... Basculer l'affichage de la description des items au sol
  T ... Basculer l'affichage transparent des murs proches de Tux
  Ctrl + Q ... Quitte le jeu
  Ctrl + G ... Basculer l'acquisition pointeur (empêche le curseur de sortir de la fenêtre du jeu)
  Impr ... Copie d'écran (enregistré dans le répertoire .freedroid_rpg du répertoire utilisateur)

  Flèches ... Déplacement
     Haut ... Nord
     Bas ... Sud
     Droite ... Est
     Gauche ... Ouest


4. Problèmes connus
================
 Général
   * Quelques armes ont encore une représentation par défaut (sabre laser / fusil) quand elles sont tenues par Tux
	 ou durant les animations d'attaques. Si tu es doué en modélisation 3D, tu peux nous aider à améliorer ce point.
   * Lorsque le jeu est démarré en mode OpenGL, et qu'une fenêtre est placé devant celle du jeu durant le démarrage, il est possible que l'image de fond soit bizarre. En cliquant sur une des entrés du menu, elle devrait se ré-afficher normalement. 
	 up, the background images looks very strange. If you click on one of the menu items, it should return to
	 looking as intended.
   * Alt tab in/out of the game in OpenGL while a static popup is displayed makes the screen completely black.
	 Clicking or pressing the required key to close the popup will redraw/bring back the screen.

 Mac
   * Open Files: OSX max number of open files defaults to 256 (as of 10.6). This can lead to errors when
	 loading images: "In Function: get_iso_image_from_file_and_path. Could not load image
	 /usr/local/share/freedroidrpg/graphics/obstacles/<filename>.png"
	 Solution:
		1) Check value of open files limit with $ ulimit -n
		2) Set new value for open files limit with $ ulimit -n 2048
	(issue #2913487)
   * Font rendering: If you get no fonts in the main menu with SDL or if in openGL mode, the game dies
	with the error message "In Function: PutCharFont. Surface for character 46 was NULL pointer!",
	check your display configuration and set the color profile to sRGB.
	(issues #2913485 and #2913484)
   * SDL installed via MacPorts: SDL installed via MacPorts will give freedroidRPG wrong information
	about the byteorder if you have a big-endian (PowerPC) CPU, so the colors may be wrong and you
	probably couldn't start a new game because FreedroidRPG crashes.
	To fix it, with root privileges edit the /opt/include/SDL/SDL_config.h file so the line
		#define SDL_BYTEORDER=1234
	says
		#define SDL_BYTEORDER=4321
	After editing and saving the file recompile freedroidRPG and it should work correctly.
	Using SDL compiled from source instead of from MacPorts will work as well.

 Linux
   * Pulseaudio: Using SDL-pulseaudio you are currently likely not to get sound. This has nothing to do
	 with FreedroidRPG but with Pulseaudio and its plugins still in general being immature. We recommend using
	 e.g. SDL-esd or SDL-alsa until these problems has been fixed upstream.
   * Intel 915/945/IDG graphics cards (EEE PCs, netbooks, etc): Mesa 7.9-devel has an issue which makes the game
   	 run slowly and consume a lot of memory. It is fixed by installing and launching 'driconf' and setting 
	 'Enable texture tiling' to 'No'.   
   * Due to hardware and software drivers, the "Gamma Correction" option may affect nothing.

5. Résolution d'écran
=====================
 There are a few hidden high resolution settings only accessible from command line. They are badly tested
 and thus generally considered to be buggy and are unsupported. They however can still be quite useful for
 many, especially for widescreen LCDs in fullscreen mode.

 Pour obtenir une liste à jour des résolutions disponibles, utilise "freedroidRPG -r99".

 Some known issues for the unsupported resolutions:
	- Portrait image in dialogs overflows its borders
	- Off center light radius
	- Incorrect text scrolling when talking to NPCs at times


6. FAQ
============
Miscellaneous FAQ:

	Q : Dois-je avoir Linux pour essayer FreedroidRPG ?
	A: While using Linux is greatly recommended for the sanity of the system
	   administrator, FreedroidRPG has MS-Windows executables available.
	   Note that since the FreedroidRPG development team doesn't use 
	   MS-Windows, it gets much less testing. Help with testing and feedback 
	   from Windows users thus is greatly appreciated.

	Q: How can I subscribe/unsubscribe to the mailing list?
	A: FreedroidRPG has two mailing lists. One is for discussing stuff related to
	   FreedroidRPG, the other one is a list with auto-generated change logs from our 
	   developer server and therefore usually only interesting for developers themselves.
	   In any case, you can subscribe, unsubscribe or change your membership options
			from the following web page:
	   http://sourceforge.net/mail/?group_id=54521


FAQ Graphismes :

	Q : Le jeu est *extrêmement* lent sur mon système Windows avec le rendu OpenGL.
	R : Il se peut que vous utilisez les drivers OpenGL qui viennent avec votre système
	   d'exploitation de Microsoft. Ces drivers n'utilisent pas l’accélération matérielle driver et
	   sont donc extrêmement lent. Vous devriez télécharger et installer un vrai driver capable
	   d'utiliser OpenGL avec votre carte graphique. Habituellement, ils peuvent être télécharger 
	   sur la page d'accueil du constructeur de la carte graphique, comme Nvidia, AMD/ATI,
	   etc. Note, that if you do absolutely cannot get OpenGL working reliably on your
	   system, you can still run the game in pure SDL output mode. For this, you
	   must either use a 'MS-DOS command line prompt' and type

	   freedroidRPG -n 

	   inside this command line, or you can also make a link to freedroidRPG.exe
	   and then edit the link properties and add the -n after freedroidRPG.exe in
	   the link properties dialog box.

	Q : Le jeu est *extrêmement* lent sur ma machine Linux avec OpenGL activé.
	R : La raison pour ça pourrait bien être que vous n'utilisez pas l'accélération matérielle d'OpenGL.
	   Software OpenGL should be avoided.  If you don't have hardware-accelerated
	   OpenGL on your system (because e.g. your graphics card manufacturer doesn't
	   make suitable Linux drivers), you might be much better off when disabling
	   OpenGL support altogether.  For this, you can use command line switch -n,
	   i.e type

	   freedroidRPG -n

	   to start the game with OpenGL output disabled.  Graphics will revert to
	   pure SDL mode.
	Q: I run Linux with multiple monitors in TwinView (Xinerama) mode, however fullscreen
	   mode is centered over the break between the two monitors. I would rather it be
	   centered on one of the screens.
	A: To have the game use only one monitor for fullscreen mode, do the following:
	   1)  Make certain you use SDL version >=1.2.14.
	   2)  Set the environmental variable "SDL_VIDEO_FULLSCREEN_DISPLAY" to the number corresponding to
			the monitor you wish to use: 0 is your first display, 1 is your second, etc.

	   If that does not work you may have to add single-monitor metamodes to your xorg.conf file.
	   Modifications to xorg.conf require a restart of the X server before they take effect.

FAQ Sons :

	Q : Mon son ne fonctionne pas avec FreedroidRPG. Je n'étends rien.
	R : 1.) Assurez-vous que votre son fonctionne avec les autres applications. Si vous
		    n’entendez rien quand vous essayez de jouer des fichiers mp3 ou ogg, alors
		    le système sonore de votre machine n'est pas correctement configuré et ce n'est
		    pas un problème relaté à FreedroidRPG. Dans ce cas, vous devriez installer votre
		    carte audio proprement en premier.
	   2.) Regardez si vous avez la librairie SDL_mixer installée. Vous pourriez vouloir
		    utliser "locate SDL_mixer" et regarder si vous obtenez beaucoup de résultat.
		    Sinon, alors la librairie SDL_mixer absente est le problème,
		    Vérifiez aussi si vous avez libogg et libvorbis d'installés.
	   3.) Si vous compilez depuis les sources, assurez-vous que le script ./configure a
		    correctement détecté la librairie SDL_mixer. Regardez juste la sortie de ./configure.
		    Il devrait y avoir une ligne comme ça :

		      checking for Mix_ChannelFinished in -lSDL_mixer... yes

		    Si vous obtenez quelque chose plutôt comme ça :

		      checking for Mix_ChannelFinished in -lSDL_mixer... no

		    alors le script ./configure n'a pas détecté votre installation de SDL_mixer.
		    Vous pourriez vouloir vous assurez que vous avez bien les paquets SDL_mixer et 
		    SDL_mixer_devel installés ou installé SDL_mixer avec les sources.
		    Vous pouvez télécharger tout à partir de ce site :

		      http://www.libsdl.org/projects/SDL_mixer/

		    Si vous compilez depuis vos sources, vous avez à recompiler maintenant, parce que
		    la compilation précédente n'incluez pas le module son de FreedroidRPG. Si
		    la librairie SDL_mixer est correctement installez, les son devrez fonctionner après
		    la recompilation.

	Q: My sound is lagging behind. Every sound seems to be somewhat out of sync.
	A: There might be a sound daemon running on your system.  Many window managers
	   like e.g. KDE start a sound daemon by default upon start up. To get rid of
	   the most common sound daemons, you can try (best as root)

	   killall -9 artsd
	   killall -9 esd
	   killall -9 yiff
	   killall -9 pulseaudio

	   After that, you might want to try freedroidRPG again. The sound lag should
	   not be present anymore.

FAQ Éditeur de Niveau & Développeur :

	Q : Y a-t-il un Éditeur de Niveau ?
	R : Oui, nous avons un éditeur de niveau intégré dans FreedroidRPG. Il est accessible à partir
       du menu ou en exécutant

		  freedroidRPG -e

       It has tooltips on every button to help you find your
       way. Play around with it a bit by yourself and don't hesitate to ask for
       assistance on IRC or the mailing list.

	Q: How can I get the latest development version of the game?
	A: This is very simple when using Linux. You can find the details here:
	   https://sourceforge.net/svn/?group_id=54521
	   If you are using Windows we recommend using a tool like 
	   http://tortoisesvn.tigris.org/
	   If you still run into problems, best again discuss it with the people on
	   the freedroid-discussion mailing list.

	Q : Je veux aider dans le développement de FreedroidRPG. Qu'est ce que je devrais faire en premier ?
	A : Premièrement, nous recommandons de lire http://www.freedroid.org/developer-area/contribute/ (en anglais)
	   La seconde chose est de nous contactez. Cela peut être fait via IRC (voir 'Contact' plus bas)
	   or using the freedroid-discussion mailing list.
	   Then the next thing to do is to get the latest development version of the game
	   from git, then to either make a small patch right away or to discuss anything
	   bigger you have in mind with the people on the discussion mailing list or IRC, so
	   it can be assured that all the developers are pulling in the same direction and
	   know what's going on and who is working on what.
	   If you are new to the Sourceforge, you should also take at least a brief look
	   at our Sourceforge project pages. You can find the main page here
	   http://sourceforge.net/projects/freedroid
	   and other relevant pages should be reachable from there.



7. Contactez-nous
===========
 Site web ................ http://www.freedroid.org
 IRC channel   ................ #freedroid on irc.freenode.net or
								http://webchat.freenode.net/?channels=freedroid (requires Javascript)
 Mailing list  ................ freedroid-discussion@lists.sourceforge.net
 Page du projet Sourceforge ... http://sourceforge.net/projects/freedroid/
 Bug tracker   ................ http://bugs.freedroid.org/


8. Licence
===========
 Le jeu lui-même est sous licence GPL. D'autre outils utilisent une licence plus permissive, 
 référez-vous au fichier FILES situé dans le même dossier que celui-ci.
