diff --git a/README.md b/README.md index 3e3e740..63d7374 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ # Dungeon Battle -M1 Software engineering project +Projet de génie logiciel de M1 ## Création d'un environnement de développement @@ -33,3 +33,70 @@ Il est toujours préférable de travailler dans un environnement Python isolé d (env)$ pip3 install -r requirements.txt (env)$ deactivate # sortir de l'environnement ``` + +### Exécution des tests + +Les tests sont gérés par `pytest` dans le module `dungeonbattle.tests`. + +`tox` est un outil permettant de configurer l'exécution des tests. Ainsi, après +installation de tox dans votre environnement virtuel via `pip install tox`, +il vous suffit d'exécuter `tox -e py3` pour lancer les tests et `tox -e linters` +pour vérifier la syntaxe du code. + + +## Lancement du jeu + +Il suffit d'exécuter `python3 main.py`. + +## Gestion des émojis + +Le jeu dispose de deux modes graphiques : en mode `ascii` et `squirrel`. +Le mode `squirrel` affiche des émojis pour un meilleur affichage. Toutefois, +il est possible que vous n'ayez pas les bonnes polices. + +### Sous Windows + +Sous Windows, vous devriez avoir les bonnes polices installées nativement. + +### Sous Arch Linux + +Il est recommandé d'utiliser le terminal `xfce4-terminal`. Il suffit d'installer +le paquets de polices + +```bash +sudo pacman -Sy noto-fonts-emoji +``` + +Le jeu doit ensuite se lancer normalement sans action supplémentaire. + +### Sous Ubuntu/Debian + +À nouveau, le terminal `xfce4-terminal` est recommandé. Le paquet +`fonts-noto-color-emoji`. Toutefois, le rythme de mise à jour de Debian étant +lent, le paquet le plus récent ne contient pas tous les émojis. Sur Debian, +il faudra donc installer le paquet le plus récent, ce qui fonctionne sans +dépendance supplémentaire : + +```bash +wget http://ftp.fr.debian.org/debian/pool/main/f/fonts-noto-color-emoji/fonts-noto-color-emoji_0~20200916-1_all.deb +dpkg -i fonts-noto-color-emoji_0~20200916-1_all.deb +rm fonts-noto-color-emoji_0~20200916-1_all.deb +``` + +Il reste le problème de l'écureuil. Sous Ubuntu et Debian, le caractère écureuil +existe déjà, mais ne s'affiche pas proprement. On peut appliquer un patch qui +permet d'afficher les émojis correctement dans son terminal. Pour cela, il + suffit de faire : + +```bash +ln -s $PWD/fix-squirrel-emojis.conf /etc/fonts/conf.avail/75-fix-squirrel-emojis.conf +ln -s /etc/fonts/conf.avail/75-fix-squirrel-emojis.conf /etc/fonts/conf.d/75-fix-squirrel-emojis.conf +``` + +Après redémarrage du terminal, l'écureuil devrait s'afficher correctement. + +Pour supprimer le patch : + +```bash +rm /etc/fonts/conf.d/75-fix-squirrel-emojis.conf +``` diff --git a/fix-squirrel-emojis.conf b/fix-squirrel-emojis.conf new file mode 100644 index 0000000..f47023e --- /dev/null +++ b/fix-squirrel-emojis.conf @@ -0,0 +1,118 @@ + + + + + + + + + emoji + Noto Color Emoji + + + + + + + sans + Noto Color Emoji + + + + serif + Noto Color Emoji + + + + sans-serif + Noto Color Emoji + + + + monospace + Noto Color Emoji + + + + + + + + + + Symbola + + + + + + + + + + Android Emoji + Noto Color Emoji + + + + Apple Color Emoji + Noto Color Emoji + + + + EmojiSymbols + Noto Color Emoji + + + + Emoji Two + Noto Color Emoji + + + + EmojiTwo + Noto Color Emoji + + + + Noto Color Emoji + Noto Color Emoji + + + + Segoe UI Emoji + Noto Color Emoji + + + + Segoe UI Symbol + Noto Color Emoji + + + + Symbola + Noto Color Emoji + + + + Twemoji + Noto Color Emoji + + + + Twemoji Mozilla + Noto Color Emoji + + + + TwemojiMozilla + Noto Color Emoji + + + + Twitter Color Emoji + Noto Color Emoji + + + +