README
¶
Game server
This server program is designed to host an online version of an immersive deduction board game.
Usage
Locally
# app welcome
go run main.go
# run the server
go run main.go serve --level=DEBUG --port=8080
# run the client
go run main.go client --host=127.0.0.1:8080
Docker
These commands have to be run from the root of the project
# build game-srv image
docker build -t game-srv:latest -f svc/game-srv/Dockerfile .
# run the image
docker run game-srv
Documentation
¶
Overview ¶
Copyright © 2024 Jigajoga, José Sousa e Tiago P. Quinteiro
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package client to test the server
|
Package client to test the server |
|
Package cmd holds all game-srv Cobra commands
|
Package cmd holds all game-srv Cobra commands |
|
pkg
|
|
|
kvstore
Package kvstore around Redis References: https://redis.io/docs/latest/develop/interact/pubsub/
|
Package kvstore around Redis References: https://redis.io/docs/latest/develop/interact/pubsub/ |
|
kvstore/examples
command
Package main contains examples for Redis
|
Package main contains examples for Redis |
|
party
Package party implements the logic to route clients into Rooms
|
Package party implements the logic to route clients into Rooms |
|
party/comms
Package comms for internal message passing
|
Package comms for internal message passing |
|
party/event
Package event contains incoming notifications for parties
|
Package event contains incoming notifications for parties |
|
party/notifier
Package notifier wraps how to notify router of queries
|
Package notifier wraps how to notify router of queries |
|
party/room
Package room contains the code to multicast between clients
|
Package room contains the code to multicast between clients |
|
remote
Package remote implements a multiplexer of clients.
|
Package remote implements a multiplexer of clients. |
|
Package srv is related to the Cobra cmd serve.
|
Package srv is related to the Cobra cmd serve. |
|
ws
Package ws is based on gorilla websockets.
|
Package ws is based on gorilla websockets. |
|
ws/client
Package client specific behavior for WS
|
Package client specific behavior for WS |