# ๐ Community Bridge
> **By The Order of the Sacred Framework**
*A modular, beginner-friendly collection of tools and systems designed to simplify and unify FiveM development.*
**Built with โค๏ธ by the community, for the community**
---
## ๐ Overview & Features
**Community Bridge** is a comprehensive compatibility layer that acts as a universal wrapper around all major systems used across FiveM frameworks. Whether you're building with QB-Core, ESX, QBox, or any other framework, this bridge ensures your scripts work seamlessly across all environments.
Instead of writing separate code for each framework's inventory, dispatch, targeting, or notification system, you write once and it works everywhere.
### ๐ฏ Core Philosophy
- ๐ง **Plug & Play** - Drop in and it just works
- ๐ **Universal Compatibility** - One bridge, all frameworks
- ๐ **Beginner Friendly** - Clean, documented, and easy to understand
- ๐ **Future Proof** - Built to adapt and grow with the community
### ๐ **Framework Support**
- **QB-Core** - Full compatibility
- **QBox** - Native support
- **ESX** - Complete integration
- **Custom Frameworks** - Extensible design
Below are the core system integrations and advanced tools available:
### ๐ง **Core System Integrations**
Click to expand core system compatibility
#### ๐ฆ **Inventory Systems**
- `ox_inventory` โญ | `codem-inventory` | `core_inventory` | `jpr-inventory`
- `origin_inventory` | `ps-inventory` | `qb-inventory` | `qs-inventory` | `tgiann-inventory`
**Bonus:** Built-in item output generator supporting `ox_inventory`, `qb-new`, and `qb-old` formats!
#### ๐จ **Dispatch Systems**
- `lb-tablet` | `ps-dispatch` | `qs-dispatch` | `redutzu-mdt` | `tk_dispatch`
- `linden_outlawalert` | `cd_dispatch` | `bub_mdt`
**Plus:** Built-in fallback system ensures notifications always reach their destination.
#### ๐๏ธ **Additional Modules**
| Module | Description | Compatibility |
|--------|-------------|---------------|
| ๐ช **Doorlock** | Universal door management | `ox_doorlock`, `qb-doorlock`, `rcore_doorlock`, `jacksams-doorlock` |
| โฝ **Fuel Systems** | Seamless fuel integration | All major fuel resources |
| ๐ฑ **Phone** | Cross-phone compatibility | All major phone systems |
| ๐ฏ **Targeting** | Universal targeting system | `qb-target`, `ox_target`, `sleepless-interact` |
| ๐ **Vehicle Keys** | Key management bridge | All major key systems |
| ๐๏ธ **Shops** | In-house shop system | Simple, expandable design |
| ๐ **Progress Bars** | Universal progress system | Most common progress resources |
| ๐ค๏ธ **Weather** | Weather control bridge | Most weather resources |
| ๐ฎ **Skills** | Skill system integration | Most skill systems |
### ๐จ **Developer Tools & Utilities**
Click to expand developer tools and utilities
#### ๐ ๏ธ **Utility Features**
- ๐ **Locale Support** - Multi-language ready
- ๐งฎ **Math Utilities** - Common mathematical functions
- ๐ง **Helper Functions** - Rich collection of development tools
- ๐ **Input Systems** - `qb-input` and `ox_lib` compatible
- ๐ **Menu Systems** - Interchangeable QB and ox_lib formats
- โ
**Version Checker** - Built-in update management
- ๐ฆ **Cache System** - Advanced client-side caching with change detection
- ๐ฏ **Point System** - 3D world interaction points
- ๐ **State Bags** - Entity state management
- ๐ง **Entity Management** - Comprehensive entity utilities
#### ๐จ **Advanced Developer Tools**
- ๐ฌ **Cutscenes** - Full cinematic sequence management with character switching
- โจ **Particle Effects** - Advanced particle system integration
- ๐ **Markers** - Server-side marker management system
- ๐ฏ **Raycast Utilities** - Advanced raycasting and collision detection
- ๐บ **Scaleform** - Native UI scaleform wrapper
- ๐ฎ **Gizmo System** - 3D object manipulation with translate/rotate/scale
- ๐๏ธ **Object Placement** - Advanced placeable object system with boundary checks
- ๐ฅ๏ธ **DUI System** - Direct User Interface integration
- ๐ **Math Tools** - Mathematical utilities for 3D calculations
### ๐ญ **Specialized Systems**
Click to expand specialized system integrations
#### ๐ **Housing System Integration**
- ๐ก **bcs-housing** - Complete integration
- ๐ **esx_property** - Full compatibility
- ๐ง **Universal Interface** - Standardized housing functions
- ๐ **Property Management** - Advanced property utilities
#### ๐ฌ **Dialogue & Help Systems**
- ๐ฃ๏ธ **Web-based Dialogue** - Modern React-based dialogue interface
- ๐ก **Multiple Help Text Providers**:
- `cd_drawtextui` | `jg-textui` | `lab-HintUI` | `okokTextUI` | `ox_lib`
- ๐จ **Styled Components** - Professional UI with animations
- ๐ฑ **Responsive Design** - Works across all screen sizes
#### ๐ **Comprehensive Clothing Systems**
- ๐ **illenium-appearance** - Advanced appearance management
- ๐ฎ **fivem-appearance** - Community appearance system
- ๐ฆ **qb-clothing** - QB-Core clothing integration
- ๐ **esx_skin** - ESX skin system support
- ๐ **Default Fallback** - Built-in clothing system
- ๐พ **Appearance Caching** - Optimized appearance data management
#### ๐ญ **Animation & Effects Systems**
- ๐ฌ **Animation Library** - Comprehensive animation utilities
- โจ **Particle Management** - Advanced particle effect system
- ๐ญ **Cutscene Framework** - Full cinematic control
- ๐บ **Scaleform Integration** - Native UI elements
- ๐ฏ **Entity Animation** - Ped and object animation tools
Whether you're building a full framework or just need utility features, **Community Bridge** is designed to make your workflow easier and more efficient.
---
## ๐ค Community-Driven
This project includes contributions and snippets from across the development community. Some modules are under the **GPLv3 license**, with proper credit given in the `Attributions` file.
Our mission: to promote open collaboration, reduce friction between systems, and create a unified foundation for all developersโregardless of framework or experience.
---
## ๐งฐ Why Use Community Bridge?
- โ
**Easy for beginners** - Simple, intuitive API design
- ๐ **Highly modular** - Use only what you need
- ๐ **Universal compatibility** - Works with all major frameworks and resources
- ๐ค **Community-driven** - Built by developers, for developers
- ๐ก๏ธ **Production ready** - Battle-tested across hundreds of servers
---
## โ Frequently Asked Questions
Click to expand FAQ
**Q: What happens if a new framework comes out?**
A: We actively monitor the FiveM community and add support for new frameworks as they gain adoption.
**Q: Is this compatible with my custom framework?**
A: Yes! Community Bridge has an extensible design that supports custom framework integration.
**Q: How often is this updated?**
A: We release updates regularly to maintain compatibility and add new features based on community feedback.
---
## ๐ Quick Start
### Installation
1. **Download** the latest release from GitHub
2. **Extract** to your resources folder: `[bridges]/community_bridge`
3. **Add** to your `server.cfg`:
```cfg
ensure community_bridge
```
4. **Restart** your server
---
## ๐ Documentation
Read the full documentation here:
๐ [Our Gitbook Here](https://mrnewbs-scrips.gitbook.io/the-order-of-the-sacred-framework)
---
## ๐ค Contributing
We welcome contributions from the community! Here's how you can help:
### How to Contribute
1. **Fork** this repositorys dev branch
2. **Commit** your changes (`git commit -m 'Add amazing feature'`)
3. **Push** to the branch (`git push origin feature/amazing-feature`)
4. **Open** a Pull Request
### Guidelines
- โ
Follow existing code style and patterns
- โ
Test your changes thoroughly
- โ
Update documentation when needed
- โ
Be respectful and constructive in discussions
---
## ๐ฌ Join the Community
Have questions, suggestions, or want to contribute? Join us on Discord:
๐ [Our Discord Here](https://discord.gg/MukwBuJjP7)
---
## ๐ License
This project is licensed under the **GPLv3 License** - see the [LICENSE](LICENSE) file for details.
### Attribution
Some modules include contributions from the FiveM community. Full attributions are listed in the `Attributions` file.
---
## โญ Support the Project
If Community Bridge has helped your development workflow, consider:
- โญ **Starring** this repository
- ๐ **Reporting** bugs and issues
- ๐ก **Suggesting** new features
- ๐ค **Contributing** code or documentation
- ๐ฌ **Sharing** with other developers
---
> "Connecting what matters โ frameworks unified, development simplified."
**Made with โค๏ธ by The Order of the Sacred Framework**
