https://github.com/cloudnativegame/kruise-game-open-match-director
Opensource cloudnative game matching service for openkruisegame.
https://github.com/cloudnativegame/kruise-game-open-match-director
go golang kubernetes matchmaking multiplayer okg openkruisegame
Last synced: 5 months ago
JSON representation
Opensource cloudnative game matching service for openkruisegame.
- Host: GitHub
- URL: https://github.com/cloudnativegame/kruise-game-open-match-director
- Owner: CloudNativeGame
- License: apache-2.0
- Created: 2023-06-16T02:48:56.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-06T14:49:54.000Z (almost 2 years ago)
- Last Synced: 2025-08-03T07:30:13.100Z (11 months ago)
- Topics: go, golang, kubernetes, matchmaking, multiplayer, okg, openkruisegame
- Language: Go
- Homepage:
- Size: 25.2 MB
- Stars: 21
- Watchers: 1
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## kruise-game-open-match-director
### Overview
**kruise-game-open-match-director** allocate appropriate game servers managed by OpenKruiseGame for players, which actually is a director component based on [open-match framework](https://open-match.dev/site/).
**kruise-game-open-match-director** is located between the Game Servers and the Backend of open-match. As shown in the figure, it will perceive the network information and running status of the game server in the cluster, and when a matching request comes, it will find a game server that meets the needs of the players and return the corresponding network access address.
### Parameter Description
```yaml
command:
- '/director'
- '--lease-lock-name=kruise-game-open-match-director'
- '--lease-lock-namespace=open-match-demo'
- '--match-function-endpoint=om-function.open-match-demo.svc.cluster.local'
- '--match-function-port=50502'
- '--gss-names=flappy-bird'
```
- gss-names
- The names of the GameServerSets that you want to put in pool.
- Usually each GameServerSet represents a game. If you want to make players get into different games, you can fill in multiple names, which are separated by ','. For example: football,basketball
- And you can create a ticket with `game_name` to choose which game the player should join in. The tickets would be like this:
```yaml
&pb.Ticket{
SearchFields: &pb.SearchFields{
StringArgs: map[string]string{
"game_name": "football", # the same as the gss name that is already register in one of the match pools. This player will join in football game.
},
},
}
&pb.Ticket{
SearchFields: &pb.SearchFields{
StringArgs: map[string]string{
"game_name": "basketball", # the same as the gss name that is already register in one of the match pools. This player will join in basketball game.
},
},
}
```
- you can also design different match functions for different games, and use the game_name to distinguish each one. Director will generate two MatchProfiles in this examples, which are:
```yaml
p := []*pb.MatchProfile{
{
Name: "football",
Pools: []*pb.Pool{
{
Name: "game_name",
StringEqualsFilters: []*pb.StringEqualsFilter{
{
StringArg: "game_name",
Value: "football",
},
},
},
},
},
{
Name: "basketball",
Pools: []*pb.Pool{
{
Name: "game_name",
StringEqualsFilters: []*pb.StringEqualsFilter{
{
StringArg: "game_name",
Value: "basketball",
},
},
},
},
},
}
```
- slave-clusters
- default: "", which means only host cluster exists.
- usage: Specify the slave cluster names, which are also the names of corresponding kubeconfig secrets. Format is "{cluster_1_secret_name},{cluster_2_secret_name},..."
If you want to make match between multi-clusters, you should deploy the secret with same cluster name before you set up director with the parameter. For example:
1. Deploy the secret
```yaml
cat <