feat: Sample matchmaker and gameclient by lwaddicor · Pull Request #15 · Unity-Technologies/multiplay-examples

lwaddicor · 2022-01-17T09:58:28Z

This adds a simple matchmaker and a simple game client example.
It is designed to get a simple end to end running and not as an example of a production matchmaker. For this the unity matchmaker is recommended

simple-game-client/go.sum

eth0net · 2022-01-17T10:41:03Z

simple-game-client/README.md

+
+This is a very simple game client, designed to be used with the simple-matchmaker.
+
+This app is designed to provide the simplest complete example of using the Multiplay. It uses a very simple matchmaker


Suggested change

This app is designed to provide the simplest complete example of using the Multiplay. It uses a very simple matchmaker

This app is designed to provide the simplest complete example of using the [Unity Multiplay platform](https://unity.com/products/multiplay). It uses [simple matchmaker](../simple-matchmaker)

lwaddicor · 2022-01-17T12:18:57Z

simple-matchmaker/assets/help_en.txt

+or may temporarily set this for your terminal session as shown below.
+
+Windows Example:
+set MP_ACCESS_KEY=9ff2af788834439b83ae6692f34ea5e5


These are randomly generated

kaschula · 2022-01-17T13:46:09Z

simple-matchmaker/main.go

+	}
+
+	cfg.MatchSize = *matchSize
+	mm := simplematchmaker.NewSimpleMatchmaker(cfg, backendClient)


backendClient is potentially nil here as I only see backendClient being set in one of the if else branches.

eth0net · 2022-01-17T14:27:56Z

simple-game-client/main.go

+)
+
+var (
+	//go:embed assets/help_en.txt


I like the use of go embed 😃

lwaddicor · 2022-01-17T16:56:32Z

Test evidence

This may need a few more cycles to really nail down. Just a sample of the matchmaker and client running against the linux dev fleet which appears to be running a http server.

Game Client 1:

Starting to find a match
Asking matchmaker about match for us (playerid: c9a6b8ff-5665-403c-9382-ba6ddf273165)
Matchmaker did not have a match ready
Asking matchmaker about match for us (playerid: c9a6b8ff-5665-403c-9382-ba6ddf273165)
Matchmaker did not have a match ready
Asking matchmaker about match for us (playerid: c9a6b8ff-5665-403c-9382-ba6ddf273165)
Matchmaker did not have a match ready
Asking matchmaker about match for us (playerid: c9a6b8ff-5665-403c-9382-ba6ddf273165)
Matchmaker found us a match
Connecting to match:
 - Allocation UUID: 03bc0ac3-0a46-4cf0-803e-2d89a3dce4f9:37315
 - Address: 109.169.15.15:37315
 - Other players:
 - - 4554326e-ca56-4f7c-9088-6cfecd96ede4 - 127.0.0.1:50998
 - - c9a6b8ff-5665-403c-9382-ba6ddf273165 - 127.0.0.1:51008
HTTP/1.1 400 Bad Request
Content-Type: text/plain; charset=utf-8
Connection: close

400 Bad Request

Starting to find a match
Asking matchmaker about match for us (playerid: 4554326e-ca56-4f7c-9088-6cfecd96ede4)
Matchmaker did not have a match ready
Asking matchmaker about match for us (playerid: 4554326e-ca56-4f7c-9088-6cfecd96ede4)
Matchmaker did not have a match ready
Asking matchmaker about match for us (playerid: 4554326e-ca56-4f7c-9088-6cfecd96ede4)
Matchmaker did not have a match ready
Asking matchmaker about match for us (playerid: 4554326e-ca56-4f7c-9088-6cfecd96ede4)
Matchmaker did not have a match ready
Asking matchmaker about match for us (playerid: 4554326e-ca56-4f7c-9088-6cfecd96ede4)
Matchmaker did not have a match ready
Asking matchmaker about match for us (playerid: 4554326e-ca56-4f7c-9088-6cfecd96ede4)
Matchmaker found us a match
Connecting to match:
 - Allocation UUID: 03bc0ac3-0a46-4cf0-803e-2d89a3dce4f9:37315
 - Address: 109.169.15.15:37315
 - Other players:
 - - 4554326e-ca56-4f7c-9088-6cfecd96ede4 - 127.0.0.1:50998
 - - c9a6b8ff-5665-403c-9382-ba6ddf273165 - 127.0.0.1:51008
HTTP/1.1 400 Bad Request
Content-Type: text/plain; charset=utf-8
Connection: close

400 Bad Request

The current output from the matchmaker, which

Players waiting: 0, Match size needed: 2
Players waiting: 0, Match size needed: 2
Players waiting: 0, Match size needed: 2
Players waiting: 0, Match size needed: 2
Players waiting: 0, Match size needed: 2
Handle player
Adding new unmatched player
Players waiting: 1, Match size needed: 2
Handle player
Player 4554326e-ca56-4f7c-9088-6cfecd96ede4 asked about match status, but it was not ready.
Player searching: 4554326e-ca56-4f7c-9088-6cfecd96ede4
Players waiting: 1, Match size needed: 2
Handle player
Player 4554326e-ca56-4f7c-9088-6cfecd96ede4 asked about match status, but it was not ready.
Player searching: 4554326e-ca56-4f7c-9088-6cfecd96ede4
Players waiting: 1, Match size needed: 2
Handle player
Adding new unmatched player
Handle player
Player 4554326e-ca56-4f7c-9088-6cfecd96ede4 asked about match status, but it was not ready.
Player searching: 4554326e-ca56-4f7c-9088-6cfecd96ede4
Players waiting: 2, Match size needed: 2
About to allocate for match
Handle player
Adding new unmatched player
Adding new unmatched player
Players waiting: 0, Match size needed: 2
Handle player
Adding new unmatched player
Got allocation: 109.169.15.15:37315

milonoir · 2022-01-17T17:06:51Z

simple-game-client/README.md

+- Simple-game-client app starts
+- Creates a Player UUID unique for the game client run.
+- Repeatedly call the simple-matchmaker `/player` endpoint with the player UUID
+- Eventually the endpoint will return an IP and Port to connecto


Suggested change

- Eventually the endpoint will return an IP and Port to connecto

- Eventually, the endpoint will return an IP and Port to connect to

milonoir · 2022-01-17T17:17:36Z

simple-matchmaker/internal/client/client.go

+	authService = "cf"
+	authRegion  = "eu-west-1"


Are these used anywhere? I feel unused AWS4 auth vibes. :)

