# cr1gger/game-spy architecture

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

- Interactive diagram: https://gitdiagram.com/cr1gger/game-spy
- Repository: https://github.com/cr1gger/game-spy

## Overview

Game Spy is a spy-party game with a Vue/Capacitor client and a Yii backend for word/category data and administration. Players configure a round, choose categories, and start; the menu fetches words locally or from the API, selects a word, and passes the round settings to the game view. The client also caches categories and words for offline use. The backend exposes game data and provides authenticated content and user administration. Some backend routing and game-view details were not sampled, so those links are omitted or marked unverified.

Main entry points: [`src/components/GameMenu.vue`](https://github.com/cr1gger/game-spy/blob/master/src/components/GameMenu.vue) (Round menu), [`src/components/MainGame.vue`](https://github.com/cr1gger/game-spy/blob/master/src/components/MainGame.vue) (Game view), [`src/use/local-db.js`](https://github.com/cr1gger/game-spy/blob/master/src/use/local-db.js) (Offline data), [`backend/controllers/WordController.php`](https://github.com/cr1gger/game-spy/blob/master/backend/controllers/WordController.php) (Word admin)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_client["Game client"]
  node_app["App shell<br/>[App.vue]"]
  node_home["Home view<br/>[HomeView.vue]"]
  node_local_data["Offline data<br/>[local-db.js]"]
  node_preferences[("Local preferences<br/>[local-db.js]")]
  node_router["Client router<br/>[index.js]"]
  node_bootstrap["Client bootstrap<br/>[main.js]"]
end

subgraph group_gameplay["Round gameplay"]
  node_menu["Round menu<br/>[GameMenu.vue]"]
  node_settings["Game settings<br/>[GameSetting.vue]"]
  node_rules["Rules modal<br/>[GameRulesModal.vue]"]
  node_main_game["Game view<br/>[MainGame.vue]"]
  node_cards["Player cards<br/>[GameCard.vue]"]
  node_timer["Round timer<br/>[GameTimer.vue]"]
  node_game_helpers["Game helpers<br/>[Helper.js]"]
end

subgraph group_backend["Backend API"]
  node_backend_entry["Web entry<br/>[index.php]"]
  node_web_config["Web configuration<br/>[web.php]"]
  node_api["Game data API<br/>[ApiController.php]"]
  node_categories[("Category records<br/>[Category.php]")]
  node_words[("Word records<br/>[Words.php]")]
end

subgraph group_admin["Administration"]
  node_category_admin["Category admin"]
  node_word_admin["Word admin<br/>[WordController.php]"]
  node_admin_base["Admin access base"]
  node_login_form["Login form<br/>[LoginForm.php]"]
  node_user_model[("User records<br/>[User.php]")]
  node_user_service["User creation<br/>[UserService.php]"]
  node_user_command["User command<br/>[UserController.php]"]
end

node_player(("Players"))

node_player -.->|"opens"| node_home
node_bootstrap -->|"mounts"| node_app
node_bootstrap -->|"registers"| node_router
node_router -->|"routes to"| node_home
node_app -->|"loads data"| node_local_data
node_app -->|"reads and writes"| node_preferences
node_home -->|"renders"| node_main_game
node_main_game -->|"renders"| node_menu
node_main_game -->|"renders"| node_cards
node_main_game -->|"renders"| node_timer
node_main_game -->|"uses"| node_game_helpers
node_menu -->|"loads words"| node_local_data
node_menu -->|"selects word"| node_game_helpers
node_menu -->|"opens"| node_settings
node_menu -->|"opens"| node_rules
node_local_data -->|"caches data"| node_preferences
node_local_data -.->|"requests data"| node_api
node_backend_entry -->|"loads"| node_web_config
node_api -->|"queries"| node_categories
node_api -->|"queries"| node_words
node_category_admin -->|"extends"| node_admin_base
node_word_admin -->|"extends"| node_admin_base
node_category_admin -->|"manages"| node_categories
node_word_admin -->|"loads categories"| node_categories
node_word_admin -->|"manages"| node_words
node_login_form -->|"authenticates"| node_user_model
node_user_command -->|"creates user"| node_user_service
node_user_service -->|"saves user"| node_user_model

click node_app "https://github.com/cr1gger/game-spy/blob/master/src/App.vue"
click node_home "https://github.com/cr1gger/game-spy/blob/master/src/views/HomeView.vue"
click node_menu "https://github.com/cr1gger/game-spy/blob/master/src/components/GameMenu.vue"
click node_settings "https://github.com/cr1gger/game-spy/blob/master/src/components/GameSetting.vue"
click node_rules "https://github.com/cr1gger/game-spy/blob/master/src/components/GameRulesModal.vue"
click node_main_game "https://github.com/cr1gger/game-spy/blob/master/src/components/MainGame.vue"
click node_cards "https://github.com/cr1gger/game-spy/blob/master/src/components/GameCard.vue"
click node_timer "https://github.com/cr1gger/game-spy/blob/master/src/components/GameTimer.vue"
click node_game_helpers "https://github.com/cr1gger/game-spy/blob/master/src/use/Helper.js"
click node_local_data "https://github.com/cr1gger/game-spy/blob/master/src/use/local-db.js"
click node_preferences "https://github.com/cr1gger/game-spy/blob/master/src/use/local-db.js"
click node_router "https://github.com/cr1gger/game-spy/blob/master/src/router/index.js"
click node_bootstrap "https://github.com/cr1gger/game-spy/blob/master/src/main.js"
click node_backend_entry "https://github.com/cr1gger/game-spy/blob/master/backend/web/index.php"
click node_web_config "https://github.com/cr1gger/game-spy/blob/master/backend/config/web.php"
click node_api "https://github.com/cr1gger/game-spy/blob/master/backend/controllers/ApiController.php"
click node_categories "https://github.com/cr1gger/game-spy/blob/master/backend/models/Category.php"
click node_words "https://github.com/cr1gger/game-spy/blob/master/backend/models/Words.php"
click node_category_admin "https://github.com/cr1gger/game-spy/blob/master/backend/controllers/CategoryController.php"
click node_word_admin "https://github.com/cr1gger/game-spy/blob/master/backend/controllers/WordController.php"
click node_admin_base "https://github.com/cr1gger/game-spy/blob/master/backend/controllers/base/BaseAdminController.php"
click node_login_form "https://github.com/cr1gger/game-spy/blob/master/backend/models/LoginForm.php"
click node_user_model "https://github.com/cr1gger/game-spy/blob/master/backend/models/User.php"
click node_user_service "https://github.com/cr1gger/game-spy/blob/master/backend/services/UserService.php"
click node_user_command "https://github.com/cr1gger/game-spy/blob/master/backend/commands/UserController.php"

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_app,node_home,node_local_data,node_preferences,node_router,node_bootstrap toneBlue
class node_menu,node_settings,node_rules,node_main_game,node_cards,node_timer,node_game_helpers toneAmber
class node_backend_entry,node_web_config,node_api,node_categories,node_words toneMint
class node_category_admin,node_word_admin,node_admin_base,node_login_form,node_user_model,node_user_service,node_user_command toneRose
class node_player toneIndigo
```

## Components

### Game client

- [App shell](https://github.com/cr1gger/game-spy/blob/master/src/App.vue): `src/App.vue`
- [Home view](https://github.com/cr1gger/game-spy/blob/master/src/views/HomeView.vue): `src/views/HomeView.vue`
- [Offline data](https://github.com/cr1gger/game-spy/blob/master/src/use/local-db.js): `src/use/local-db.js`
- [Local preferences](https://github.com/cr1gger/game-spy/blob/master/src/use/local-db.js): `src/use/local-db.js`
- [Client router](https://github.com/cr1gger/game-spy/blob/master/src/router/index.js): `src/router/index.js`
- [Client bootstrap](https://github.com/cr1gger/game-spy/blob/master/src/main.js): `src/main.js`

### Round gameplay

- [Round menu](https://github.com/cr1gger/game-spy/blob/master/src/components/GameMenu.vue): `src/components/GameMenu.vue`
- [Game settings](https://github.com/cr1gger/game-spy/blob/master/src/components/GameSetting.vue): `src/components/GameSetting.vue`
- [Rules modal](https://github.com/cr1gger/game-spy/blob/master/src/components/GameRulesModal.vue): `src/components/GameRulesModal.vue`
- [Game view](https://github.com/cr1gger/game-spy/blob/master/src/components/MainGame.vue): `src/components/MainGame.vue`
- [Player cards](https://github.com/cr1gger/game-spy/blob/master/src/components/GameCard.vue): `src/components/GameCard.vue`
- [Round timer](https://github.com/cr1gger/game-spy/blob/master/src/components/GameTimer.vue): `src/components/GameTimer.vue`
- [Game helpers](https://github.com/cr1gger/game-spy/blob/master/src/use/Helper.js): `src/use/Helper.js`

### Backend API

- [Web entry](https://github.com/cr1gger/game-spy/blob/master/backend/web/index.php): `backend/web/index.php`
- [Web configuration](https://github.com/cr1gger/game-spy/blob/master/backend/config/web.php): `backend/config/web.php`
- [Game data API](https://github.com/cr1gger/game-spy/blob/master/backend/controllers/ApiController.php): `backend/controllers/ApiController.php`
- [Category records](https://github.com/cr1gger/game-spy/blob/master/backend/models/Category.php): `backend/models/Category.php`
- [Word records](https://github.com/cr1gger/game-spy/blob/master/backend/models/Words.php): `backend/models/Words.php`

### Administration

- [Category admin](https://github.com/cr1gger/game-spy/blob/master/backend/controllers/CategoryController.php): `backend/controllers/CategoryController.php`
- [Word admin](https://github.com/cr1gger/game-spy/blob/master/backend/controllers/WordController.php): `backend/controllers/WordController.php`
- [Admin access base](https://github.com/cr1gger/game-spy/blob/master/backend/controllers/base/BaseAdminController.php): `backend/controllers/base/BaseAdminController.php`
- [Login form](https://github.com/cr1gger/game-spy/blob/master/backend/models/LoginForm.php): `backend/models/LoginForm.php`
- [User records](https://github.com/cr1gger/game-spy/blob/master/backend/models/User.php): `backend/models/User.php`
- [User creation](https://github.com/cr1gger/game-spy/blob/master/backend/services/UserService.php): `backend/services/UserService.php`
- [User command](https://github.com/cr1gger/game-spy/blob/master/backend/commands/UserController.php): `backend/commands/UserController.php`

### Other components

- **Players**

## Connections

- Players → Home view: opens
- Client bootstrap → App shell: mounts (evidence: `src/main.js`)
- Client bootstrap → Client router: registers (evidence: `src/main.js`)
- Client router → Home view: routes to (evidence: `src/router/index.js`)
- App shell → Offline data: loads data (evidence: `src/App.vue`)
- App shell → Local preferences: reads and writes (evidence: `src/App.vue`)
- Home view → Game view: renders (evidence: `src/views/HomeView.vue`)
- Game view → Round menu: renders (evidence: `src/components/MainGame.vue`)
- Game view → Player cards: renders (evidence: `src/components/MainGame.vue`)
- Game view → Round timer: renders (evidence: `src/components/MainGame.vue`)
- Game view → Game helpers: uses (evidence: `src/components/MainGame.vue`)
- Round menu → Offline data: loads words (evidence: `src/components/GameMenu.vue`)
- Round menu → Game helpers: selects word (evidence: `src/components/GameMenu.vue`)
- Round menu → Game settings: opens (evidence: `src/components/GameMenu.vue`)
- Round menu → Rules modal: opens (evidence: `src/components/GameMenu.vue`)
- Offline data → Local preferences: caches data (evidence: `src/use/local-db.js`)
- Offline data → Game data API: requests data
- Web entry → Web configuration: loads (evidence: `backend/web/index.php`)
- Game data API → Category records: queries (evidence: `backend/controllers/ApiController.php`)
- Game data API → Word records: queries (evidence: `backend/controllers/ApiController.php`)
- Category admin → Admin access base: extends (evidence: `backend/controllers/CategoryController.php`)
- Word admin → Admin access base: extends (evidence: `backend/controllers/WordController.php`)
- Category admin → Category records: manages (evidence: `backend/controllers/CategoryController.php`)
- Word admin → Category records: loads categories (evidence: `backend/controllers/WordController.php`)
- Word admin → Word records: manages (evidence: `backend/controllers/WordController.php`)
- Login form → User records: authenticates (evidence: `backend/models/LoginForm.php`)
- User command → User creation: creates user (evidence: `backend/commands/UserController.php`)
- User creation → User records: saves user (evidence: `backend/services/UserService.php`)
