Getting Started
From zero to dancing penguin in under 5 minutes.
1System Requirements
| Platform | Requirement | How to Install |
|---|---|---|
| All | Java 8+ | Adoptium or Oracle JDK |
| All | Maven 3.6+ | Auto-installed by launcher scripts |
| Linux | libhidapi | sudo apt install libhidapi-hidraw0 libhidapi-dev |
| Linux | espeak (for TTS) | sudo apt install espeak |
Hardware: Tux Droid robot with its USB “Fishtank” dongle (VID: 0x03eb, PID: 0xFF07).
2Installation
Windows (One-Click)
powershell
# Clone the repository
git clone https://github.com/Scayar/ScayTux
cd ScayTux
# Double-click to run (or from terminal):
START_WINDOWS.batThe batch file automatically installs portable Maven, builds the project, and launches Interactive Mode.
Linux (One-Command)
bash
git clone https://github.com/Scayar/ScayTux
cd ScayTux
chmod +x START_LINUX.sh && ./START_LINUX.shAutomatically installs OpenJDK, Maven, espeak, libhidapi, and configures udev rules for USB access.
Manual Build (Any Platform)
bash
git clone https://github.com/Scayar/ScayTux
cd ScayTux
mvn clean package -DskipTests
java -jar target/ScayTux.jar3Linux USB Permissions
The launcher script handles this automatically, but for manual setup:
bash
# Create udev rule for Tux Droid dongle
sudo bash -c 'cat > /etc/udev/rules.d/99-tuxdroid.rules << EOF
SUBSYSTEM=="usb", ATTR{idVendor}=="03eb", ATTR{idProduct}=="ff07", MODE="0666", GROUP="plugdev"
KERNEL=="hidraw*", ATTR{idVendor}=="03eb", ATTR{idProduct}=="ff07", MODE="0666", GROUP="plugdev"
EOF'
# Reload rules and add yourself to plugdev
sudo udevadm control --reload-rules
sudo udevadm trigger
sudo usermod -aG plugdev $USER
# Log out and back in for group changes to take effect4First Run
Launch ScayTux with no arguments to enter Interactive Mode:
bash
java -jar target/ScayTux.jar[ MAIN MENU ]
1. Interactive Menu (Select combos by number)
2. Manual / REPL Mode (Type commands freely)
3. Telegram Control (Control via Telegram Bot)
4. Exit
Select option 1 to browse combos, option 2 to type commands manually, or option 3 to set up Telegram remote control.