Skip to content

🎱 PoolMind - Quick Start

📖 Main Documentation: For complete installation guide and project overview, see the main README.md

🚀 One-Line Installation

Raspberry Pi Auto-Installation: 

curl -fsSL https://raw.githubusercontent.com/mrwogu/PoolMind/main/install.sh | bash

Development Setup: 

git clone https://github.com/mrwogu/PoolMind.git
cd PoolMind
./scripts/setup/setup.sh

📋 Hardware Setup

Required Hardware

  • Raspberry Pi 4 (4GB+ RAM recommended)
  • USB Camera (1080p+) with overhead mounting
  • Pool Table with space for markers
  • Printer for ArUco markers

Camera Positioning (Critical)

  • Mount overhead - directly above table center
  • Height: 2-3 meters above surface
  • Angle: Perfect 90° downward (bird's-eye view)
  • Coverage: Full table must be visible

⚠️ Important: Side-mounted cameras will not work. Overhead positioning is essential.

🎯 Setup Steps

  1. Install - Run installation command above
  2. Print - Print ~/PoolMind/markers/markers_A4.pdf
  3. Mount - Place markers at table corners:
  4. 0 - Top-left corner
  5. 1 - Top-right corner
  6. 2 - Bottom-right corner
  7. 3 - Bottom-left corner
  8. Access - Open http://your-pi-ip:8000 in browser
  9. Play - Start playing pool!

🛠️ Management

# Check status
./scripts/deployment/status.sh

# Force update
./scripts/deployment/update.sh

# View logs
sudo journalctl -u poolmind -f

# Restart service
sudo systemctl restart poolmind

🧪 Testing & Development

# Test without hardware
./scripts/demo/enhanced_simulation.py

# Physics simulation
./scripts/demo/physics_simulator.py

# Camera test
./scripts/tools/camera_test.py --list-cameras

⚡ Auto-Update Features

After installation, PoolMind automatically: - ✅ Starts on boot - ✅ Checks GitHub for updates every 30 minutes - ✅ Downloads and installs updates - ✅ Creates backups before updates - ✅ Restarts service after updates - ✅ Provides web interface on port 8000

📖 More Information

⭐ For complete documentation, see the main README.md