diff --git a/docs/index.rst b/docs/index.rst index eb45600..cc0d0f7 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,5 +1,5 @@ Bienvenue dans la documentation de Squirrel Battle ! -=========================================== +==================================================== .. toctree:: :maxdepth: 2 diff --git a/docs/troubleshooting.rst b/docs/troubleshooting.rst new file mode 100644 index 0000000..0afb0e5 --- /dev/null +++ b/docs/troubleshooting.rst @@ -0,0 +1,59 @@ +#################### +Résolution d'erreurs +#################### + +====== +Émojis +====== + +Le jeu s'exécutant en terminal, il est courant d'obtenir des problèmes d'affichage. +Sous Windows, les émojis s'affichent normalement correctement. Il suffit en +général d'installer les bons paquets de police. + +--------------- +Sous Arch Linux +--------------- + +Il est recommandé d'utiliser le terminal `xfce4-terminal`. Il suffit d'installer +le paquets de polices : + +.. code:: 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 : + + +.. code:: 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 : + +.. code:: 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 : + +.. code:: bash + + rm /etc/fonts/conf.d/75-fix-squirrel-emojis.conf