Skip to content

Installation

This guide covers installing the PixelRoot32 documentation environment and preparing your development setup for ESP32 and Native (PC) targets.

Requirements

  • Python 3.11 or newer
  • Git (recommended for source management)
  • VS Code (or your preferred IDE)
  • For ESP32 targets: PlatformIO (VS Code extension) with ESP32 toolchain
  • For Native targets: a C++ build toolchain (CMake or your OS-native toolchain)

Install Documentation Tooling

To build and preview this documentation locally:

pip install mkdocs mkdocs-material mkdocs-minify-plugin mkdocs-git-revision-date-localized-plugin mike
mkdocs serve

Open http://127.0.0.1:8000 in your browser to preview.

  1. Install VS Code
  2. Install PlatformIO IDE extension
  3. Install ESP32 platform/toolchain via PlatformIO
  4. Clone the engine repository:
  5. https://github.com/Gperez88/PixelRoot32-Game-Engine
  6. Open the engine or example project in VS Code (PlatformIO)
  7. Build and upload to your ESP32 board

Tip: Use boards based on ESP32-WROOM/WROVER for best compatibility. Ensure a reliable USB cable and correct serial port selection.

Native (PC) Setup

  1. Install a C++ toolchain (e.g., MSVC or MinGW on Windows)
  2. Install CMake (if the engine provides CMake build files)
  3. Clone the engine repository:
  4. https://github.com/Gperez88/PixelRoot32-Game-Engine
  5. Configure and build the native runtime:
  6. Follow the engine’s native build instructions (Development → Compiling)

Verify Your Environment

  • ESP32: Build and flash a minimal sample; confirm serial output and display if applicable
  • Native: Run the executable; confirm window output and input handling

Troubleshooting

  • If PlatformIO cannot find the ESP32 platform, update PlatformIO and retry
  • If native builds fail, verify compiler versions and CMake generator settings
  • Use Community → Troubleshooting for common issues and fixes

Next Steps