diff options
| author | Ludovic Pouzenc <ludovic@pouzenc.fr> | 2011-05-14 19:31:52 +0000 |
|---|---|---|
| committer | Ludovic Pouzenc <ludovic@pouzenc.fr> | 2011-05-14 19:31:52 +0000 |
| commit | a78cf8caf05e0c8072bf8616585d0105fe5ab1e2 (patch) | |
| tree | cfb1143e98b1c077db52ba0c2821d46d29abfe81 | |
| parent | 5662dc52b0b58d90a58e46cb0ac194047bfed57e (diff) | |
| download | 2010-netlemmings-a78cf8caf05e0c8072bf8616585d0105fe5ab1e2.tar.gz 2010-netlemmings-a78cf8caf05e0c8072bf8616585d0105fe5ab1e2.tar.bz2 2010-netlemmings-a78cf8caf05e0c8072bf8616585d0105fe5ab1e2.zip | |
Ajout d'un script pour trouver les TODOs dans le code, et création d'un fichier concepion.txt (syntaxe dokuwiki) pour documenter un peu le projet (TBC)
git-svn-id: file:///var/svn/2010-netlemmings/trunk@219 077b3477-7977-48bd-8428-443f22f7bfda
| -rw-r--r-- | doc/conception.txt | 24 | ||||
| -rwxr-xr-x | scripts/find-todos.sh | 4 |
2 files changed, 28 insertions, 0 deletions
diff --git a/doc/conception.txt b/doc/conception.txt new file mode 100644 index 0000000..6fe61cd --- /dev/null +++ b/doc/conception.txt @@ -0,0 +1,24 @@ += Conception = +== Modules == +=== Communs === +==== Events ==== +Le module events permet de gérer une liste d'évènements qui correspondent a des actions d'un joueur. +A un instant donné e.eventTick (daté par le client source de l'évènement), le client e.clientId a généré un évènement de type e.type. + +Les informations complémentaire de l'évènement dépendent de son type : + * eReady : Signifie que le joueur sur le client en question signale qu'il est prêt à commencer une partie + * eTimeSync : Le client signale l'état de son horloge et attends une réponse du serveur pour se synchroniser. Ces évènements sont gérés si la fréquence des actions de l'utilisateur ne suffit pas à garder une synchronisation suffisante. + * eLemAction : Signifie que le joueur a donné un ordre a un des ses lemmings + * le champ e.lemId désigne le lemming sur lequel l'action porte + * le champ e.nomRole désigne le nouveau rôle (ou skill) affecté au lemming + +Le module permet de gérer la liste d'évènements, de la trier chronologiquement (utilisé par le serveur), de la sérialiser et désérialiser pour la transférer via le réseau et comporte un méchanisme d'accès exclusif (eventListLock/eventListUnlock). + +==== Utils ==== +Ce module regroupe toutes les fonctions "techniques" commune au serveur et au client : gestion des logs, fonctions mathématiques. + +=== Timing ==== +Fonctions communes à l'algorithme de synchronisation des horloges des clients par rapport au serveur. + +=== Serveur === +=== Client === diff --git a/scripts/find-todos.sh b/scripts/find-todos.sh new file mode 100755 index 0000000..421a029 --- /dev/null +++ b/scripts/find-todos.sh @@ -0,0 +1,4 @@ +#/bin/bash +REGEX='\(XXX\|TODO\|FIXME\)' + +grep --color=yes -C 3 --exclude '*.svn*' -Re $REGEX ../src | less -r |