MFS Engine Documentation

🚀 Quick Start

Get started with MFS Engine in minutes:

# Clone the repository
git clone https://github.com/XFOSS/mfs.git
cd mfs

# Build the engine
zig build

# Run examples
zig build run-example
                

🎨 Graphics

Vulkan, DirectX 12, Metal
Hardware Ray Tracing
Compute Shaders
PBR Rendering

🌊 Physics

Rigid Body Dynamics
10,000+ Objects
Collision Detection
Constraints System

🎮 Core Systems

Entity Component System
Asset Pipeline
3D Spatial Audio
Cross-platform Input

🧠 Advanced

Neural Networks
Voxel Engine
VR/XR Support
Networking

📚 Core Documentation

🏗️ Engine Overview

High-level architecture and design principles of the MFS Engine

Read Documentation →

📖 API Reference

Complete API documentation with examples and usage patterns

View API Docs →

🔧 API Guide

Quick API reference and common usage patterns

Quick Reference →

🤝 Contributing

Guidelines for contributing to the MFS Engine project

Contribute →

🎨 Graphics & Rendering

🖥️ Rendering Backends

Multi-platform rendering backend implementations and architecture

Learn More →

✨ Ray Tracing

Hardware-accelerated ray tracing implementation and usage

Explore Ray Tracing →

🌐 WebAssembly + DirectX12

Advanced WebAssembly integration with DirectX12 backend

Technical Details →

🔄 OpenGL Fallback

OpenGL fallback solution for legacy hardware support

Implementation →

🛠️ Development

📏 Coding Standards

Code style guidelines and best practices for the project

Style Guide →

🔄 Migration Guide

Guide for migrating between different versions of the engine

Migration Steps →

📋 Getting Started

Detailed setup instructions and first steps with the engine

Get Started →

🔗 External Resources

📊 GitHub Repository

Source code, issues, and project management

View on GitHub →

🦎 Zig Language

Official documentation for the Zig programming language

Zig Docs →

📝 License

MIT License - free for commercial and personal use

View License →