https://github.com/mortenson/grpc-game-example

A multiplayer terminal shooter written with Go, gRPC, and tview
https://github.com/mortenson/grpc-game-example

Last synced: about 1 month ago
JSON representation

A multiplayer terminal shooter written with Go, gRPC, and tview

• Host: GitHub
• URL: https://github.com/mortenson/grpc-game-example
• Owner: mortenson
• License: mit
• Created: 2020-04-02T04:24:05.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-05-17T15:32:27.000Z (over 4 years ago)
• Last Synced: 2024-06-20T06:28:39.711Z (6 months ago)
• Language: Go
• Homepage:
• Size: 171 KB
• Stars: 215
• Watchers: 5
• Forks: 28
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# grpc-game-example

An example game built using Go, gRPC, and tview.

The blog post for this project is a good reference: https://mortenson.coffee/blog/making-multiplayer-game-go-and-grpc

I built this as a way to learn more about Go and haven't been using the

language for that long so don't judge the code too harshly!

## Game description

This is “tshooter” - a local or online multiplayer shooting game you play

in your terminal. Players can move in a map and fire lasers at other players.

When a player is hit, they respawn on the map and the shooting player’s score

is increased. When a player reaches 10 kills, the round ends and a new round

begins. You can play the game offline with bots, or online with up to eight

players (but that limit is arbitrary).

## Reference and use

Here's a quick reference for common operations on the project:

```bash

# Download go module dependencies

go mod download

# Build binaries

make build

# Run a local, offline game

make run

# Run a server with defaults

make run-server

# Run a client

make run-client

# Run a bot as a client

make run-bot-client

# Rebuild protobuf

make proto

# Run gofmt

make fmt

```

If you run the commands or binaries directly more command line options are

available:

```bash

# Run a server

go run cmd/server.go -port=9999 -bots=2 -password=foo

# Run a local, offline game

go run cmd/client_local.go -bots=2

# Run a bot as a client

go run cmd/bot_client.go -address=":9999"

```

# Using binaries

Using `make`, binaries are output to the `bin` directory in the format

`tshooter_ARCH_COMMAND`. For ease of use, "launcher" binaries are also

generated which can be double clicked to open a terminal window.