249 lines
9.3 KiB
Markdown
249 lines
9.3 KiB
Markdown
# 🌉 Community Bridge
|
|
> **By The Order of the Sacred Framework**
|
|
|
|
<div align="center">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
*A modular, beginner-friendly collection of tools and systems designed to simplify and unify FiveM development.*
|
|
|
|
**Built with ❤️ by the community, for the community**
|
|
|
|
</div>
|
|
|
|
---
|
|
|
|
## 🚀 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**
|
|
<details>
|
|
<summary>Click to expand core system compatibility</summary>
|
|
|
|
#### 📦 **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 |
|
|
|
|
</details>
|
|
|
|
### 🎨 **Developer Tools & Utilities**
|
|
<details>
|
|
<summary>Click to expand developer tools and utilities</summary>
|
|
|
|
#### 🛠️ **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
|
|
|
|
</details>
|
|
|
|
### 🎭 **Specialized Systems**
|
|
<details>
|
|
<summary>Click to expand specialized system integrations</summary>
|
|
|
|
#### 🏠 **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
|
|
|
|
</details>
|
|
|
|
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
|
|
|
|
<details>
|
|
<summary>Click to expand FAQ</summary>
|
|
|
|
**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.
|
|
|
|
</details>
|
|
|
|
---
|
|
|
|
## 🚀 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."
|
|
|
|
<div align="center">
|
|
|
|
**Made with ❤️ by The Order of the Sacred Framework**
|
|
|
|
|
|
|
|
|
|
</div>
|