milonoir · 2022-01-17T17:20:10Z

simple-matchmaker/internal/simplematchmaker/simplematchmaker.go

+// setAllocationMatchInfo associates an allocation with a match.
+func (m *SimpleMatchmaker) setAllocationMatchInfo(allocationUUID string, matchInfo matchmaker.MatchInfo) {
+	m.matchesMtx.Lock()
+	m.matchesMtx.Unlock()


missing defer?

Suggested change

m.matchesMtx.Unlock()

defer m.matchesMtx.Unlock()

milonoir · 2022-01-17T17:25:58Z

simple-matchmaker/internal/simplematchmaker/tcpmirror/tcpmirror.go

+	return nil
+}
+
+// handleConnection reflects and lines sent to it.


typo?

Suggested change

// handleConnection reflects and lines sent to it.

// handleConnection reflects any lines sent to it.

danmrichards

Very cool, Lewis!

Just a few nitpicks and tidy ups before we make this public

danmrichards · 2022-01-17T17:28:30Z

simple-game-client/main.go

+	}
+
+	fmt.Printf("Connecting to match:\n")
+	fmt.Printf(" - Allocation UUID: %s:%d\n", matchInfo.AllocationUUID)


Too many format verbs there

Suggested change

fmt.Printf(" - Allocation UUID: %s:%d\n", matchInfo.AllocationUUID)

fmt.Printf(" - Allocation UUID: %s\n", matchInfo.AllocationUUID)

danmrichards · 2022-01-17T17:29:24Z

simple-game-client/main.go

+		fmt.Printf(" - - %s - %s\n", pl.PlayerUUID, pl.IP)
+	}
+
+	tcpAddr, err := net.ResolveTCPAddr("tcp4", fmt.Sprintf("%s:%d", matchInfo.IP, matchInfo.Port))


Nitpick, worth using net.JoinHostPort instead for future support of IPv6?

danmrichards · 2022-01-17T17:33:28Z

simple-matchmaker/internal/client/allocations.go

