BrowserQuest is a HTML5/JavaScript multiplayer game experiment.

This codebase has been updated to work with modern Node.js. See MODERNIZATION.md for details.

• Node.js 20+ (tested with v25.2.1)
• npm 9+

# Install dependencies
npm install

# Start server in background
./browserquest.sh start

# Check server status
./browserquest.sh status

# View logs
./browserquest.sh logs

# Stop server
./browserquest.sh stop

The server runs on http://localhost:8000

Run BrowserQuest in Docker:

# Using Docker Compose (recommended)
docker-compose up -d

# Using Docker CLI
docker build -t browserquest .
docker run -d -p 8000:8000 browserquest

See DOCKER.md for complete Docker documentation.

# Server management
npm start              # Run server (foreground)
npm run server:start   # Start server in background
npm run server:stop    # Stop background server
npm run server:status  # Show status and player counts
npm run server:logs    # View server logs

# Development
npm test              # Run tests
npm run lint          # Lint JavaScript files
npm run format        # Format code with Prettier

This project uses pre-commit hooks for code quality. Set them up with:

./setup-pre-commit.sh

See PRE_COMMIT_SETUP.md for details.

See MODERNIZATION.md for complete modernization details and roadmap.

• MODERNIZATION.md - Modernization guide and roadmap
• DOCKER.md - Docker setup and deployment
• CI_CD.md - GitHub Actions workflows
• PRE_COMMIT_SETUP.md - Code quality hooks
• MANAGEMENT_SCRIPT_README.md - Server management

Original documentation is located in client and server directories.

Code is licensed under MPL 2.0. Content is licensed under CC-BY-SA 3.0. See the LICENSE file for details.

Created by Little Workshop:

• Franck Lecollinet - @whatthefranck
• Guillaume Lecollinet - @glecollinet