> For the complete documentation index, see [llms.txt](https://f4-studio.gitbook.io/documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://f4-studio.gitbook.io/documentation/resources/f4-multimode.md).

# f4-multimode

Welcome to the official GitBook documentation for F4 Multimode.

F4 Multimode is a game platform for FiveM: an in-game map creator, 18 game modes, lobbies, matchmaking, playlists, a podium ceremony, player profiles and a shared map library. Every match runs in its own routing bucket, so nothing that happens in a session touches the city around it.

This documentation is written for servers using the escrow-protected package. It only describes the files and public integration surfaces that customers are expected to access:

* `config/`
* `adapters/`
* `extensions/`
* `locales/`
* `open.lua`
* Public exports, events, hooks, commands and ACE permissions

Encrypted source files are not part of the customer editing surface. When a behavior depends on encrypted runtime code, the documentation explains the public contract instead of asking you to edit protected files.

{% hint style="info" %}
Keep your custom work in the open files listed above. This makes updates safer and avoids losing changes when replacing escrow files.
{% endhint %}

## What you can do with these docs

* Install F4 Multimode on QBX, QB-Core, ESX or standalone.
* Configure branding, keybinds, permissions, rewards, gameplay timings, default match rules and lobby behavior.
* Build maps in the in-game Creator, import scene XML, and publish them through the moderation queue.
* Run the moderation queue, hand out Creator and admin rights, and read live runtime figures.
* Receive approved maps from the F4 Studio library, or switch the ecosystem off and stay fully local.
* Integrate other resources through server exports, client exports, `f4:integration:*` events and `open.lua` hooks.
* Register your own game modes on the existing engines.

## Recommended reading order

1. [Requirements](/documentation/resources/f4-multimode/getting-started/requirements.md)
2. [Installation](/documentation/resources/f4-multimode/getting-started/installation.md)
3. [Permissions](/documentation/resources/f4-multimode/getting-started/permissions.md)
4. [Escrow and Editable Files](/documentation/resources/f4-multimode/getting-started/escrow-and-editable-files.md)
5. [Main Configuration](/documentation/resources/f4-multimode/configuration/main-configuration.md)
6. [Creator Overview](/documentation/resources/f4-multimode/creator/creator-overview.md)
7. [Game Modes](/documentation/resources/f4-multimode/gameplay/game-modes.md)
8. [Moderation](/documentation/resources/f4-multimode/administration/moderation.md)
9. [Server Exports](/documentation/resources/f4-multimode/api/server-exports.md)