Skip to content

Latest commit

 

History

History
44 lines (31 loc) · 2.53 KB

README.md

File metadata and controls

44 lines (31 loc) · 2.53 KB

Space Rings Thing Game Client (for Red Hat Gaming)

This repository is the Godot-based multiplayer client for the "Space Ring Things" game. You will need to already have the server repository and the server's prerequisites handled. The client also uses Protobufs for messaging, like the server, and makes use of Git submodules in order to pull in the Protobuf descriptions.

How Can I Play This Game

Everything in currently in development. To play you'll need to roll up your sleves and do a little bit of build/operations work. See the development notes below for instructions on how to do that.

Development Notes and Prerequisites

The game is currently being built with Linux and using Godot 3.4.4 with Mono.

This repo now uses submodules to point to the Networking/protobufs. Make sure to --recurse-submodules when you clone. If you've already cloned prior to this change, then run the following git submodule update --init.

Make sure that you are using the same commit/tag in both the client and server.

Networking Code Gen (Protobuf)

The protocol buffer definitions are generated automatically via CI/CD in thier own git repo. That code is linked via git submodule by this repo. However, if you do need to make local client-side only changes, you can manually gen the C# code with the following instructions:

You will need the dotnet command line tool (or equivalent) in order to do this.

Intstall the Protogen tooling:

dotnet tool install --global protobuf-net.Protogen --version 3.0.101

Then, in the proto folder:

protogen --csharp_out=. *.proto

Building the Client

TBD

Running Your Own Everything / Testing Locally

You will need to run the game server, the AMQ messaging server, and this game (client-side). We will eventually clean all this up to make it easier. For now there is a fair amount of manual work to be done. See below...

Server

Find/follow instructions for the game server here.

Client

This repo is the player game client.

If you are debugging the Godot server and Godot client on the same machine you will want to do one of the following:

  • Option 1. Goto Editor->Editor Settings... and search for the Remote Port setting (it's under `Network->Debug'). Change the port so that the client and server use different ports.
  • Option 2. In the Server project, goto Project->Export... and export to your platform, then run the exported server.