Installation client
===================

Installation
------------

Différents paquets sont déployés, dans PyPI pour tout système utilisant Python,
un paquet Debian et un paquet Arch Linux.

Depuis PIP
~~~~~~~~~~

.. _PyPI: https://pypi.org/project/squirrel-battle/

Le projet `Squirrel Battle` est déployé dans PyPI_. Il suffit d'installer
Squirrel Battle en exécutant :

.. code:: bash

  pip install --user squirrel-battle

Les mises à jour s'obtiennent également via PIP en exécutant :

.. code:: bash

  pip install --user --upgrade squirrel-battle

Le jeu peut se lancer ensuite en exécutant la commande ``squirrel-battle``.

Toutefois, le paquet PyPI n'inclut pas les polices d'émojis. Il est recommandé
d'installer des polices telles que ``noto-fonts-emoji`` afin de prendre en charge
les émojis dans votre terminal.


Sur Arch Linux
~~~~~~~~~~~~~~

.. _AUR: https://aur.archlinux.org/
.. _python-squirrel-battle: https://aur.archlinux.org/packages/python-squirrel-battle/
.. _python-squirrel-battle-git: https://aur.archlinux.org/packages/python-squirrel-battle-git/
.. _yay: https://aur.archlinux.org/packages/yay/

Deux paquets sont publiés dans l'AUR_ (Arch User Repository) :

- python-squirrel-battle_
- python-squirrel-battle-git_

Le premier paquet est mis à jour à chaque nouvelle version déployée, le second
est utile pour des fins de développement et est en permanence à jour
avec la branche ``master`` du Git.

Les deux ne sont pas présents dans les dépôts officiels de Arch Linux, mais vous
pouvez les récupérer avec un outil tel que yay_.

Les paquets incluent la dépendance ``noto-fonts-emoji``, qui permet d'afficher
les émojis dans le terminal.

Le jeu peut être ensuite lancé via la commande ``squirrel-battle``.


Sur Ubuntu/Debian
~~~~~~~~~~~~~~~~~

.. _paquet: https://gitlab.crans.org/ynerant/squirrel-battle/-/jobs/artifacts/master/raw/build/python3-squirrelbattle_23.14_all.deb?job=build-deb

Un paquet_ est généré par l'intégration continue de Gitlab à chaque commit.
Ils sont également attachés à chaque nouvelle release.

Il dépend du paquet ``fonts-noto-color-emoji``, permettant d'afficher les émojis
dans le terminal. Il peut être installé via APT.

Pour installer ce paquet, il suffit de le télécharger et d'appeler ``dpkg`` :

.. code:: bash

  dpkg -i python3-squirrelbattle_23.14_all.deb

Ce paquet inclut un patch pour afficher les émojis écureuil correctement.

Après cela, le jeu peut être lancé grâce à la commande ``squirrel-battle``.