# nguyentienvn/game_caro architecture

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

- Interactive diagram: https://gitdiagram.com/nguyentienvn/game_caro
- Repository: https://github.com/nguyentienvn/game_caro

## Overview

Caro Realtime is a browser-based multiplayer Caro game using Express-rendered pages and Socket.IO events. Players log in, enter the lobby, create or join a room, and play moves that the server validates and broadcasts; chat, rematches, reconnects, and departures are also supported by the socket controller. Room and player state are held in in-memory models. The game-page client and room model were not excerpted, so their internal event handling and game-rule details are not mapped; documented or indexed links are used only where evidence supports them.

Main entry points: [`controllers/socketController.js`](https://github.com/nguyentienvn/game_caro/blob/main/controllers/socketController.js) (Socket Event Controller), [`server.js`](https://github.com/nguyentienvn/game_caro/blob/main/server.js) (HTTP and Socket Server), [`public/js/login.js`](https://github.com/nguyentienvn/game_caro/blob/main/public/js/login.js) (Login Client), [`routes/index.js`](https://github.com/nguyentienvn/game_caro/blob/main/routes/index.js) (Page Routes)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_web["Web experience"]
  node_server["HTTP and Socket Server<br/>[server.js]"]
  node_routes["Page Routes<br/>[index.js]"]
  node_pages["Login, Lobby, Game Views"]
  node_login["Login Client<br/>[login.js]"]
  node_lobby["Lobby Client<br/>[lobby.js]"]
  node_gamecontroller["Page Controller<br/>[gameController.js]"]
end

subgraph group_realtime["Realtime gameplay"]
  node_gameclient["Game Client<br/>[game.js]"]
  node_socket["Socket Event Controller"]
end

subgraph group_state["Runtime state"]
  node_roommodel["Room and Game State<br/>[RoomModel.js]"]
  node_playermodel["Player State<br/>[PlayerModel.js]"]
  node_helpers["Room ID Generator<br/>[helpers.js]"]
end

node_player(("Player"))
node_socketio{{"Socket.IO"}}

node_player -->|"enters username"| node_login
node_login -->|"emits login"| node_socketio
node_server -->|"mounts routes"| node_routes
node_routes -->|"dispatches pages"| node_gamecontroller
node_gamecontroller -.->|"renders pages"| node_pages
node_server -->|"registers handlers"| node_socket
node_server -->|"creates server"| node_socketio
node_login -->|"redirects to lobby"| node_pages
node_lobby -->|"emits room events"| node_socketio
node_socketio -->|"dispatches events"| node_socket
node_socket -->|"reads and updates"| node_playermodel
node_socket -->|"reads and updates"| node_roommodel
node_socket -->|"generates room IDs"| node_helpers
node_socket -->|"broadcasts updates"| node_socketio
node_gameclient -.->|"exchanges game events"| node_socketio
node_player -->|"browses rooms"| node_lobby

click node_server "https://github.com/nguyentienvn/game_caro/blob/main/server.js"
click node_routes "https://github.com/nguyentienvn/game_caro/blob/main/routes/index.js"
click node_pages "https://github.com/nguyentienvn/game_caro/tree/main/views"
click node_login "https://github.com/nguyentienvn/game_caro/blob/main/public/js/login.js"
click node_lobby "https://github.com/nguyentienvn/game_caro/blob/main/public/js/lobby.js"
click node_gameclient "https://github.com/nguyentienvn/game_caro/blob/main/public/js/game.js"
click node_gamecontroller "https://github.com/nguyentienvn/game_caro/blob/main/controllers/gameController.js"
click node_socket "https://github.com/nguyentienvn/game_caro/blob/main/controllers/socketController.js"
click node_roommodel "https://github.com/nguyentienvn/game_caro/blob/main/models/RoomModel.js"
click node_playermodel "https://github.com/nguyentienvn/game_caro/blob/main/models/PlayerModel.js"
click node_helpers "https://github.com/nguyentienvn/game_caro/blob/main/utils/helpers.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_server,node_routes,node_pages,node_login,node_lobby,node_gamecontroller toneBlue
class node_gameclient,node_socket toneAmber
class node_roommodel,node_playermodel,node_helpers toneMint
class node_player,node_socketio toneIndigo
```

## Components

### Web experience

- [HTTP and Socket Server](https://github.com/nguyentienvn/game_caro/blob/main/server.js): `server.js`
- [Page Routes](https://github.com/nguyentienvn/game_caro/blob/main/routes/index.js): `routes/index.js`
- [Login, Lobby, Game Views](https://github.com/nguyentienvn/game_caro/tree/main/views): `views`
- [Login Client](https://github.com/nguyentienvn/game_caro/blob/main/public/js/login.js): `public/js/login.js`
- [Lobby Client](https://github.com/nguyentienvn/game_caro/blob/main/public/js/lobby.js): `public/js/lobby.js`
- [Page Controller](https://github.com/nguyentienvn/game_caro/blob/main/controllers/gameController.js): `controllers/gameController.js`

### Realtime gameplay

- [Game Client](https://github.com/nguyentienvn/game_caro/blob/main/public/js/game.js): `public/js/game.js`
- [Socket Event Controller](https://github.com/nguyentienvn/game_caro/blob/main/controllers/socketController.js): `controllers/socketController.js`

### Runtime state

- [Room and Game State](https://github.com/nguyentienvn/game_caro/blob/main/models/RoomModel.js): `models/RoomModel.js`
- [Player State](https://github.com/nguyentienvn/game_caro/blob/main/models/PlayerModel.js): `models/PlayerModel.js`
- [Room ID Generator](https://github.com/nguyentienvn/game_caro/blob/main/utils/helpers.js): `utils/helpers.js`

### Other components

- **Player**
- **Socket.IO**

## Connections

- Player → Login Client: enters username (evidence: `public/js/login.js`)
- Login Client → Socket.IO: emits login (evidence: `public/js/login.js`)
- HTTP and Socket Server → Page Routes: mounts routes (evidence: `server.js`)
- Page Routes → Page Controller: dispatches pages (evidence: `routes/index.js`)
- Page Controller → Login, Lobby, Game Views: renders pages
- HTTP and Socket Server → Socket Event Controller: registers handlers (evidence: `server.js`)
- HTTP and Socket Server → Socket.IO: creates server (evidence: `server.js`)
- Login Client → Login, Lobby, Game Views: redirects to lobby (evidence: `public/js/login.js`)
- Lobby Client → Socket.IO: emits room events (evidence: `public/js/lobby.js`)
- Socket.IO → Socket Event Controller: dispatches events (evidence: `controllers/socketController.js`)
- Socket Event Controller → Player State: reads and updates (evidence: `controllers/socketController.js`)
- Socket Event Controller → Room and Game State: reads and updates (evidence: `controllers/socketController.js`)
- Socket Event Controller → Room ID Generator: generates room IDs (evidence: `controllers/socketController.js`)
- Socket Event Controller → Socket.IO: broadcasts updates (evidence: `controllers/socketController.js`)
- Game Client → Socket.IO: exchanges game events
- Player → Lobby Client: browses rooms (evidence: `public/js/lobby.js`)
