flywheel

README

Flywheel

A 2D multiplayer game server written in Go.

Development

The project can be built and run with Docker Compose, or locally with Go.

Environment Variables

The server currently requires a Firebase project ID and API key to authenticate users. These can be set using the following environment variables:

FLYWHEEL_FIREBASE_PROJECT_ID="firebase-project-id"
FLYWHEEL_FIREBASE_API_KEY="firebase-api-key"

Docker Compose

Dependencies:

• Docker
• Docker Compose

Environment variables can be set in a .env file in the root directory. See .env.example for an example configuration.

Start the server with:

docker compose up

Pass the --build flag to rebuild the image.

To stop the server, run:

docker compose down

Pass the -v flag to remove volumes.

Local

Dependencies:

• Go

Start the server with a local SQLite database:

go run ./cmd/server/main.go -log-level debug

Client

Run a local client with:

go run ./cmd/client/main.go