README

Grimware - Reference Implementation Library

A curated collection of reference implementations for the Raibid Labs organization, demonstrating best practices, architectural patterns, and development workflows across multiple technology stacks.

📚 Reference Implementations

1. Bevy MCP

AI-Assisted Game Development with Bevy Remote Protocol

Demonstrates real-time game development with AI assistance using Bevy game engine and the Bevy Remote Protocol (BRP) MCP server.

• Technology: Bevy 0.16+, Rust, MCP/BRP
• Key Features: Live entity manipulation, AI-controlled development, real-time debugging
• Platform: Desktop (macOS, Linux, Windows)
• Documentation: bevy-mcp.md
• Quick Start: README.md

Use Cases: Game prototyping, AI-assisted development, live debugging, rapid iteration

---

2. Bevy MCP Ratatui

3D Game Development in Your Terminal

Combines Bevy game engine with terminal UI rendering, enabling AI-controlled 3D game development with visual feedback directly in the terminal.

• Technology: Bevy 0.16+, Ratatui, BRP, MCP
• Key Features: Terminal 3D rendering, AI prompt visualization, headless development
• Platform: Terminal (macOS, Linux, Windows)
• Documentation: bevy-mcp-ratatui.md
• Quick Start: README.md

Use Cases: Terminal-based game dev, CI/CD visualization, headless testing, ASCII art generation

---

3. Tauri Cross-Platform

Multi-Platform Desktop and Mobile Applications

Production-ready Tauri v2 application demonstrating cross-platform development for desktop and mobile from a single codebase.

• Technology: Tauri v2, Rust, JavaScript, Vite
• Key Features: Single codebase, native performance, small binaries (2-12MB)
• Platform: macOS (M3 ARM64), Android, Linux (NVIDIA DGX-Spark)
• Documentation: tauri.md
• Quick Start: README.md

Use Cases: Cross-platform apps, mobile-first development, small footprint applications

---

4. WebATUI

Universal Terminal UI Library

Terminal UI library that works seamlessly in both native terminals and web browsers via WebAssembly.

• Technology: Rust, Ratatui, Yew, WASM
• Key Features: Dual-target (terminal + browser), component system, state management
• Platform: Native terminals + Web browsers
• Documentation: webatui.md
• Quick Start: README.md

Use Cases: Terminal applications, web-based TUIs, cross-platform CLIs, educational tools

---

🚀 Getting Started

Prerequisites

All reference implementations require:

• Rust (latest stable) - Install here
• Git - For cloning repositories

Additional requirements vary by project - see individual documentation.

Quick Navigation

# Clone the repository
git clone https://github.com/raibid-labs/grimware.git
cd grimware
 
# Explore a specific reference implementation
cd bevy-mcp-ref          # Game development with AI
cd bevy-mcp-ratatui-ref  # Terminal 3D rendering
cd tauri-ref             # Cross-platform apps
cd webatui-ref           # Terminal UI library

📖 Documentation

Consolidated Guides

• Getting Started - Universal setup guide for all implementations
• Architecture Overview - High-level architecture patterns
• Development Workflows - Common development patterns and best practices
• Platform Support - Platform-specific guides and requirements

Reference Implementation Docs

• Bevy MCP Guide - AI-assisted game development
• Bevy MCP Ratatui Guide - Terminal 3D rendering
• Tauri Guide - Cross-platform application development
• WebATUI Guide - Terminal UI library usage

Specialized Topics

• MCP Integration - Model Context Protocol patterns
• BRP Usage - Bevy Remote Protocol best practices
• Terminal Rendering - Terminal UI patterns and optimization
• Cross-Platform Development - Multi-platform strategies

🛠️ Technology Stack

Languages

• Rust - Primary language for all implementations
• JavaScript/TypeScript - Frontend (Tauri, WebATUI)

Frameworks & Libraries

• Bevy - Game engine (0.16+)
• Tauri - Desktop/mobile framework (v2)
• Ratatui - Terminal UI framework
• Yew - Rust web framework

Protocols & APIs

• MCP - Model Context Protocol (AI integration)
• BRP - Bevy Remote Protocol (live game manipulation)
• IPC - Inter-process communication (Tauri)

🎯 Use Case Matrix

Use Case	Best Implementation
AI-assisted game development	Bevy MCP
Terminal-based visualization	Bevy MCP Ratatui
Cross-platform desktop app	Tauri
Mobile application	Tauri
Terminal UI application	WebATUI
Browser-based TUI	WebATUI
Headless game testing	Bevy MCP Ratatui
Live code editing	Bevy MCP

🤝 Contributing

These are reference implementations maintained by Raibid Labs. Contributions welcome:

1. Fork the repository
2. Create a feature branch
3. Make your changes with tests
4. Ensure documentation is updated
5. Submit a pull request

See individual projects for specific contribution guidelines.

📄 License

Each reference implementation may have its own license. Check individual project directories for details.

Most projects use MIT or MIT/Apache-2.0 dual licensing.

🔗 Resources

Official Documentation

• Bevy Engine
• Tauri Framework
• Ratatui
• Claude Code

Raibid Labs

• GitHub Organization
• Website (if available)

🎓 Learning Path

For Beginners:

1. Start with WebATUI - Learn TUI basics
2. Try Tauri - Understand cross-platform development
3. Explore Bevy MCP - Game development fundamentals

For Advanced Users:

1. Deep dive into Bevy MCP Ratatui - Complex integrations
2. Study architecture docs for pattern recognition
3. Customize implementations for your use cases

---

Built with ❤️ by Raibid Labs

Reference implementations for modern Rust development