187 lines
6.0 KiB
Markdown
187 lines
6.0 KiB
Markdown
# Guía de Trabajo - SnatchGame
|
|
|
|
## Instrucciones del Proyecto
|
|
Crear un juego multijugador para red local con:
|
|
- Servidor central usando Colyseus.io para estado compartido
|
|
- Cliente con Vue 3 + CSS + HTML vanilla
|
|
- Cliente usa Colyseus.js SDK
|
|
- Servidor y clientes en la misma red local
|
|
|
|
## Estructura del Proyecto
|
|
```
|
|
/server/ # Servidor Colyseus.io
|
|
/client/ # Cliente Vue 3 vanilla
|
|
```
|
|
|
|
## Stack Tecnológico
|
|
**Servidor:**
|
|
- Colyseus.io (framework de servidor)
|
|
- Node.js
|
|
- TypeScript
|
|
|
|
**Cliente:**
|
|
- Vue 3 (vanilla, sin build tools)
|
|
- HTML vanilla
|
|
- CSS vanilla
|
|
- Colyseus.js (SDK cliente)
|
|
- TypeScript
|
|
|
|
**UI Administración:**
|
|
- Vue 3 (vanilla, sin build tools)
|
|
- HTML vanilla
|
|
- CSS vanilla
|
|
- Colyseus.js (SDK cliente)
|
|
- TypeScript
|
|
|
|
## Convenciones de Código
|
|
**Lenguaje:**
|
|
- Código: Inglés
|
|
- UI/Diálogos: Español
|
|
- Comentarios: Inglés
|
|
|
|
**Naming Conventions:**
|
|
- Variables/Funciones: `thisIsAFunction`
|
|
- Clases: `ThisIsAClass`
|
|
- Constantes globales/env: `THIS_IS_A_GLOBAL_CONSTANT`
|
|
|
|
**TypeScript:**
|
|
- Tipado estricto en todos los componentes
|
|
- Tipos auto-generados desde servidor usando schema-codegen
|
|
- Homogeneidad de tipos entre los 3 componentes
|
|
|
|
## Arquitectura - Microservicios
|
|
|
|
### Desarrollo
|
|
```
|
|
/server/ # Servidor Colyseus.io + TypeScript (Puerto 2567)
|
|
/client/ # Cliente Vue 3 + Express server (Puerto 3000)
|
|
/admin/ # UI Admin Vue 3 + Express server (Puerto 3001)
|
|
```
|
|
|
|
### Producción (Docker + Nginx Proxy Manager)
|
|
```
|
|
snatchgame-server # Contenedor servidor Colyseus
|
|
snatchgame-client # Contenedor cliente Express
|
|
snatchgame-admin # Contenedor admin Express
|
|
nginx-proxy-manager # Proxy reverso y balanceador
|
|
```
|
|
|
|
**Enrutamiento Producción:**
|
|
- `/` → Cliente UI
|
|
- `/admin` → Admin UI
|
|
- `/server` → API Servidor Colyseus
|
|
|
|
## UI de Administración
|
|
**Funcionalidades:**
|
|
- Estadísticas en tiempo real de partidas activas
|
|
- Leaderboard global
|
|
- Monitor de estado de jugadores
|
|
- Panel de debugging para IT profesional
|
|
- Transparencia total del estado del servidor
|
|
|
|
**Usuarios objetivo:**
|
|
- Admin no-técnico: Vista simple de estadísticas
|
|
- IT profesional: Vista detallada de debugging
|
|
|
|
## Comandos Importantes
|
|
|
|
### Desarrollo
|
|
- **Servidor**: `cd server && npm run dev` (Puerto 2567)
|
|
- **Cliente**: `cd client && npm run dev` (Puerto 3000)
|
|
- **Admin**: `cd admin && npm run dev` (Puerto 3001)
|
|
|
|
### Generación de Tipos TypeScript
|
|
- **Manual**: `cd server && npx schema-codegen src/rooms/GameRoom.ts --ts --output ../client/src/types/`
|
|
- **Automático (cliente)**: `cd client && npm run generate-types`
|
|
- **Automático (admin)**: `cd admin && npm run generate-types`
|
|
|
|
### Testing y Debugging
|
|
- **Verificar puertos libres**: `lsof -i :2567,3000,3001`
|
|
- **Cerrar procesos**: `pkill -f "ts-node-dev" && pkill -f "vite" && pkill -f "node.*server"`
|
|
- **Cerrar procesos específicos**: `kill <PID>` (usar PID del proceso)
|
|
|
|
**IMPORTANTE:**
|
|
- ⚠️ **Siempre cerrar servicios** después de testing/debugging
|
|
- ⚠️ **Si servicios no arrancan** probablemente el usuario los levantó manualmente
|
|
- ⚠️ **Verificar puertos** antes de iniciar servicios para evitar conflictos
|
|
|
|
### Producción
|
|
- **Build Server**: `cd server && npm run build`
|
|
- **Start Server**: `cd server && npm run start`
|
|
- **Start Client**: `cd client && npm run start`
|
|
- **Start Admin**: `cd admin && npm run start`
|
|
|
|
### Docker (Producción)
|
|
- **Build**: `docker-compose build`
|
|
- **Start**: `docker-compose up -d`
|
|
- **Stop**: `docker-compose down`
|
|
- **Logs**: `docker-compose logs -f [service]`
|
|
|
|
### Variables de Entorno
|
|
- Desarrollo: `.env.development`
|
|
- Producción: `.env.production`
|
|
|
|
### VSCode Tasks
|
|
- **Ctrl+Shift+P** → `Tasks: Run Task`
|
|
- **Start Server** - Ejecutar solo servidor Colyseus
|
|
- **Start Client** - Ejecutar solo cliente UI
|
|
- **Start Admin** - Ejecutar solo admin UI
|
|
- **Start All Services** - Ejecutar todos los servicios paralelo
|
|
- **Install All Dependencies** - Instalar deps de todos
|
|
- **Build Server** - Compilar servidor TypeScript
|
|
|
|
## Gestión de Tipos TypeScript
|
|
|
|
### Schema-Codegen (Colyseus)
|
|
**Funcionalidad:**
|
|
- Genera automáticamente tipos TypeScript desde Schema classes del servidor
|
|
- Solo funciona para clases que extienden `Schema` con decoradores `@type`
|
|
- Mantiene sincronización perfecta entre servidor y cliente
|
|
- Es la práctica oficial recomendada por Colyseus
|
|
|
|
**Comandos:**
|
|
```bash
|
|
# Desde directorio server
|
|
npx schema-codegen src/rooms/GameRoom.ts --ts --output ../client/src/types/
|
|
|
|
# Desde directorio client (npm script configurado)
|
|
npm run generate-types
|
|
```
|
|
|
|
**Archivos generados:**
|
|
```
|
|
client/src/types/
|
|
├── Player.ts # Auto-generado desde server/src/rooms/GameRoom.ts
|
|
├── GameState.ts # Auto-generado desde server/src/rooms/GameRoom.ts
|
|
└── index.ts # Re-exports + tipos auxiliares manuales
|
|
```
|
|
|
|
### Tipos No-Schema (Manuales)
|
|
**Importante:** Los tipos que NO son Schema classes deben copiarse manualmente:
|
|
|
|
**Ejemplos de tipos manuales:**
|
|
- `GameRoomOptions` (interfaces para opciones)
|
|
- `export interface` (interfaces auxiliares)
|
|
- `export type` (type aliases)
|
|
- Enums, constantes, utilidades
|
|
|
|
**Ubicación:**
|
|
- **Server**: `server/src/rooms/GameRoom.ts` (junto a Schema classes)
|
|
- **Cliente**: `client/src/types/index.ts` (copiados manualmente)
|
|
- **Admin**: `admin/src/types/index.ts` (copiados manualmente)
|
|
|
|
**Flujo de trabajo:**
|
|
1. **Schema classes**: Se auto-generan con schema-codegen
|
|
2. **Tipos auxiliares**: Se copian manualmente cuando se añaden/modifican
|
|
3. **Consistencia**: Usar nombres idénticos entre server y client
|
|
|
|
## Notas Específicas
|
|
- **Offline**: Sin dependencias externas de internet
|
|
- **Microservicios**: Arquitectura separada por responsabilidades
|
|
- **Red Local**: Funciona completamente en LAN
|
|
- **Monorepo**: Un repositorio para todos los servicios
|
|
- **Docker**: Orquestación con docker-compose en producción
|
|
- **Nginx Proxy Manager**: Enrutamiento y balanceo de carga
|
|
- **Variables de Entorno**: Configuración por ambiente (.env)
|
|
- **Logging**: Detallado para debugging profesional
|
|
- **Tipos TypeScript**: Auto-generación con schema-codegen + copiar tipos auxiliares manualmente |