Porytiles Developer Documentation

Welcome to the Porytiles developer documentation! This documentation covers the architecture, core systems, contributing recipes, and reference material for Porytiles development.

The target audience is a C++ developer who may be new to the Porytiles codebase but is not new to programming. The goal is “what you need to know to contribute effectively” – not an exhaustive API reference for every class.

Note

This documentation is for Porytiles v2.0.0. For documentation matching an older release, checkout the corresponding git tag and build locally with cd docsrc && uv run make html.

About This Documentation

This documentation is organized according to the Diataxis framework, a systematic approach to technical documentation that distinguishes four types of content based on the reader’s needs:

• Tutorials (Getting Started) — learning-oriented, step-by-step walkthroughs that take you from zero to a working build. Follow these when you are new to the project.

• Explanation (Architecture, Core Systems) — understanding-oriented content that clarifies the codebase structure, design decisions, patterns, and the “why” behind the system. Read these to build a mental model before contributing.

• How-to Guides — task-oriented, step-by-step recipes for common contributor tasks. Consult these when you need to add a config value, implement a new command, extend the packing system, or write tests.

• Reference — information-oriented, precise descriptions of build commands, dependencies, scripts, and CI/CD. Look things up here when you need exact details.

The in-repo Porytiles2/ARCHITECTURE.md provides a detailed codemap optimized for quick reference. This documentation site complements that document with deeper dives, worked examples, data flow walkthroughs, and contributor recipes.

For class-level and function-level API details, consult the Doxygen API reference. That site is auto-generated from source comments and covers every public interface. Use it alongside this documentation: start here for architecture and concepts, then drill into Doxygen when you need the exact signature, parameters, or preconditions for a specific class or function.

Getting Started

• Setting Up Your Development Environment

Architecture

• Project Layout and Directory Structure
• Layered Architecture and DDD
• Data Flow and Compilation Pipelines
• Dependency Injection with Google Fruit
• C++ Features and Patterns Used

Core Systems

• The Configuration Code Generation System
• Error Handling and User Diagnostics
• The C Parser System

How-To Guides

• How to Add a New Configuration Value
• How to Add a New CLI Command
• How to Add a New Packing Strategy
• How to Add a DI-Managed Service
• Writing Tests

Reference

• Building, Testing, and Development Workflows
• External Dependencies
• Scripts and Tooling
• CI/CD and Release Process
• Glossary

Indices and tables

• Index

• Search Page