Bevy All-in-One Documentation

A powerful 3D/2.5D game controller plugin for Bevy Engine.

---

Project maintained by yaskhan Hosted on GitHub Pages — Theme by mattgraham

Documentation Index

This directory contains comprehensive documentation for the Bevy All-in-One Controller systems.

System Documentation

Core Systems

• Character Controller System - Player character controller with physics and movement states
• Player System - Player-specific logic, managing high-level states, modes, and advanced movement mechanics
• Camera System - Camera controls and behavior, including peeking, looking around while hidden, and zooming
• Input System - Action mapping, buffering, and runtime rebinding framework
• AI System - Comprehensive AI behavior, perception, and faction management
• Abilities System - Special abilities with cooldowns, energy management, and multiple input patterns
• Weapon System - Weapon physics, aiming, and damage systems
• Combat System - Health, damage calculations, and impact feedback
• Map System - Minimap, world map, markers, and navigation tools
• Interaction System - Player-world interactions, including raycasting and device detection
• Dialog System - Dialogues and conversations
• Stats System - Character attributes, modifiers, and derived stats logic
• Skills System - Skill trees, progression, leveling, and ability unlocks
• Save System - Core persistence, serialization, auto-save, and slot management
• Climb System - Parkour mechanics, ledge detection, wall running, and vertical traversal
• Ladder System - Structured ladder interaction, mounting, and constrained climbing
• Inventory System - Logic for managing items, equipment, currency, and trading with vendors
• Tutorial System - Comprehensive tutorial framework with UI, state management, and event handling
• Experience System - Experience gain, leveling, and skill progression

Advanced Systems

• Quest System - Branching quest lines, objectives tracking, and quest givers
• Puzzle System - Logic gates, puzzle elements, and interactive device simulation
• Devices System - Interaction framework for doors, switches, and examine objects
• Vehicles System - Complete vehicle physics, seating, weapons, and damage systems
• Climb System - Parkour, wall running, and ledge hanging
• Stealth System - Stealth mechanics, including detection, evasion, and alert systems
• Grab System - Grab mechanics, including picking up, throwing, and carrying objects

About This Documentation

This documentation provides detailed technical information about each system in the Bevy All-in-One Controller plugin. Each system documentation includes:

• Architecture overview and component relationships
• Detailed API documentation with code examples
• Integration points with other systems
• Performance considerations and optimization tips
• Configuration options and customization guidelines
• Troubleshooting and debugging information

Contributing

When adding new documentation:

1. Follow the established format and style
2. Include practical code examples where relevant
3. Document all major configuration options
4. Explain integration points with other systems
5. Add troubleshooting sections for common issues

Documentation Standards

• Use clear, technical English
• Include code examples for complex concepts
• Document both basic usage and advanced features
• Maintain consistency with existing documentation style
• Provide practical troubleshooting guidance