# UgCore

> A server-authoritative, headless and modular FiveM framework.

- [UgCore](https://ugcore.urging.ch/index.md): A server-authoritative, headless and modular FiveM framework.
- [Introduction](https://ugcore.urging.ch/introduction.md): What UgCore is, who it is for and what makes it different.
- [Installation](https://ugcore.urging.ch/installation.md): Install ug-core on an FXServer with OneSync and oxmysql.
- [Quickstart](https://ugcore.urging.ch/quickstart.md): Build a resource on UgCore: a validated callback, a chat command and an event listener.
- [Architecture](https://ugcore.urging.ch/architecture.md): How ug-core boots, how modules load and how other resources reach the API.
- [Configuration](https://ugcore.urging.ch/owners/configuration.md): One config folder, generated on first boot, validated on every boot.
- [Modules](https://ugcore.urging.ch/owners/modules.md): Enable only the features your server needs.
- [Database](https://ugcore.urging.ch/owners/database.md): Requirements, migrations and what ug-core stores.
- [Permissions](https://ugcore.urging.ch/owners/permissions.md): Grant permissions per identifier. They are applied as ACEs, so every check agrees.
- [Guard](https://ugcore.urging.ch/owners/guard.md): Scores suspicious behavior per player and acts on thresholds you set.
- [The ug console](https://ugcore.urging.ch/owners/console.md): Inspect the framework from the server console.
- [Troubleshooting](https://ugcore.urging.ch/owners/troubleshooting.md): Common boot errors and what they mean.
- [Importing UgCore](https://ugcore.urging.ch/developers/importing.md): One shared script gives your resource the whole API.
- [Callbacks](https://ugcore.urging.ch/developers/callbacks.md): Request and response between client and server, validated and rate limited.
- [Net events](https://ugcore.urging.ch/developers/net-events.md): Fire-and-forget messages between client and server, with the same protection as callbacks.
- [Schemas](https://ugcore.urging.ch/developers/schemas.md): Bounded validators for everything a client sends.
- [Events](https://ugcore.urging.ch/developers/events.md): React to what happens in the framework.
- [Hooks](https://ugcore.urging.ch/developers/hooks.md): Cancel or change core actions before they happen.
- [Lifecycle](https://ugcore.urging.ch/developers/lifecycle.md): Know when ug-core is ready, and run code at the right moment.
- [Statebags](https://ugcore.urging.ch/developers/statebags.md): Read player state without a single export call.
- [Version requirements](https://ugcore.urging.ch/developers/versioning.md): Make your resource refuse to run on a ug-core that is too old.
- [Security model](https://ugcore.urging.ch/concepts/security.md): Every client is hostile until proven otherwise. Four layers, each working alone.
- [Death system](https://ugcore.urging.ch/concepts/death-system.md): Server-authoritative death state, injuries and a downed flow.
- [API overview](https://ugcore.urging.ch/api/overview.md): Conventions shared by every UgCore function.
- [Enums](https://ugcore.urging.ch/api/enums.md): Every magic value of the framework, in one place.
- [UgCore.Events](https://ugcore.urging.ch/api/events.md): Local event bus with spoofing protection for ug-core events.
- [UgCore.Lifecycle](https://ugcore.urging.ch/api/lifecycle.md): The boot state of ug-core.
- [UgCore.Config](https://ugcore.urging.ch/api/config.md): Read resolved configuration values.
- [UgCore.Logger](https://ugcore.urging.ch/api/logger.md): Leveled console output.
- [UgCore.Version](https://ugcore.urging.ch/api/version.md): Require a minimum ug-core version.
- [UgCore.Modules](https://ugcore.urging.ch/api/modules.md): Which modules are enabled.
- [UgCore.Schema](https://ugcore.urging.ch/api/schema.md): Bounded validators for every value a client sends.
- [UgCore.RateLimit](https://ugcore.urging.ch/api/ratelimit.md): Token bucket limiters.
- [UgCore.Callback](https://ugcore.urging.ch/api/callback.md): Request and response between client and server.
- [UgCore.Network](https://ugcore.urging.ch/api/network.md): Validated, rate limited net events.
- [UgCore.Guard](https://ugcore.urging.ch/api/guard.md): Suspicion scoring and server-side distance checks.
- [UgCore.Hooks](https://ugcore.urging.ch/api/hooks.md): Cancel or change actions before they happen.
- [UgCore.Identity](https://ugcore.urging.ch/api/identity.md): Identifiers and bans.
- [UgCore.Players](https://ugcore.urging.ch/api/players.md): Connected players, metadata and death state.
- [UgCore.LocalPlayer](https://ugcore.urging.ch/api/localplayer.md): The local player, from statebags.
- [UgCore.Permissions](https://ugcore.urging.ch/api/permissions.md): Persistent ACE grants.
- [UgCore.Characters](https://ugcore.urging.ch/api/characters.md): Multiple characters per player.
- [UgCore.Accounts](https://ugcore.urging.ch/api/accounts.md): Cash, bank and custom accounts with a ledger.
- [UgCore.Jobs](https://ugcore.urging.ch/api/jobs.md): Jobs, grades and duty.
- [UgCore.Gangs](https://ugcore.urging.ch/api/gangs.md): Gangs and grades.
- [UgCore.Sessions](https://ugcore.urging.ch/api/sessions.md): Isolated worlds on routing buckets.
- [UgCore.Commands](https://ugcore.urging.ch/api/commands.md): Typed, rate limited chat commands.
- [UgCore.Locale](https://ugcore.urging.ch/api/locale.md): Core messages in the server language.
- [Error codes](https://ugcore.urging.ch/reference/error-codes.md): Every code a function or a client can receive.
- [Events](https://ugcore.urging.ch/reference/events.md): Every event ug-core emits.
- [Hooks](https://ugcore.urging.ch/reference/hooks.md): Every hook and its payload.
- [Statebags](https://ugcore.urging.ch/reference/statebags.md): Every statebag ug-core writes.
- [Convars](https://ugcore.urging.ch/reference/convars.md): Override any config option from server.cfg.
- [Config files](https://ugcore.urging.ch/reference/config-files.md): Every option of every config file.
- [Contributing](https://ugcore.urging.ch/contributing/overview.md): Help build UgCore.
- [Conventions](https://ugcore.urging.ch/contributing/conventions.md): Naming, typing, errors and commits.
- [Testing](https://ugcore.urging.ch/contributing/testing.md): The two checks every change passes.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.