9cb0f42205
- Delete plane-right.png (unused, replaced by aircraft type sprites) - Delete PROJECT_DOCUMENTATION.md (outdated, contained stale file references and sensitive credentials; functionality documented in CONFIG.md and CLAUDE.md) - Update README.md to remove reference to deleted documentation Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
56 lines
1.3 KiB
Markdown
56 lines
1.3 KiB
Markdown
# Pixel-ADSB
|
|
|
|
A retro SNES-style side-view flight tracker that displays ADS-B aircraft data with custom pixel art sprites.
|
|
|
|
## Features
|
|
|
|
- Real-time aircraft tracking via ADS-B receivers
|
|
- Custom pixel art sprites for 6 aircraft types
|
|
- Animated sun and moon with accurate positions based on location
|
|
- Weather visualization (clouds, rain/snow)
|
|
- Directional view (N/E/S/W) with unique backgrounds
|
|
- Canvas-based 10 FPS retro rendering
|
|
|
|
## Quick Start
|
|
|
|
```bash
|
|
# Install dependencies
|
|
pip install aiohttp netifaces
|
|
|
|
# Start the server
|
|
python3 server.py
|
|
```
|
|
|
|
Access at http://localhost:2001 (or configured port in config.json)
|
|
|
|
## Requirements
|
|
|
|
- Python 3.8+
|
|
- ADS-B receiver providing SBS/BaseStation format on port 30003
|
|
- Modern web browser with Canvas support
|
|
|
|
## Documentation
|
|
|
|
- [CONFIG.md](CONFIG.md) - Configuration options and background themes
|
|
- [CLAUDE.md](CLAUDE.md) - Development guidance
|
|
|
|
## Aircraft Types
|
|
|
|
| Type | Description |
|
|
|------|-------------|
|
|
| Small Prop | Light aircraft, N-prefix callsigns |
|
|
| Regional Jet | Regional carriers |
|
|
| Narrow Body | 737/A320 class |
|
|
| Wide Body | 777/787 class |
|
|
| Heavy | 747/A380 class |
|
|
| Helicopter | Low altitude, slow speed |
|
|
|
|
## Controls
|
|
|
|
- **Arrow Keys / A/D**: Rotate view direction
|
|
- View cycles through North, East, South, West
|
|
|
|
## License
|
|
|
|
MIT
|