# Wormux documentation

## Introduction

Wormux est un clone libre de Worms. Il est encore en phase de développement intensif, ne vous étonnez donc pas de rencontrer une "Assertion xxx failed." ou carrément un "segfault". Par contre, le jeu a atteint un niveau de maturité qui le rend complètement jouable :

- 10 armes implémentées : dynamite, bazooka, bazooka à tête chercheuse, pistolet, batte de baseball, grenade, téléportation, suicide, attaque aérienne, mine
- Apparition de caisse bonus
- Déplacement de la caméra à la souris ou avec le pavé numérique du clavier
- Possibilité de jouer avec un nombre arbitraire d'équipe (après c'est plus la taille du terrain qui limite, car les vers sont séparés d'une distance minimale :-))
- Les équipes sont clairement identifiées (avatars et écussons différents)
- Comptabilisation des munitions des armes
- Compteur du temps pour chaque tour, avec 2 secondes de pause entre chaque tour
- Une dizaine de type de personnages différents : alien, ball, escargot, haypocampe, poule, poulpe, tortue, ver, wougzy, xbill.
- Une dizaine de terrains
- Présence d'un menu options (encore à compléter). Le reste est facilement configurable dans les fichiers *.xml situés dans le répertoire "donnée"
- Des traductions dans plusieurs langues : anglais, espagnol, allemand, catalan, polonais,...
- etc.

## Principe du jeu

Le principe du jeu est simple. Vous disposez en début de la partie d'une équipe de 5 personnages. Votre adversaire (humain) possède lui aussi 5 personnages. Ils sont placés de manière aléatoire sur le terrain.

Un premier personnage est sélectionné par le jeu. A partir de là, il ne vous reste plus qu'à sélectionner une arme de votre choix afin d'éliminer les "monstres" adverses. La partie est terminée lorsqu'il n'y a plus qu'une équipe !

Attention, si vous sortez de l'espace de jeu (typiquement : bords droit et gauche de l'écran), votre personnage va mourir !

En cas de chute importante, vous perdez votre tour (le personnage doit se remettre de ses émotions :-)).

Pour faire défiler le plateau de jeu, restez appuyé sur la touche CTRL, puis déplacez la souris. Il est également possible d'utiliser le clavier (voir la section 3 de ce document).

Des caisses bonus peuvent apparaître (dans les terrains ouverts). Elles contiennent des bonus aléatoires : munitions pour les différentes armes, gain voir même perte d'énergie.

## Contrôle au clavier

Touches | Description
--- | ---
Gauche/Droite | Se déplacer latéralement
Entrée | Sauter
Backspace | Super saut (vertical)
Espace | Tirer (note: certaines armes nécessites un clic de souris préalable, en particulier le bazooka à tête chercheuse)
Haut/Bas | Déplacer le viseur (pour le pistolet par ex.)
F1 à F4 | Changer d'arme (F1 pour les armes de classe 1, etc.)
F9 | Affiche/cache l'interface
F10 | Passer du mode plein écran au mode fenêtre.
C | Rececentrage sur le personnage actif
TAB | Passe au personnage suivant de son équipe (pas toujours disponnible, celà dépend du mode de jeu)
T | Passer son tour.
P | Mettre le jeu en pause (ou reprise du jeu)
M | Affiche le menu des armes (inactif pour l'instant)
Page haut/bas | Accélère/ralentit la vitesse du jeu (*)
4, 6, 8, 2 (PN.) | Déplace la caméra
Echap | Quitter Wormux.

- (*) : Astuces activées uniquement en mode "débogage".
- PN. : Pavé numérique.

## Contrôle à la souris

Pour déplacer la caméra, restez appuyé sur la touche CTRL puis déplacez votre souris.

- Clic gauche : Sélectionner le ver survolé, tirer avec une arme ou choix d'une arme dans le menu.
- Clic droit : Affiche/cache le menu des armes.

## Configuration

Pour changer de terrain et choisir vos équipes, allez dans le menu Options.

### Nouvelle équipe

Pour vous créer une nouvelle équipe, allez dans le répertoire data/team/. Chaque sous-répertoire est une équipe. Une équipe a un écusson (fichier PNG ecusson.png d'une taille de 48x48 pixels). Le nom des personnages et le nom de l'équipe sont définis dans team.xml. Chaque personnage peut avoir une apparence différente, c'est l'attribut "avatar".

### Configuration avancée

Pour une configuration plus avancée, voyez les fichiers XML suivants :

- data/game_mode/*.xml : Les différents modes de jeu
- ~/.wormux/config.xml : Configuration principale

## Bêta test du jeu

Afin d'aider le jeu a être plus beau, plus rapide, et plus stable : je vous invite à signaler tout comportement du jeu qui vous semble anormal (message d'erreur indiqué par le jeu, Linux, ou Windows, ...). Mais aussi à donner votre avis sur les graphismes, les options du jeu, etc.

Ce jeu est un logiciel libre. Vous pouvez librement y contribuer. Il suffit pour ça de nous contacter.

## Contacts et liens

Pour plus d'informations, visitez notre site Internet

Envoyez-nous vos critiques par email sur notre liste de diffusion

L'équipe de Wormux