About

mirador noun
/ˈmir-ə-ˌdȯr/, or /ˌmir-ə-ˈdȯr/
a turret, window, or balcony designed to command an extensive outlook

Mirador is a modular, interactive application written in Rust, focused on real-time rendering, procedural maze generation, and game-like user interaction. It leverages modern GPU technologies and immediate-mode GUI frameworks to provide a responsive and visually engaging experience.

Purpose

Mirador is a work in progress game engine written entirely in Rust. It is designed to be modular, real-time, and memory-efficient. It achieves this by employing several rendering pipelines that each handle specific aspects of the game’s visual and interactive elements, all of which leverage the computational power of the GPU via the WGPU graphics API. Whilst this project is still in its infancy, it currently supports:

Real-time rendering using the WGPU graphics API.
Integration with egui for overlays, controls, and interactive panels.
Modular architecture for game state, rendering, and UI.
Procedural maze generation and animation.
Responsive input handling and event-driven updates.

Architecture Overview

Mirador is organized into several core modules:

App: The main application object, responsible for initialization, event handling, rendering, and orchestrating the game state.
Game: Contains logic for player state, input handling, and core gameplay mechanics.
Maze: Handles procedural maze generation, storage, and rendering data.
Rendering: Manages all rendering pipelines.
UI: Implements egui-based overlays for easier development and debugging.
Math: Provides vector and matrix utilities for graphics and game logic.

The application initializes a WGPU instance and event loop, sets up rendering and UI pipelines, and manages all state transitions and user interactions through a central App struct.

Technologies Used

Rust : (edition 2024)
WGPU: Modern, portable graphics API for GPU rendering.
egui: Immediate-mode GUI library for Rust.
winit: Cross-platform window and event loop management.
rand: Random number generation for procedural content.
chrono: Time and date utilities.
glyphon: Modern rust API for rendering text on the GPU via wgpu.

Getting Started

Mirador is intended for developers and enthusiasts interested in graphics programming, game development, or Rust-based application architecture. To explore or contribute:

Ensure you have a recent Rust toolchain installed.
Clone the repository and build with cargo build.
Run the application with cargo run.

For the in code documentation, please refer to:

Rust Doc Documentation

License

Mirador is released under an open-source license. See the repository for details.