diff --git a/README.md b/README.md index e93a27a..30a1a87 100644 --- a/README.md +++ b/README.md @@ -1,305 +1,99 @@ -# ๐ŸŒ‰ Community Bridge -> **By The Order of the Sacred Framework** +# Community Bridge -
+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. -![Used by 500+ servers](https://img.shields.io/badge/used%20by-500%2B%20servers-6e7781?style=flat&logo=github) -![](https://img.shields.io/github/contributors/The-Order-Of-The-Sacred-Framework/community_bridge?logo=github) -![](https://img.shields.io/github/v/release/The-Order-Of-The-Sacred-Framework/community_bridge?logo=github) - -*A modular, beginner-friendly collection of tools and systems designed to simplify and unify FiveM development.* - -**Built with โค๏ธ by the community, for the community** - -
+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. --- -## ๐Ÿ“š Documentation +## Features -Read the full documentation here: -๐Ÿ‘‰ [Our Gitbook Here](https://mrnewbs-scrips.gitbook.io/the-order-of-the-sacred-framework) +### Framework Compatibility + +* Supports QBCore, ESX, QBox, and custom roleplay frameworks +* Provides a unified API to standardize resource interaction + +### Inventory Systems + +* Compatible with ox\_inventory, qb-inventory, ps-inventory, codem-inventory, core\_inventory, and others + +### Dispatch and MDT + +* Integrates with ps-dispatch, cd\_dispatch, lb-tablet, bub\_mdt, and other dispatch systems +* Includes fallback mechanisms to ensure notifications are delivered + +### Targeting Systems + +* Works with qb-target, ox\_target, sleepless-interact, and similar targeting resources + +### Doorlock and Security + +* Supports ox\_doorlock, qb-doorlock, rcore\_doorlock, jacksams-doorlock, and other door lock systems + +### Vehicle Keys and Locking + +* Compatible with all major vehicle key management systems + +### Fuel Systems + +* Supports all major fuel resources such as legacyfuel, ps-fuel, and more + +### Clothing and Appearance + +* Integrates with illenium-appearance, fivem-appearance, qb-clothing, esx\_skin, and default fallback clothing systems + +### Additional Features + +* 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 --- -## ๐Ÿ’ฌ Join the Community +## Documentation -Have questions, suggestions, or want to contribute? Join us on Discord: -๐Ÿ‘‰ [Our Discord Here](https://discord.gg/MukwBuJjP7) +Complete developer documentation is available at: +[Community Bridge Documentation](https://mrnewbs-scrips.gitbook.io/the-order-of-the-sacred-framework) --- -## ๐Ÿš€ Overview & Features +## Community and Support -**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. +Join the Community Bridge Discord server for support, discussion, and contributions: +[Community Discord](https://discord.gg/MukwBuJjP7) --- -## ๐Ÿค Community-Driven +## About Community Bridge -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. +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. --- -## ๐Ÿงฐ Why Use Community Bridge? +## Why Choose 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 +* 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 --- -## โ“ Frequently Asked Questions +## Frequently Asked Questions -
-Click to expand FAQ +**Q: Will Community Bridge support new frameworks in the future?** +A: Yes, the project actively tracks emerging frameworks and integrates support accordingly. -**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: Can Community Bridge work with my custom framework?** +A: Community Bridge is designed to be extensible and supports integration with custom frameworks. -**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. - -
+**Q: How often is the project updated?** +A: Updates are regularly released to improve compatibility, add features, and fix issues based on community feedback. --- -> "Connecting what matters โ€” frameworks unified, development simplified." +## Keywords (for SEO) -
- -**Made with โค๏ธ by The Order of the Sacred Framework** - -![GitHub stars](https://img.shields.io/github/stars/The-Order-Of-The-Sacred-Framework/community_bridge?style=social) -![Discord](https://img.shields.io/discord/1337224918710095882?style=social) - -
+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 --- - -## ๐Ÿ” SEO & Keywords - -
-Click to expand SEO information and keywords - -### ๐Ÿท๏ธ Primary Keywords -- **FiveM Bridge** - Universal compatibility layer for FiveM servers -- **FiveM Framework Compatibility** - Cross-framework development solution -- **QB-Core Bridge** - QB-Core to universal system bridge -- **ESX Bridge** - ESX framework compatibility layer -- **QBox Framework Support** - QBox integration and compatibility -- **FiveM Development Tools** - Comprehensive development utilities -- **FiveM Resource Bridge** - Universal resource compatibility system -- **Lua FiveM Framework** - Lua-based framework unification - -### ๐ŸŽฏ Secondary Keywords -- FiveM inventory bridge, FiveM dispatch integration, FiveM targeting system -- Universal FiveM scripts, Cross-framework FiveM resources, FiveM compatibility layer -- QB-Core ESX bridge, Multi-framework FiveM development, FiveM script compatibility -- Open source FiveM bridge, Community FiveM tools, FiveM developer resources -- Modular FiveM framework, Beginner-friendly FiveM development, FiveM code bridge - -### ๐ŸŒ Long-tail Keywords -- "How to make FiveM scripts work with multiple frameworks" -- "Universal FiveM framework compatibility solution" -- "FiveM QB-Core ESX QBox bridge resource" -- "Cross-framework FiveM development made easy" -- "One script multiple FiveM frameworks compatibility" -- "FiveM framework agnostic development tools" -- "community_bridge" -- "communitybridge" -- "community-bridge" -- "Universal FiveM inventory dispatch targeting bridge" - -### ๐Ÿ“Š Technical Tags -`fivem` `lua` `qb-core` `esx` `qbox` `framework` `bridge` `compatibility` `universal` `modular` `open-source` `community` `development` `tools` `utilities` `scripts` `resources` `gta5` `roleplay` `server` `multiplayer` `fivem-scripts` `fxmanifest` `citizenfx` `rockstar-games` `gtav` `gta-online` `server-sided` `client-sided` `shared-resources` `ox-lib` `ox-inventory` `qb-inventory` `ps-inventory` `vrp` `standalone` `mysql` `oxmysql` `nui` `ui` `html` `css` `javascript` `typescript` `json` `cfg` `config` `exports` `events` `callbacks` `threading` `optimization` - -### ๐ŸŽฎ Gaming & RP Tags -`gta5-mods` `roleplay-server` `fivem-server` `gta-roleplay` `multiplayer-gaming` `server-development` `game-modifications` `roleplay-framework` `gaming-community` `server-resources` `rp-server` `roleplay-scripts` `fivem-mods` `gta-mods` `custom-scripts` `server-scripts` `roleplay-resources` `fivem-resources` `gtarp` `rp-framework` `city-roleplay` `serious-rp` `whitelist-server` `public-server` `economy-scripts` `job-scripts` `gang-scripts` `police-scripts` `ems-scripts` `mechanic-scripts` `real-estate` `housing-system` `vehicle-system` `inventory-system` `banking-system` `phone-system` `dispatch-system` `mdt-system` `clothing-system` `appearance-system` - -### ๐Ÿ”ง Developer Tags -`lua-scripting` `game-development` `framework-integration` `api-wrapper` `developer-tools` `code-bridge` `system-integration` `modular-design` `plug-and-play` `cross-platform` `fivem-development` `cfx-server` `server-owner` `server-admin` `fivem-coding` `lua-programming` `gta-scripting` `mod-development` `resource-development` `script-development` `fivem-framework` `qb-development` `esx-development` `custom-framework` `framework-bridge` `universal-bridge` `compatibility-layer` `multi-framework` `cross-framework` `framework-agnostic` `developer-friendly` `beginner-friendly` `advanced-scripting` `professional-scripts` `production-ready` `server-optimization` `performance-optimization` `code-optimization` - -### ๐Ÿš€ Popular FiveM Community Tags -`fivem-community` `cfx-community` `roleplay-community` `gta-community` `mod-community` `script-sharing` `open-source-fivem` `fivem-github` `fivem-discord` `fivem-forum` `tebex-fivem` `fivem-store` `premium-scripts` `free-scripts` `leaked-scripts` `custom-vehicles` `custom-maps` `custom-sounds` `custom-weapons` `custom-clothing` `mlo` `ymap` `stream-files` `replace-files` `addon-vehicles` `replace-vehicles` `car-pack` `weapon-pack` `clothing-pack` `sound-pack` - -### ๐Ÿข Business & Economy Tags -`fivem-business` `roleplay-economy` `virtual-economy` `in-game-currency` `money-system` `shop-system` `marketplace` `auction-system` `real-estate-system` `property-system` `rental-system` `loan-system` `tax-system` `paycheck-system` `salary-system` `job-payment` `commission-system` `trading-system` `crafting-system` `manufacturing` `farming-system` `mining-system` `fishing-system` - -### ๐Ÿš” Emergency Services Tags -`police-system` `sheriff-department` `state-police` `federal-agents` `ems-system` `fire-department` `ambulance-service` `dispatch-center` `911-system` `emergency-response` `law-enforcement` `first-responders` `medical-system` `hospital-system` `jail-system` `prison-system` `court-system` `legal-system` `lawyer-system` `judge-system` `probation-system` - -### ๐ŸŽ๏ธ Vehicle & Transportation Tags -`vehicle-system` `car-dealership` `vehicle-shop` `custom-vehicles` `vehicle-modifications` `vehicle-tuning` `racing-system` `drag-racing` `street-racing` `car-meets` `vehicle-rental` `taxi-system` `uber-system` `trucking-system` `delivery-system` `towing-system` `impound-system` `vehicle-insurance` `fuel-system` `garage-system` `parking-system` `traffic-system` `speed-cameras` `toll-system` - -### ๐ŸŽญ Character & Appearance Tags -`character-creation` `character-customization` `appearance-system` `clothing-system` `barber-system` `tattoo-system` `makeup-system` `accessories` `jewelry-system` `character-stats` `skill-system` `leveling-system` `experience-system` `reputation-system` `gang-system` `faction-system` `organization-system` `whitelist-system` `character-slots` `character-selection` - -### ๐Ÿ  Housing & Properties Tags -`housing-system` `real-estate` `property-system` `apartment-system` `house-system` `mansion-system` `interior-system` `furniture-system` `decoration-system` `roommate-system` `landlord-system` `rent-system` `mortgage-system` `property-management` `neighborhood-system` `gated-community` `luxury-homes` `affordable-housing` - -### ๐Ÿ“ฆ Inventory System Tags -`ox-inventory` `qb-inventory` `ps-inventory` `qs-inventory` `codem-inventory` `core-inventory` `jpr-inventory` `tgiann-inventory` `origen-inventory` `inventory-bridge` `universal-inventory` `inventory-system` `item-system` `crafting-inventory` `weight-system` `slot-system` `inventory-ui` `item-metadata` `inventory-exports` - -### ๐Ÿšจ Dispatch & MDT System Tags -`ps-dispatch` `cd-dispatch` `qs-dispatch` `lb-tablet` `bub-mdt` `redutzu-mdt` `tk-dispatch` `linden-outlawalert` `dispatch-system` `mdt-system` `911-dispatch` `emergency-dispatch` `police-dispatch` `ems-dispatch` `fire-dispatch` `dispatch-bridge` `universal-dispatch` `alert-system` - -### ๐ŸŽฏ Target System Tags -`ox-target` `qb-target` `sleepless-interact` `target-system` `interaction-system` `targeting-bridge` `universal-targeting` `entity-targeting` `object-interaction` `ped-interaction` `vehicle-interaction` `zone-targeting` `raycast-targeting` `contextual-interaction` - -### ๐Ÿšช Doorlock System Tags -`ox-doorlock` `qb-doorlock` `rcore-doorlock` `doors-creator` `doorlock-system` `door-bridge` `universal-doorlock` `access-control` `key-system` `lock-system` `security-system` `door-management` `restricted-access` `keycard-system` - -### ๐Ÿ”‘ Vehicle Key System Tags -`qb-vehiclekeys` `qbx-vehiclekeys` `cd-garage` `okokgarage` `jacksam` `wasabi-carlock` `qs-vehiclekeys` `renewed-vehiclekeys` `t1ger-keys` `mk-vehiclekeys` `mono-carkeys` `mrnewbvehiclekeys` `f-realcarkeyssystem` `vehicle-keys` `car-keys` `key-system` `vehicle-security` `keyless-entry` `immobilizer` `hotwire-system` - -### โ›ฝ Fuel System Tags -`ox-fuel` `ps-fuel` `qs-fuelstations` `legacyfuel` `cdn-fuel` `renewed-fuel` `ti-fuel` `x-fuel` `lc-fuel` `bigdaddy-fuel` `esx-sna-fuel` `okokgasstation` `fuel-system` `gas-station` `vehicle-fuel` `fuel-consumption` `refueling` `fuel-economy` `electric-vehicles` - -### ๐Ÿ  Housing Integration Tags -`qb-houses` `qb-appartments` `ps-housing` `bcs-housing` `esx-property` `housing-bridge` `property-bridge` `real-estate-bridge` `apartment-system` `house-system` `interior-system` `property-management` `housing-compatibility` - -### ๐Ÿ“ฑ Phone System Tags -`lb-phone` `okokphone` `qs-smartphone` `gksphone` `phone-system` `smartphone` `mobile-phone` `phone-bridge` `universal-phone` `communication-system` `messaging-system` `call-system` `contact-system` `phone-apps` - -### ๐Ÿ”” Notification System Tags -`ox-lib` `okoknotify` `mythic-notify` `t-notify` `r-notify` `pnotify` `wasabi-notify` `notification-system` `alert-system` `notify-bridge` `universal-notifications` `toast-notifications` `popup-system` `message-system` - -### ๐Ÿ’ฐ Banking System Tags -`qb-banking` `renewed-banking` `fd-banking` `okokbanking` `banking-system` `financial-system` `atm-system` `bank-account` `transaction-system` `money-transfer` `payment-system` `banking-bridge` `universal-banking` - -### ๐Ÿ‘• Clothing & Appearance Tags -`qb-clothing` `fivem-appearance` `illenium-appearance` `esx-skin` `clothing-system` `appearance-system` `character-customization` `wardrobe-system` `outfit-system` `skin-system` `customization-bridge` `appearance-bridge` - -### ๐ŸŒค๏ธ Weather System Tags -`qb-weathersync` `renewed-weathersync` `cd-easytime` `weather-system` `time-system` `weather-sync` `climate-system` `day-night-cycle` `weather-bridge` `environmental-system` - -### ๐Ÿ“ˆ Skills & XP System Tags -`pickle-xp` `ot-skills` `evolent-skills` `skill-system` `experience-system` `leveling-system` `progression-system` `xp-system` `character-stats` `skills-bridge` `universal-skills` - -### ๐Ÿ’ฌ UI & Input System Tags -`ox-lib` `qb-input` `qb-menu` `qb-progressbar` `cd-drawtextui` `jg-textui` `lab-hintui` `okoktextui` `ui-system` `input-system` `menu-system` `progressbar-system` `textui-system` `help-system` `user-interface` `interactive-ui` - -### ๐Ÿ—๏ธ Framework Integration Tags -`qb-core` `qbx-core` `es-extended` `esx` `qbox` `framework-bridge` `multi-framework` `cross-framework` `framework-compatibility` `universal-framework` `framework-agnostic` `compatibility-layer` `bridge-system` `framework-unification` - -