josedario87
a28bc286a1
- Add real-time multiplayer game server with Colyseus - Implement unique player naming system with auto-increment - Create lobby system with automatic matchmaking - Build 10-minute competitive clicking game rooms (max 2 players) - Add admin dashboard for game management (pause/resume/restart/kick) - Implement Vue 3 client with professional UI - Add WebSocket communication with state synchronization - Include TypeScript throughout with proper typing - Create REST API for admin operations - Add reconnection support and error handling
2.3 KiB
2.3 KiB
Quick Start Guide
🚀 Running the Project
The project is now ready to run! Both server and client are configured and running.
Current Status:
- ✅ Server: Running on http://localhost:3000
- ✅ Client: Running on http://localhost:5173
- ✅ WebSocket: ws://localhost:3000
- ✅ Admin Monitor: http://localhost:3000/colyseus
- ✅ Admin Dashboard: http://localhost:5173/dashboard
📝 How to Use
For Players:
- Open http://localhost:5173 in your browser
- Enter your desired username
- Click "Quick Play" to join a game
- Click as fast as you can when the game starts!
- Games last 10 minutes, winner is the one with most clicks
For Admins:
- Open http://localhost:5173/dashboard to access the admin panel
- Monitor all active games and players
- Control games: pause, resume, restart, or kick players
- View real-time statistics
🛠️ Development Commands
If you need to restart the services:
# Kill existing processes
pkill -f "ts-node"
pkill -f "vite"
# Start server (from server directory)
cd server
npx ts-node src/index.ts
# Start client (from client directory - in another terminal)
cd client
npm run dev
🎮 Game Flow
- Lobby: Players join and set their names
- Matchmaking: Automatic pairing when 2 players are ready
- Battle: 10-minute clicking competition
- Results: Winner announced, new game starts automatically
📊 Monitoring
- Colyseus Monitor: http://localhost:3000/colyseus - Built-in room monitoring
- Admin Dashboard: http://localhost:5173/dashboard - Custom admin interface
- API Health: http://localhost:3000/health - Server health check
🔍 Troubleshooting
If you encounter issues:
- Check server is running:
curl http://localhost:3000/health - Check client is accessible: Open http://localhost:5173
- Check console for WebSocket connection errors
- Ensure ports 3000 and 5173 are not in use by other applications
🎯 Next Steps
The MVP is complete with:
- ✅ Real-time multiplayer gameplay
- ✅ Automatic matchmaking
- ✅ Unique player naming system
- ✅ Admin controls
- ✅ Professional UI with animations
- ✅ WebSocket communication
- ✅ TypeScript throughout
You can now:
- Test the game with multiple browser tabs
- Customize the UI styles
- Add sound effects
- Implement additional game modes
- Deploy to production