+
+var (
+	// AllocationNotFound is returned when an allocation is not found.
+	AllocationNotFound = errors.New("allocation not found")


Nitpick; sentinel errors like this should be named in the pattern ErrXXXX

Suggested change

AllocationNotFound = errors.New("allocation not found")

ErrAllocationNotFound = errors.New("allocation not found")

danmrichards · 2022-01-17T17:33:58Z

simple-matchmaker/internal/client/client.go

+const (
+	authService = "cf"
+	authRegion  = "eu-west-1"
+)


These appear to be unused

danmrichards · 2022-01-17T17:36:54Z

simple-matchmaker/main.go

+	//"github.com/caarlos0/env"
+	//"github.com/google/uuid"
+	//"github.com/gorilla/mux"
+	//"github.com/lwaddicor/hackweekmatchmaker/mpclient"


Don't need these any more I assume?

eth0net · 2022-01-18T08:29:05Z

simple-game-client/main.go

+			}
+			content, err := ioutil.ReadAll(conn)
+			if err != nil && !os.IsTimeout(err) {
+				fmt.Printf("could not send to server: giving up: %s\n", err.Error())


Shouldn't this be receive from server?

eth0net · 2022-01-18T08:32:30Z

simple-matchmaker/assets/help_en.txt

+To use multiplay, most games need a matchmaker which groups players.
+For the most streamlined experience we recommend that you use the unity matchmaker to do this, but you may use an


Suggested change

To use multiplay, most games need a matchmaker which groups players.

For the most streamlined experience we recommend that you use the unity matchmaker to do this, but you may use an

To use Multiplay, most games need a matchmaker which groups players.

For the most streamlined experience we recommend that you use the Unity Matchmaker to do this, but you may use an

Should probably capitalise company and product names

eth0net · 2022-01-18T08:33:07Z

simple-matchmaker/assets/help_en.txt

+alternative or your own custom implementation.
+
+This sample provides an incredibly simple matchmaker to get you started locally. It will group incoming players
+together and when enough have joined it will request a match from either its multiplay mock, or the real multiplay API.


Suggested change

together and when enough have joined it will request a match from either its multiplay mock, or the real multiplay API.

together and when enough have joined it will request a match from either its Multiplay mock, or the real Multiplay API.

Same as above

eth0net · 2022-01-18T08:34:41Z

simple-matchmaker/assets/help_en.txt

+set MP_ACCESS_KEY=9ff2af788834439b83ae6692f34ea5e5
+set MP_SECRET_KEY=6323354e200a451dba319bc1b98ade59
+
+For example on UNIX Style OS (OSX, Linux, BSD):


Suggested change

For example on UNIX Style OS (OSX, Linux, BSD):

For example on UNIX Style OS (macOS, Linux, BSD):

OS X became macOS a few years ago

eth0net · 2022-01-18T08:35:51Z

simple-matchmaker/internal/client/README.md

+This is a temporary package which provides multiplay API calls. This is a temporary package until the official
+multiplay SDK library becomes available.


Suggested change

This is a temporary package which provides multiplay API calls. This is a temporary package until the official

multiplay SDK library becomes available.

This is a temporary package which provides Multiplay API calls. This is a temporary package until the official

Multiplay SDK library becomes available.

Product name

eth0net · 2022-01-18T08:42:55Z

simple-matchmaker/internal/client/client.go

+	}
+
+	if cfg.SecretKey == "" {
+		return nil, fmt.Errorf("access key is empty")


Suggested change

return nil, fmt.Errorf("access key is empty")

return nil, fmt.Errorf("secret key is empty")

eth0net · 2022-01-18T08:46:26Z

simple-matchmaker/internal/client/harness_test.go

+	fmt.Println("Fleet: ", cfg.FleetID)
+	fmt.Println("RegionID: ", cfg.RegionID)
+	fmt.Println("BuildConfig(Profile): ", cfg.BuildConfig)
+	fmt.Println("UUID: ", allocUUID)


Suggested change

fmt.Println("Fleet: ", cfg.FleetID)

fmt.Println("RegionID: ", cfg.RegionID)

fmt.Println("BuildConfig(Profile): ", cfg.BuildConfig)

fmt.Println("UUID: ", allocUUID)

fmt.Println("FleetID: ", cfg.FleetID)

fmt.Println("RegionID: ", cfg.RegionID)

fmt.Println("BuildConfigID(ProfileID): ", cfg.BuildConfig)

fmt.Println("UUID: ", allocUUID)

These are all IDs, so I'd suggest keeping the names aligned

Suggested change

fmt.Println("Fleet: ", cfg.FleetID)

fmt.Println("RegionID: ", cfg.RegionID)

fmt.Println("BuildConfig(Profile): ", cfg.BuildConfig)

fmt.Println("UUID: ", allocUUID)

fmt.Println("Fleet: ", cfg.FleetID)

fmt.Println("Region: ", cfg.RegionID)

fmt.Println("BuildConfig(Profile): ", cfg.BuildConfig)

fmt.Println("Allocation: ", allocUUID)

Alternatively, drop the ID suffix

eth0net · 2022-01-18T09:02:13Z

simple-matchmaker/internal/simplematchmaker/simplematchmaker.go

+			continue
+		}
+
+		// Spawn a goroutine to wait for this allocation to be processed be multiplay.


