Files
community_bridge/README.md
T

107 lines
4.1 KiB
Markdown
Raw Normal View History

2025-07-08 04:04:21 -04:00
# Community Bridge
2025-01-08 06:33:31 -05:00
2025-07-08 04:04:21 -04:00
Community Bridge is a modular and extensible compatibility layer for FiveM, designed to unify development across major roleplay frameworks. It provides a consistent API that simplifies integration between popular frameworks such as QBCore, ESX, QBox, and custom solutions.
2025-06-01 17:05:38 -04:00
2025-07-08 04:04:21 -04:00
By bridging core game systems including inventory, dispatch, targeting, door locks, vehicle keys, clothing, fuel, and more, Community Bridge reduces duplicated effort and streamlines script compatibility across servers.
2025-06-01 17:05:38 -04:00
---
2025-07-13 19:22:53 -04:00
![](https://img.shields.io/github/contributors/TheOrderFivem/community_bridge?logo=github)
![](https://img.shields.io/github/v/release/TheOrderFivem/community_bridge?logo=github)
2025-07-08 04:04:21 -04:00
## Features
2025-06-09 00:41:24 -04:00
2025-07-08 04:04:21 -04:00
### Framework Compatibility
2025-06-09 00:41:24 -04:00
2025-07-08 04:04:21 -04:00
* Supports QBCore, ESX, QBox, and custom roleplay frameworks
* Provides a unified API to standardize resource interaction
2025-06-09 00:41:24 -04:00
2025-07-08 04:04:21 -04:00
### Inventory Systems
2025-06-09 00:41:24 -04:00
2025-07-08 04:04:21 -04:00
* Compatible with ox\_inventory, qb-inventory, ps-inventory, codem-inventory, core\_inventory, and others
2025-01-08 06:33:31 -05:00
2025-07-08 04:04:21 -04:00
### Dispatch and MDT
2025-01-08 06:33:31 -05:00
2025-07-08 04:04:21 -04:00
* Integrates with ps-dispatch, cd\_dispatch, lb-tablet, bub\_mdt, and other dispatch systems
* Includes fallback mechanisms to ensure notifications are delivered
2025-01-08 06:33:31 -05:00
2025-07-08 04:04:21 -04:00
### Targeting Systems
2025-01-08 06:33:31 -05:00
2025-07-08 04:04:21 -04:00
* Works with qb-target, ox\_target, sleepless-interact, and similar targeting resources
2025-02-10 13:29:40 -05:00
2025-07-08 04:04:21 -04:00
### Doorlock and Security
2025-02-10 13:29:40 -05:00
2025-07-08 04:04:21 -04:00
* Supports ox\_doorlock, qb-doorlock, rcore\_doorlock, jacksams-doorlock, and other door lock systems
2025-02-10 13:31:49 -05:00
2025-07-08 04:04:21 -04:00
### Vehicle Keys and Locking
2025-06-01 17:25:26 -04:00
2025-07-08 04:04:21 -04:00
* Compatible with all major vehicle key management systems
2025-06-01 17:25:26 -04:00
2025-07-08 04:04:21 -04:00
### Fuel Systems
2025-06-01 17:25:26 -04:00
2025-07-08 04:04:21 -04:00
* Supports all major fuel resources such as legacyfuel, ps-fuel, and more
2025-06-01 17:25:26 -04:00
2025-07-08 04:04:21 -04:00
### Clothing and Appearance
2025-06-01 17:25:26 -04:00
2025-07-08 04:04:21 -04:00
* Integrates with illenium-appearance, fivem-appearance, qb-clothing, esx\_skin, and default fallback clothing systems
2025-06-01 17:25:26 -04:00
2025-07-08 04:04:21 -04:00
### Additional Features
2025-06-01 17:25:26 -04:00
2025-07-08 04:04:21 -04:00
* Progress bars, notifications, weather synchronization, and skill system integration
* Developer tools including 3D interaction points, cutscene management, particle effects, scaleform UI, DUI system, and advanced object placement
2025-04-28 10:35:37 -04:00
---
2025-07-08 04:04:21 -04:00
## Documentation
2025-06-01 17:05:38 -04:00
2025-07-08 04:04:21 -04:00
Complete developer documentation is available at:
[Community Bridge Documentation](https://mrnewbs-scrips.gitbook.io/the-order-of-the-sacred-framework)
2025-06-04 14:25:36 -04:00
---
2025-07-08 04:04:21 -04:00
## Community and Support
2025-06-04 14:25:36 -04:00
2025-07-08 04:04:21 -04:00
Join the Community Bridge Discord server for support, discussion, and contributions:
[Community Discord](https://discord.gg/MukwBuJjP7)
2025-06-04 14:25:36 -04:00
2025-07-08 04:04:21 -04:00
---
2025-06-04 19:42:48 -04:00
2025-07-08 04:04:21 -04:00
## About Community Bridge
2025-06-04 19:42:48 -04:00
2025-07-16 14:19:25 -04:00
community_bridge is developed by The Order of the Sacred Framework, a collaborative team focused on improving interoperability and reducing development friction in the FiveM ecosystem. The project is open source and licensed under GPLv3.
2025-07-13 18:54:24 -04:00
We also have a vscode extension located at https://marketplace.visualstudio.com/items?itemName=TheOrderOfTheSacredFramework.fivem-community-bridge-lua
2025-06-04 19:42:48 -04:00
2025-07-08 04:04:21 -04:00
---
2025-06-04 19:42:48 -04:00
2025-07-08 04:04:21 -04:00
## Why Choose Community Bridge?
2025-06-04 19:42:48 -04:00
2025-07-08 04:04:21 -04:00
* Universal framework compatibility reduces code duplication
* Modular design allows use of only needed components
* Extensive developer utilities for advanced scripting and UI
* Tested in production on hundreds of FiveM servers
* Open source with active community support and regular updates
2025-06-04 19:42:48 -04:00
2025-07-08 04:04:21 -04:00
---
2025-06-04 19:42:48 -04:00
2025-07-08 04:04:21 -04:00
## Frequently Asked Questions
2025-06-04 19:42:48 -04:00
2025-07-08 04:04:21 -04:00
**Q: Will Community Bridge support new frameworks in the future?**
A: Yes, the project actively tracks emerging frameworks and integrates support accordingly.
2025-06-04 19:42:48 -04:00
2025-07-08 04:04:21 -04:00
**Q: Can Community Bridge work with my custom framework?**
A: Community Bridge is designed to be extensible and supports integration with custom frameworks.
2025-06-04 19:42:48 -04:00
2025-07-08 04:04:21 -04:00
**Q: How often is the project updated?**
A: Updates are regularly released to improve compatibility, add features, and fix issues based on community feedback.
2025-06-04 19:42:48 -04:00
2025-07-16 14:20:28 -04:00
**Q: Why is the seo so bad?**
A: Straight up, I have no clue and have tried everything to improve it. If you have tips PLEASE let me know in the discord or pr some changes to the repos dev branch.
2025-07-08 04:04:21 -04:00
---
2025-06-04 19:42:48 -04:00
2025-07-08 04:04:21 -04:00
## Keywords (for SEO)
2025-06-04 19:42:48 -04:00
2025-07-08 04:04:21 -04:00
FiveM framework compatibility, FiveM bridge system, QBCore ESX bridge, FiveM universal inventory, dispatch integration, targeting system, door lock system, vehicle key management, fuel system bridge, clothing system FiveM, FiveM developer tools, roleplay framework integration, Lua scripting FiveM, open source FiveM bridge, cross-framework compatibility, modular FiveM resource
2025-06-04 14:25:36 -04:00
2025-07-08 04:04:21 -04:00
---