Sable Engine

A modular 3D/2.5D game engine built in Rust, focusing on modern graphics APIs and excellent developer experience.

Features

• Multi-Backend Rendering — Vulkan (primary), Metal (macOS/iOS), DirectX 12 (Windows)
• 2D & 3D Support — Full 3D rendering with first-class 2.5D/sprite support
• Live2D-Style Animation — Mesh deformation, physics-based hair/cloth, lip sync
• Scripting — Lua, Rhai, and WebAssembly scripting with hot-reload
• Visual Editor — Scene editing, asset browsing, profiling tools
• Modern Rust — 2024 edition, proc-macros for ergonomic APIs, zero-cost abstractions

Quick Start

use sable::prelude::*;

fn main() {
    // Math types
    let position = Vec3::new(1.0, 2.0, 3.0);
    let rotation = Quat::from_axis_angle(Vec3::Y, radians(45.0));
    let transform = Mat4::from_translation(position) * rotation.to_mat4();

    // Colors
    let color = Srgba::from_hex(0xFF5500);
    let linear = color.to_linear(); // For GPU operations

    // Generational handles for safe resource management
    let mut textures = HandleAllocator::new();
    let handle = textures.allocate(MyTexture::new());

    // Time tracking
    let mut time = Time::new();
    time.update();
    println!("Delta: {}ms", time.delta_secs() * 1000.0);
}

Architecture

sable/
├── sable-core        # ✅ Math, handles, colors, time utilities
├── sable-platform    # ⏳ Windowing, input
├── sable-gpu         # ⏳ Vulkan abstraction
├── sable-metal       # ⏳ Metal backend (macOS/iOS)
├── sable-dx12        # ⏳ DirectX 12 backend (Windows)
├── sable-render      # ⏳ High-level rendering (backend-agnostic)
├── sable-assets      # ⏳ Asset loading, hot-reload
├── sable-scene       # ⏳ ECS, transforms, spatial structures
├── sable-audio       # ⏳ Audio playback, spatial sound
├── sable-physics     # ⏳ Collision, rigid bodies
├── sable-puppet      # ⏳ Live2D-style character animation
├── sable-script      # ⏳ Scripting integration
├── sable-editor      # ⏳ Visual development editor
├── sable-macros      # ⏳ Proc macros for DX
└── sable-app         # ⏳ Application framework

What's Implemented

sable-core ✅

Test Coverage: 170 unit tests

Status

🚧 Early Development — Foundation complete, rendering in progress.

See TODO.md for the full development roadmap.

Getting Started

Prerequisites

• Rust 2024 edition (nightly or latest stable)
• Vulkan SDK (for Vulkan backend)
• Xcode (for Metal backend on macOS)
• Windows SDK (for DX12 backend on Windows)

Building

git clone https://github.com/PegasusHeavyIndustries/sable.git
cd sable
cargo build --workspace

Running Tests

# All tests
cargo test --workspace

# Specific crate
cargo test -p sable-core

Running Examples

# Basic triangle (coming soon)
cargo run --example hello_triangle

# 2D sprites (coming soon)
cargo run --example sprite_batch

# Puppet animation (coming soon)
cargo run --example puppet_basic

Development Setup

# Install development tools
cargo install cargo-commitlint

# Run tests (also installs pre-commit hooks via cargo-husky)
cargo test --workspace

# Check formatting and lints
cargo fmt --all --check
cargo clippy --workspace -- -D warnings

# Build documentation
cargo doc --workspace --no-deps --open

See CONTRIBUTING.md for detailed guidelines.

Roadmap

Documentation

• Development Roadmap
• Contributing Guide
• Changelog
• API Documentation: cargo doc --workspace --open

License

Sable Engine is proprietary software. See LICENSE for full terms.

Summary

• Free for indie developers and small teams
• Attribution required: "Built with Sable Engine © Pegasus Heavy Industries LLC"
• Cannot redistribute the engine separately
• Cannot use to build a competing game engine

For licensing inquiries: licensing@pegasusheavyindustries.com

Contributing

Contributions are welcome! Please read CONTRIBUTING.md before submitting PRs.

By contributing, you agree that your contributions will be licensed under the same proprietary license as the project.

Sable is developed by Pegasus Heavy Industries LLC.