Suggested change

// Spawn a goroutine to wait for this allocation to be processed be multiplay.

// Spawn a goroutine to wait for this allocation to be processed by multiplay.

lwaddicor added 2 commits January 17, 2022 09:56

feat: Simple matchmaker and Simple game server

416a869

go mod tidy

93d20f7

lwaddicor requested a review from a team as a code owner January 17, 2022 09:58

lwaddicor commented Jan 17, 2022

View reviewed changes

simple-game-client/go.sum Outdated Show resolved Hide resolved

eth0net reviewed Jan 17, 2022

View reviewed changes

lwaddicor commented Jan 17, 2022

View reviewed changes

kaschula reviewed Jan 17, 2022

View reviewed changes

eth0net reviewed Jan 17, 2022

View reviewed changes

simple-game-client/main.go

)

var (

//go:embed assets/help_en.txt

Copy link

Contributor

eth0net Jan 17, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the use of go embed 😃

Cleanup and fix a few things on requests

eab73e3

milonoir reviewed Jan 17, 2022

View reviewed changes

danmrichards suggested changes Jan 17, 2022

View reviewed changes

update licence for new dependencies

a8b6009

eth0net reviewed Jan 18, 2022

View reviewed changes


		This is a very simple game client, designed to be used with the simple-matchmaker.

		This app is designed to provide the simplest complete example of using the Multiplay. It uses a very simple matchmaker

	- Eventually the endpoint will return an IP and Port to connecto
	- Eventually, the endpoint will return an IP and Port to connect to

	// handleConnection reflects and lines sent to it.
	// handleConnection reflects any lines sent to it.

	fmt.Printf(" - Allocation UUID: %s:%d\n", matchInfo.AllocationUUID)
	fmt.Printf(" - Allocation UUID: %s\n", matchInfo.AllocationUUID)

	AllocationNotFound = errors.New("allocation not found")
	ErrAllocationNotFound = errors.New("allocation not found")

		To use multiplay, most games need a matchmaker which groups players.
		For the most streamlined experience we recommend that you use the unity matchmaker to do this, but you may use an

	together and when enough have joined it will request a match from either its multiplay mock, or the real multiplay API.
	together and when enough have joined it will request a match from either its Multiplay mock, or the real Multiplay API.

	For example on UNIX Style OS (OSX, Linux, BSD):
	For example on UNIX Style OS (macOS, Linux, BSD):

		This is a temporary package which provides multiplay API calls. This is a temporary package until the official
		multiplay SDK library becomes available. No newline at end of file

	return nil, fmt.Errorf("access key is empty")
	return nil, fmt.Errorf("secret key is empty")

	// Spawn a goroutine to wait for this allocation to be processed be multiplay.
	// Spawn a goroutine to wait for this allocation to be processed by multiplay.

Conversation

lwaddicor commented Jan 17, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

eth0net Jan 17, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lwaddicor commented Jan 17, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Test evidence

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

danmrichards left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

eth0net Jan 18, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

lwaddicor commented Jan 17, 2022 •

edited

Loading

eth0net Jan 17, 2022 •

edited

Loading

lwaddicor commented Jan 17, 2022 •

edited

Loading

eth0net Jan 18, 2022 •

edited

Loading