Hyperfy Components
This section documents our custom Hyperfy components that extend the platform's functionality. Each component is designed to provide specific interactive capabilities within our 3D environments.
Available Components
- Base App Component: Foundational template for creating new Hyperfy applications with node management, collision setup, and debug logging
- Emitter Component: Interactive zones that detect player interactions and emit signals for other components to handle
- Visibility Component: Control visibility and collision states of 3D objects with synchronization and event-driven changes
Component Structure
Each component documentation includes:
- Overview: General description and purpose
- Key Features: Main capabilities and functionality
- Video Demo: Interactive demonstration of the component in action
- Properties: Configurable parameters organized by category
- Events: Emitted signals and their parameters
- Common Use Cases: Typical applications and scenarios
- Integration: How the component works with other systems
- Best Practices: Guidelines for optimal usage
Development Guidelines
When developing new components for Hyperfy:
- Clear Purpose: Define the component's specific role and responsibilities
- Property Organization: Group related properties into logical categories
- Event Documentation: Document all emitted signals with clear parameter descriptions
- Use Case Examples: Provide practical scenarios without code implementation
- Integration Clarity: Explain how the component works with other systems
- Best Practices: Include guidelines for optimal usage and performance
Integration
These components are integrated into our Hyperfy fork and are available for use in all our 3D spaces. For implementation details, see our Hyperfy Integration Guide.