README
¶
Open Match is an open source game matchmaking framework that simplifies building a scalable and extensible Matchmaker. It is designed to give the game developer full control over how to make matches while removing the burden of dealing with the challenges of running a production service at scale.
Please visit Open Match website for user documentation, demo instructions etc.
Contributing to Open Match
Open Match is in active development and we would love your contribution! Please read the contributing guide for guidelines on contributing to Open Match.
The Open Match Development guide has detailed instructions on getting the source code, making changes, testing and submitting a pull request to Open Match.
Disclaimer
This software is currently alpha, and subject to change.
Support
Code of Conduct
Participation in this project comes under the Contributor Covenant Code of Conduct
License
Apache 2.0
Documentation
¶
Overview ¶
Package openmatch provides flexible, extensible, and scalable video game matchmaking.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
backend
Package main is the backend service for Open Match.
|
Package main is the backend service for Open Match. |
|
frontend
Package main is the frontend service for Open Match.
|
Package main is the frontend service for Open Match. |
|
minimatch
Package main is the minimatch in-process testing binary for Open Match.
|
Package main is the minimatch in-process testing binary for Open Match. |
|
query
Package main is the query service for Open Match.
|
Package main is the query service for Open Match. |
|
swaggerui
Package main is a simple webserver for hosting Open Match Swagger UI.
|
Package main is a simple webserver for hosting Open Match Swagger UI. |
|
synchronizer
Package main is the synchronizer service for Open Match.
|
Package main is the synchronizer service for Open Match. |
|
examples
|
|
|
demo
Package demo contains the core startup code for running a demo.
|
Package demo contains the core startup code for running a demo. |
|
demo/bytesub
Package bytesub provides the ability for many clients to subscribe to the latest value of a byte array.
|
Package bytesub provides the ability for many clients to subscribe to the latest value of a byte array. |
|
demo/updater
Package updater provides the ability for concurrently running demo pieces to update a shared json object.
|
Package updater provides the ability for concurrently running demo pieces to update a shared json object. |
|
functions/golang/soloduel
Package main defines a sample match function that uses the GRPC harness to set up the match making function as a service.
|
Package main defines a sample match function that uses the GRPC harness to set up the match making function as a service. |
|
functions/golang/soloduel/mmf
Package mmf provides a sample match function that uses the GRPC harness to set up 1v1 matches.
|
Package mmf provides a sample match function that uses the GRPC harness to set up 1v1 matches. |
|
internal
|
|
|
app
Package app contains the common application initialization code for Open Match servers.
|
Package app contains the common application initialization code for Open Match servers. |
|
app/minimatch
Package minimatch is an merger of all the Open Match services in a single binary.
|
Package minimatch is an merger of all the Open Match services in a single binary. |
|
app/swaggerui
Package swaggerui is a simple webserver for hosting Open Match Swagger UI.
|
Package swaggerui is a simple webserver for hosting Open Match Swagger UI. |
|
config
Package config contains convenience functions for reading and managing viper configs.
|
Package config contains convenience functions for reading and managing viper configs. |
|
logging
Package logging configures the Logrus logging library.
|
Package logging configures the Logrus logging library. |
|
set
Package set provides helper methods for handling sets.
|
Package set provides helper methods for handling sets. |
|
signal
Package signal handles terminating applications on Ctrl+Break.
|
Package signal handles terminating applications on Ctrl+Break. |
|
testing
Package testing provides testing primitives for the codebase.
|
Package testing provides testing primitives for the codebase. |
|
testing/evaluator
Package evaluator provides the Evaluator service for Open Match golang harness.
|
Package evaluator provides the Evaluator service for Open Match golang harness. |
|
testing/mmf
Package mmf provides the Match Making Function service for Open Match golang harness.
|
Package mmf provides the Match Making Function service for Open Match golang harness. |
|
util
Package util provides utility structs and methods for Open Match.
|
Package util provides utility structs and methods for Open Match. |
|
util/testing
Package testing provides utility methods for testing.
|
Package testing provides utility methods for testing. |
|
pkg
|
|
|
matchfunction
Package matchfunction provides helper methods to simplify authoring a match fuction.
|
Package matchfunction provides helper methods to simplify authoring a match fuction. |
|
pb
Package pb is a reverse proxy.
|
Package pb is a reverse proxy. |
|
test
|
|
|
matchfunction
Package main a sample match function that uses the GRPC harness to set up the match making function as a service.
|
Package main a sample match function that uses the GRPC harness to set up the match making function as a service. |
|
matchfunction/mmf
Package mmf provides a sample match function that uses the GRPC harness to set up the match making function as a service.
|
Package mmf provides a sample match function that uses the GRPC harness to set up the match making function as a service. |
|
tools
|
|
|
certgen
Package main is the certgen tool which generates public-certificate/private-key for Open Match to run in TLS mode.
|
Package main is the certgen tool which generates public-certificate/private-key for Open Match to run in TLS mode. |
|
certgen/internal
Package internal holds the internal details of creating a self-signed certificate from either a Root CA or individual cert.
|
Package internal holds the internal details of creating a self-signed certificate from either a Root CA or individual cert. |
|
certgen/testing
Package testing provides easy to use methods for creating certificates using a Root CA or individual.
|
Package testing provides easy to use methods for creating certificates using a Root CA or individual. |
|
reaper
Package main is the main for the reaper tool to cleanup leaked clusters in Open Match CI.
|
Package main is the main for the reaper tool to cleanup leaked clusters in Open Match CI. |
|
reaper/internal
Package internal holds the internal workings for deleting orphaned GKE clusters from Continuous Integration.
|
Package internal holds the internal workings for deleting orphaned GKE clusters from Continuous Integration. |
Click to show internal directories.
Click to hide internal directories.