TuxGo
=====

Dedication
----------

*To my Daughters: Marta, Ola and Klara.*

Hardware requirements
---------------------

Control box
^^^^^^^^^^^
- Raspberry Pi 4+ or later
- Camera (tested with Camera Module 3)
- Monitor that can be rotated to vertical (tested on 1024x1280)
- Keyboard

Robot
^^^^^
- bbc:microbit v1
- DFRobot Maqueen

It is technically possible to write firmware for any robot that can connect over
Bluetooth LE. Contributions are welcome.

Getting started
---------------

- Install RaspberryPi OS (at least 12/bookworm) on the SD card, as documented in
  RPi documentation.
- Connect camera, keyboard and display.
- Start RPi and configure screen to vertical.
- Install dependencies:

  .. code-block:: sh
  
      sudo apt-get install \
          python3-bleak \
          python3-click \
          python3-click-default-group \
          python3-flask \
          python3-funcparserlib \
          python3-loguru \
          python3-matplotlib \
          python3-opencv \
          python3-pygame \
          python3-werkzeug

- Run the game:

  .. code-block:: sh

      python3 -m tuxgo

Acknowledgements
----------------

See ``Documentation/acknowledgements.rst``

.. vim: tw=80 ts=4 sts=4 sw=4 et