Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Pull request overview
Updates the project documentation to reflect the new distributed/horizontally-scalable architecture (gateway + server-manager + game-server pods) and the updated repository/service layout, including revised local, Docker, and Kubernetes setup guidance.
Changes:
- Added architecture diagrams and detailed room-allocation / TLS port-mapping explanations.
- Updated repository structure to include
server-manager,scripts/,archRef/, and deployment configs. - Expanded “Getting Started” with server-manager + multi-game-server + gateway startup flow and k8s deployment notes.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -15,37 +15,109 @@ A real-time multiplayer platformer game built with HTML5 Canvas, Socket.IO, and | |||
| - **Spatial grid collision** — O(1) platform lookup for server-side physics | |||
| - **Particle system** — pooled, zero-allocation particle effects on the client | |||
| - **Configurable tick rate** — server tick rate is tunable via environment variable | |||
Comment on lines
+174
to
178
| | `SERVER_MANAGER_URL` | — | URL of the server-manager | | ||
| | `HOST_IP` | — | IP reported to server-manager (clients use this to connect) | | ||
| | `PORT_MIN` | `0` | Lower bound for random port selection | | ||
| | `PORT_MAX` | `0` | Upper bound (`0` = OS-assigned) | | ||
| | `TICK` | `120` | Game tick rate (Hz) | |
| │ ├── routes/ | ||
| │ │ ├── createRoom.ts # Allocates a room: queries server-manager, maps code→server | ||
| │ │ ├── addToRoom.ts # Adds a client to an existing room | ||
| │ │ └── removeFromRoom.ts # Removes a client from a room |
Comment on lines
+216
to
+220
| # Game server | ||
| cd server && docker build -t boxgame-server . && docker run -p 30000:30000 boxgame-server | ||
|
|
||
| # Set environment variables | ||
| export REDIS_URL=redis://localhost:6379 | ||
| export PORT=4000 | ||
| # Gateway | ||
| cd gateway && docker build -t boxgame-gateway . && docker run -p 3000:3000 boxgame-gateway |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
updated README to include architcture reference and changes in the repo structure.