# kegarri/sky_project architecture

> Architecture diagram of the GitHub repository kegarri/sky_project, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-05). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/kegarri/sky_project
- Repository: https://github.com/kegarri/sky_project

## Overview

This repository is a bundle of FiveM roleplay-server resources, not one standalone application. Players interact with resource-specific NUI interfaces: for example, the fuel panel accepts refill input and posts it to its resource, while the voice UI displays state sent by the host. Other visible branches include character selection, phone apps, HUD, jobs, vehicles, and server utilities. The README provides no architectural detail; several subsystems are represented from the file tree, so their internal connections are intentionally not inferred.

Main entry points: [`resources/[qb-vehicles]/qb-fuel/html/app.js`](https://github.com/kegarri/sky_project/blob/main/resources/%5Bqb-vehicles%5D/qb-fuel/html/app.js) (Fuel panel), [`resources/[voice]/pma-voice/voice-ui/src/App.vue`](https://github.com/kegarri/sky_project/blob/main/resources/%5Bvoice%5D/pma-voice/voice-ui/src/App.vue) (Voice overlay), [`resources/[qb]/qb-multicharacter/html/app.js`](https://github.com/kegarri/sky_project/blob/main/resources/%5Bqb%5D/qb-multicharacter/html/app.js) (Character selection), [`resources/[voice]/pma-voice/voice-ui/src/main.js`](https://github.com/kegarri/sky_project/blob/main/resources/%5Bvoice%5D/pma-voice/voice-ui/src/main.js) (Voice UI entry)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_player_ui["Player interfaces"]
  node_fuel_ui["Fuel panel<br/>[app.js]"]
  node_fuel_text["Fuel translations<br/>[translations.js]"]
  node_voice_ui["Voice overlay<br/>[App.vue]"]
  node_voice_entry["Voice UI entry<br/>[main.js]"]
  node_hud["HUD<br/>[app.js]"]
  node_pause_menu["Pause menu<br/>[App.vue]"]
  node_phone_manager["Phone manager<br/>[app-manager.js]"]
  node_phone_apps["Phone apps"]
end

subgraph group_roleplay["Roleplay features"]
  node_multicharacter["Character selection<br/>[app.js]"]
  node_banking["Banking UI<br/>[script.js]"]
  node_housing["Housing UI<br/>[script.js]"]
  node_police["Police UI<br/>[script.js]"]
  node_jobs["Job interfaces"]
  node_vehicle_features["Vehicle features"]
  node_race_features["Racing interfaces"]
end

subgraph group_server_runtime["Server runtime"]
  node_host{{"FiveM resource host"}}
  node_session_manager["Session manager<br/>[sm_server.js]"]
  node_voice_server["Voice server<br/>[mute.js]"]
end

subgraph group_support["Resource utilities"]
  node_screenshot["Screenshot capture<br/>[main.ts]"]
end

node_player(("Player"))

node_player -.->|"enters input"| node_fuel_ui
node_fuel_ui -->|"loads translations"| node_fuel_text
node_fuel_ui -->|"posts refill"| node_host
node_host -->|"sends UI state"| node_voice_ui
node_voice_ui -->|"signals readiness"| node_host
node_voice_entry -->|"mounts view"| node_voice_ui
node_host -->|"sends character data"| node_multicharacter
node_multicharacter -->|"requests character action"| node_host
node_phone_manager -.->|"manages apps"| node_phone_apps
node_host -->|"sends HUD updates"| node_hud

click node_fuel_ui "https://github.com/kegarri/sky_project/blob/main/resources/%5Bqb-vehicles%5D/qb-fuel/html/app.js"
click node_fuel_text "https://github.com/kegarri/sky_project/blob/main/resources/%5Bqb-vehicles%5D/qb-fuel/html/translations.js"
click node_voice_ui "https://github.com/kegarri/sky_project/blob/main/resources/%5Bvoice%5D/pma-voice/voice-ui/src/App.vue"
click node_voice_entry "https://github.com/kegarri/sky_project/blob/main/resources/%5Bvoice%5D/pma-voice/voice-ui/src/main.js"
click node_hud "https://github.com/kegarri/sky_project/blob/main/resources/%5Bqb%5D/qb-hud/html/app.js"
click node_pause_menu "https://github.com/kegarri/sky_project/blob/main/resources/%5Bgamemodes%5D/pausemenu/web/src/App.vue"
click node_phone_manager "https://github.com/kegarri/sky_project/blob/main/resources/%5Bgamemodes%5D/sbf_phone/ui/app-manager.js"
click node_phone_apps "https://github.com/kegarri/sky_project/tree/main/resources/%5Bgamemodes%5D/sbf_phone/ui/apps"
click node_multicharacter "https://github.com/kegarri/sky_project/blob/main/resources/%5Bqb%5D/qb-multicharacter/html/app.js"
click node_banking "https://github.com/kegarri/sky_project/blob/main/resources/%5Bqb-bank%5D/qb-banking/html/script.js"
click node_housing "https://github.com/kegarri/sky_project/blob/main/resources/%5Bqb-houses%5D/qb-houses/html/script.js"
click node_police "https://github.com/kegarri/sky_project/blob/main/resources/%5Bqb-police%5D/qb-policejob/html/script.js"
click node_jobs "https://github.com/kegarri/sky_project/tree/main/resources/%5Bqb-jobs%5D"
click node_vehicle_features "https://github.com/kegarri/sky_project/tree/main/resources/%5Bqb-vehicles%5D"
click node_race_features "https://github.com/kegarri/sky_project/tree/main/resources/%5Bqb-races%5D"
click node_session_manager "https://github.com/kegarri/sky_project/blob/main/resources/%5Bcfx-default%5D/%5Bsystem%5D/sessionmanager-rdr3/sm_server.js"
click node_screenshot "https://github.com/kegarri/sky_project/blob/main/resources/%5Bstandalone%5D/screenshot-basic/ui/src/main.ts"
click node_voice_server "https://github.com/kegarri/sky_project/blob/main/resources/%5Bvoice%5D/pma-voice/server/mute.js"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_fuel_ui,node_fuel_text,node_voice_ui,node_voice_entry,node_hud,node_pause_menu,node_phone_manager,node_phone_apps toneBlue
class node_multicharacter,node_banking,node_housing,node_police,node_jobs,node_vehicle_features,node_race_features toneAmber
class node_host,node_session_manager,node_voice_server toneMint
class node_screenshot toneRose
class node_player toneIndigo
```

## Components

### Player interfaces

- [Fuel panel](https://github.com/kegarri/sky_project/blob/main/resources/%5Bqb-vehicles%5D/qb-fuel/html/app.js): `resources/[qb-vehicles]/qb-fuel/html/app.js`
- [Fuel translations](https://github.com/kegarri/sky_project/blob/main/resources/%5Bqb-vehicles%5D/qb-fuel/html/translations.js): `resources/[qb-vehicles]/qb-fuel/html/translations.js`
- [Voice overlay](https://github.com/kegarri/sky_project/blob/main/resources/%5Bvoice%5D/pma-voice/voice-ui/src/App.vue): `resources/[voice]/pma-voice/voice-ui/src/App.vue`
- [Voice UI entry](https://github.com/kegarri/sky_project/blob/main/resources/%5Bvoice%5D/pma-voice/voice-ui/src/main.js): `resources/[voice]/pma-voice/voice-ui/src/main.js`
- [HUD](https://github.com/kegarri/sky_project/blob/main/resources/%5Bqb%5D/qb-hud/html/app.js): `resources/[qb]/qb-hud/html/app.js`
- [Pause menu](https://github.com/kegarri/sky_project/blob/main/resources/%5Bgamemodes%5D/pausemenu/web/src/App.vue): `resources/[gamemodes]/pausemenu/web/src/App.vue`
- [Phone manager](https://github.com/kegarri/sky_project/blob/main/resources/%5Bgamemodes%5D/sbf_phone/ui/app-manager.js): `resources/[gamemodes]/sbf_phone/ui/app-manager.js`
- [Phone apps](https://github.com/kegarri/sky_project/tree/main/resources/%5Bgamemodes%5D/sbf_phone/ui/apps): `resources/[gamemodes]/sbf_phone/ui/apps`

### Roleplay features

- [Character selection](https://github.com/kegarri/sky_project/blob/main/resources/%5Bqb%5D/qb-multicharacter/html/app.js): `resources/[qb]/qb-multicharacter/html/app.js`
- [Banking UI](https://github.com/kegarri/sky_project/blob/main/resources/%5Bqb-bank%5D/qb-banking/html/script.js): `resources/[qb-bank]/qb-banking/html/script.js`
- [Housing UI](https://github.com/kegarri/sky_project/blob/main/resources/%5Bqb-houses%5D/qb-houses/html/script.js): `resources/[qb-houses]/qb-houses/html/script.js`
- [Police UI](https://github.com/kegarri/sky_project/blob/main/resources/%5Bqb-police%5D/qb-policejob/html/script.js): `resources/[qb-police]/qb-policejob/html/script.js`
- [Job interfaces](https://github.com/kegarri/sky_project/tree/main/resources/%5Bqb-jobs%5D): `resources/[qb-jobs]`
- [Vehicle features](https://github.com/kegarri/sky_project/tree/main/resources/%5Bqb-vehicles%5D): `resources/[qb-vehicles]`
- [Racing interfaces](https://github.com/kegarri/sky_project/tree/main/resources/%5Bqb-races%5D): `resources/[qb-races]`

### Server runtime

- **FiveM resource host**
- [Session manager](https://github.com/kegarri/sky_project/blob/main/resources/%5Bcfx-default%5D/%5Bsystem%5D/sessionmanager-rdr3/sm_server.js): `resources/[cfx-default]/[system]/sessionmanager-rdr3/sm_server.js`
- [Voice server](https://github.com/kegarri/sky_project/blob/main/resources/%5Bvoice%5D/pma-voice/server/mute.js): `resources/[voice]/pma-voice/server/mute.js`

### Resource utilities

- [Screenshot capture](https://github.com/kegarri/sky_project/blob/main/resources/%5Bstandalone%5D/screenshot-basic/ui/src/main.ts): `resources/[standalone]/screenshot-basic/ui/src/main.ts`

### Other components

- **Player**

## Connections

- Player → Fuel panel: enters input
- Fuel panel → Fuel translations: loads translations (evidence: `resources/[qb-vehicles]/qb-fuel/html/app.js`)
- Fuel panel → FiveM resource host: posts refill (evidence: `resources/[qb-vehicles]/qb-fuel/html/app.js`)
- FiveM resource host → Voice overlay: sends UI state (evidence: `resources/[voice]/pma-voice/voice-ui/src/App.vue`)
- Voice overlay → FiveM resource host: signals readiness (evidence: `resources/[voice]/pma-voice/voice-ui/src/App.vue`)
- Voice UI entry → Voice overlay: mounts view (evidence: `resources/[voice]/pma-voice/voice-ui/src/main.js`)
- FiveM resource host → Character selection: sends character data (evidence: `resources/[qb]/qb-multicharacter/html/app.js`)
- Character selection → FiveM resource host: requests character action (evidence: `resources/[qb]/qb-multicharacter/html/app.js`)
- Phone manager → Phone apps: manages apps
- FiveM resource host → HUD: sends HUD updates (evidence: `resources/[qb]/qb-hud/html/app.js`)
