Files
caro/web-client/README.md
T
tiennm99 4bad51314d docs: comprehensive README with setup, architecture, and credits
- Full project README: quick start, game rules, project structure,
  server/client architecture diagrams, CLI/web options, protocol docs
- Web client README: setup, scripts, tech stack
- Credit to ainilili/ratel original project
2026-04-10 10:15:53 +07:00

838 B

Gomoku Web Client

Phaser 3 web client for the Gomoku game server.

Setup

npm install
npm run dev

Open http://localhost:5173 in your browser.

Requirements

  • Node.js 18+
  • Game server running on localhost:1024 (WebSocket on port 1025)

Server Connection

The client connects via WebSocket to ws://localhost:1025/ratel by default. To connect to a remote server, update the URL in src/services/connection-service.js.

Scripts

Command Description
npm run dev Start development server with HMR
npm run build Build for production (dist/)
npm run preview Preview production build locally

Tech Stack

  • Phaser 3 — HTML5 game engine
  • Vite — build tool
  • Vanilla JavaScript with JSDoc annotations