Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
castaneai committed Mar 5, 2024
1 parent dd9b016 commit e2195ed
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# minimatch
Minimal [Open Match](https://open-match.dev/) replacement for small development environment.

Minimal [Open Match](https://open-match.dev/) replacement.

🚧 **WIP: This project is incomplete and should not be used in production.**

Expand All @@ -8,12 +9,9 @@ Minimal [Open Match](https://open-match.dev/) replacement for small development
![](./overview.png)

[Open Match](https://open-match.dev/) is a good solution for scalable matchmaking, but its scalability complicates the architecture.
It is not essential for game developers to learn Kubernetes or distributed systems to develop matchmaking logic.

And complex architectures are not needed for local development and testing of logic. Sometimes you will want a small Open Match.
Most of us are game developers, not Kubernetes experts.

**minimatch** solves the above problem.
It runs in a single process; there are no dependencies other than Go!
**minimatch** runs in a single process. All you need to run it is Go!

## Features

Expand All @@ -25,15 +23,19 @@ It runs in a single process; there are no dependencies other than Go!

## Quickstart

minimatch consists of two parts: Backend and Frontend.
minimatch consists of two parts: **Frontend** and **Backend**.

Frontend is an API Server for creating tickets and checking matchmaking status.

Backend is a job to retrieve tickets and perform matchmaking.
You can pass the **MatchProfile**,
**MatchFunction** and **Assigner** to the minimatch backend.
**MatchFunction** and **Assigner** to the backend.

**MatchProfile** is the definition of matchmaking. It has pools for classifying tickets.
**MatchFunction** performs matchmaking based on Ticket for each fetched pool.
And **Assigner** assigns a GameServer info to the established matches.

After registering Backend, start the Frontend service as a gRPC server.
You can now use Open Match compatible services!
The following is a minimal code. See [examples/](./examples) for a more actual example.

```go
var matchProfile = &pb.MatchProfile{...}
Expand Down Expand Up @@ -61,8 +63,6 @@ func main() {
}
```

See [examples](./examples) for more concrete examples.

## Use case

### Testing matchmaking logic
Expand Down Expand Up @@ -113,7 +113,7 @@ See [Differences from Open Match](./docs/differences.md) for details.

## Scalability

Do you want scalability in spite of the mini?
Is minimatch really just a mini? No, it is not! Despite its name, minimatch has scalability.
Please see [Scalable minimatch](./docs/scalable.md).

## Metrics
Expand Down
Binary file modified overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit e2195ed

Please sign in to comment.