Documentation¶

PixelRoot32 is a lightweight 2D game engine designed for ESP32 and native desktop targets. This site provides official, versioned documentation with clear guides, conceptual explanations, API references, and complete examples to help you build games efficiently.

Quick Links¶

• What is PixelRoot32? - Start here to understand the engine
• Your First Project - Get up and running quickly
• Fundamental Concepts - Learn the core concepts
• Platform Compatibility - Choose the right ESP32 variant
• Memory Management - C++17 smart pointers and best practices
• Music Integration - Complete music and audio guide
• Testing Guide - Comprehensive testing practices
• Manual - Complete user guide
• API Reference - Complete API documentation
• Examples - Complete game examples
• Tools - Available tools
• FAQ - FAQ and troubleshooting

Getting Started¶

New to PixelRoot32? Follow this learning path:

1. What is PixelRoot32? - Understand what the engine is and what it can do
2. Platform Compatibility - Choose your target hardware
3. Fundamental Concepts - Learn the core architecture concepts
4. Memory Management - Master C++17 smart pointers
5. Your First Project - Create and run your first project
6. Music Integration - Add sound and music
7. Testing Guide - Write robust tests for your games

New Documentation (2026)¶

📋 Platform Compatibility Guide¶

Comprehensive matrix of ESP32 variants with detailed feature comparison, configuration examples, and migration guides.

🧠 Memory Management Guide¶

Complete C++17 smart pointer guide with ownership patterns, RAII practices, and platform-specific optimizations.

🎵 MusicPlayer Integration Guide¶

Advanced music and audio integration with tempo control, adaptive soundtracks, and platform considerations.

🧪 Testing Guide¶

Complete testing framework guide covering unit tests, integration tests, platform-specific testing, and CI/CD.

About This Documentation¶

• Professional technical English across all pages
• Search-enabled, mobile-friendly UI
• Versioned with mike (stable/dev/experimental)
• Cross-linked concepts, API, and examples
• Progressive learning path from basics to advanced topics
• Platform-specific guidance for ESP32 variants
• Performance-optimized code examples