Welcome to Pyrite’s Engine Documentation!

Pyrite is a highly-optimized, procedural 3D Voxel Engine written entirely in Python.

Unlike standard Python projects, Pyrite heavily utilizes Just-In-Time (JIT) LLVM compilation via Numba to bypass the Global Interpreter Lock (GIL) and achieve near C++ performance.

This documentation breaks down the core systems of the engine, explaining how terrain is generated, how light propagates, and how millions of voxels are rendered smoothly at 60+ FPS.

Getting Started:

• Installation and Setup Guide
  • Prerequisites
  • Python Dependencies
  • Installation Steps
  • Configuration
  • Running the Engine
  • Building the Engine
  • Documentation Building
  • Troubleshooting
  • Development Workflow
  • Performance Tuning
• Core Engine Flow
  • Engine Initialization
  • State Management
  • World Generation and Sessions
  • The Main Loop
  • Application Control
  • Detailed Initialization Sequence
  • Detailed State Machine
  • The Main Game Loop (Pseudocode)
  • Detailed Event Handling
  • Detailed Update Step (In-Game)
  • Detailed Render Step
  • Scene Rendering Pipeline
  • World Session Initialization (LOADING state)
  • Shutdown and Cleanup

Engine Architecture:

• Architecture and Rendering
• Engine Architecture
  • The Main Loop & Asynchronous Processing
  • The Queue System
  • Subsystem Responsibilities
  • World & Data Persistence
  • SQLite Write-Ahead Logging (WAL)
  • Memory Management (1D vs 3D Arrays)
• Rendering Pipeline
  • Greedy Meshing
  • Vectorized Frustum Culling
  • Hardware Occlusion Queries
  • Multi-Pass Transparency
  • Texture Atlases
  • Ambient Occlusion
  • Render Flow Summary
• Lighting System:
  • Overview
  • Lightmap Data Structure
  • Sunlight Propagation Algorithm
  • BFS Light Propagation
  • Blocklight (Torch) Propagation
  • Chunk Boundary Stitching
  • Integration with Rendering
  • Replication Checklist
  • Performance Considerations
• Shader Systems and GLSL Breakdown
  • Shader Architecture Overview
  • Chunk Shader (Main Terrain Rendering)
  • Item Shader (Dropped Items)
  • Sky Shader (Procedural Atmosphere)
  • Clouds Shader (Procedural)
  • UI Block Shader (Inventory Icons)
  • UI Color Shader (Backgrounds, UI Quads)
  • Uniform Management
  • Texture Atlas Binding
  • Debugging Tips

Core Systems:

• Mesh Systems and Vertex Packing
  • Overview
  • Mesh Classes Hierarchy
  • Vertex Packing: 32-Bit Format
  • Greedy Meshing Algorithm
  • Vertex Light Smoothing
  • Ambient Occlusion (AO) Calculation
  • Flip Detection (Diagonal Flip for Lighting)
  • Water Faces Handling
  • Mesh Building Pipeline (CPU to GPU)
  • Data Flow Example
  • Custom Mesh Variants
  • Replication Guide
• Procedural Terrain Generation
  • Biome & Topography System
  • Cave Carving
  • Tree & Flora Generation
  • Noise Foundation (Deterministic Generation)
  • Height Generation Algorithm
  • Biome Selection Algorithm
  • Cave Carving Algorithm (3D)
  • Tree Placement and Structure
  • Ore Generation
  • Column Generation Sequence
  • Replication Checklist
• Player Systems
  • Player Class Hierarchy
  • Coordinate System
  • Controls and Input Handling
  • Physics: Gravity and Velocity
  • AABB Collision Detection
  • Water Physics
  • Survival Stats Management
  • Inventory Management
  • Mining and Placing
  • View Bobbing and Hand Animation
  • Dynamic FOV During Sprint
  • Integration with Game Loop
• User Interface Systems and Components
  • UI Architecture Overview
  • Core UI Component Base Class
  • In-Game HUD Components
  • Menu System
  • Layout Metrics (Slot Grid)
  • Button and Component Library
  • Transition Animations
  • Integration with Main Loop
• World Persistence and Data Storage
  • Overview
  • Database Schema
  • Serialization and Compression
  • Database Operations
  • Asynchronous I/O and Threading
  • World Management (File System)
  • WAL Mode Benefits
  • Replication Checklist
• Survival & Physics Mechanics
  • Player Physics & AABB Collisions
  • Inventory & Crafting
  • Tool Dependencies & Mining Hardness
  • 3D Item Entities

Learning and Reference:

• Implementation Tutorials and Replication Guides
  • Tutorial 1: Build a Terrain Generation System
  • Tutorial 2: Implement Greedy Meshing
  • Tutorial 3: Implement AABB Collision Detection
  • Tutorial 4: Implement Inventory and Crafting
• API Reference
  • Core Engine (main.py)
  • Player (player.py)
  • World (world.py)
  • Chunk (chunk.py)
  • Scene (scene.py)
  • VoxelHandler (voxel_handler.py)
  • Constants (settings.py)
  • Shader Programs (shader_program.py)
  • Mesh Building (build_chunk_mesh.py)
  • Terrain Generation (terrain_gen.py)
  • Lighting (lighting.py)
  • Common Enums and Constants

Development:

• Testing and Profiling
  • Testing Framework Setup
  • Engine Tests
  • Continuous Integration
• Deployment and Builds
  • PyInstaller Setup
  • Platform-Specific Considerations
  • Automated CI/CD Pipeline
  • Version Management
  • Launch Checklist
  • Distribution Platforms
  • Troubleshooting Builds
  • Minimum Requirements
  • Replication Checklist

• Search Page