agones.dev/agones@v1.53.0/README.md (about)

     1  <img src="./docs/agones.png" alt="Agones logo" width="250px" height="250px" />
     2  
     3  [![go.dev reference](https://img.shields.io/badge/go.dev-reference-007d9c?logo=go&logoColor=white&style=flat-square)](https://pkg.go.dev/agones.dev/agones)
     4  [![GoDoc](https://godoc.org/agones.dev/agones?status.svg)](https://godoc.org/agones.dev/agones)
     5  [![Go Report Card](https://goreportcard.com/badge/github.com/googleforgames/agones)](https://goreportcard.com/report/github.com/googleforgames/agones)
     6  [![GitHub release](https://img.shields.io/github/release/googleforgames/agones.svg)](https://github.com/googleforgames/agones/releases)
     7  [![Follow on Twitter](https://img.shields.io/twitter/follow/agonesdev.svg?style=social&logo=twitter)](https://twitter.com/intent/follow?screen_name=agonesdev)
     8  
     9  Agones is a library for hosting, running and scaling [dedicated game servers](https://en.wikipedia.org/wiki/Game_server#Dedicated_server) on [Kubernetes](https://kubernetes.io).
    10  
    11  _Agones, is derived from the Greek word agōn which roughly translates to “contest”, “competition at games” and “gathering”.
    12  ([source](https://www.merriam-webster.com/dictionary/agones))_
    13  
    14  ## Why does this project exist?
    15  Agones replaces usual bespoke or proprietary cluster management and game server scaling solutions with a [Kubernetes](https://kubernetes.io/) cluster
    16  that includes the Agones custom _[Kubernetes Controller](https://kubernetes.io/docs/concepts/api-extension/custom-resources/#custom-controllers)_ and matching [Custom Resource Definitions](https://kubernetes.io/docs/concepts/api-extension/custom-resources/#customresourcedefinitions) for _GameServers_, _Fleets_ and more.
    17  
    18  With Agones, Kubernetes gets native abilities to create, run, manage and scale dedicated game server processes within Kubernetes clusters using standard Kubernetes tooling and APIs. This model also allows any matchmaker to interact directly with Agones via the Kubernetes API to provision a dedicated game server.
    19  
    20  For more details on why this project was written, read the
    21  [announcement blog post](https://cloudplatform.googleblog.com/2018/03/introducing-Agones-open-source-multiplayer-dedicated-game-server-hosting-built-on-Kubernetes.html).
    22  
    23  ## Major Features
    24  - Define a single `GameServer`, and/or large game server `Fleets` within Kubernetes - either through yaml or via the API
    25  - Manage GameServer lifecycles - including health checking and connection information.
    26  - `Fleet` Autoscaling capabilities that integrate with Kubernetes' native cluster autoscaling
    27  - Gameserver specific metric exports and dashboards for ops teams
    28  
    29  ## Usage
    30  
    31  Documentation can be found on the [Agones website](https://agones.dev/site/docs/).
    32  
    33  ## Get involved
    34  
    35  - [Slack](https://join.slack.com/t/agones/shared_invite/zt-2mg1j7ddw-0QYA9IAvFFRKw51ZBK6mkQ)
    36  - [Twitter](https://twitter.com/agonesdev)
    37  - [Mailing List](https://groups.google.com/forum/#!forum/agones-discuss)
    38  - [Community Meetings](https://www.youtube.com/playlist?list=PLhkWKwFGACw2dFpdmwxOyUCzlGP2-n7uF) (Join the mailing
    39    list for details)
    40  
    41  ## Code of Conduct
    42  
    43  Participation in this project comes under the [Contributor Covenant Code of Conduct](code-of-conduct.md)
    44  
    45  ## Reporting Security Issues
    46  
    47  To report a security issue for this project, please follow the instructions in
    48  the [Project Security Policy](.github/SECURITY.md)
    49  
    50  ## Development and Contribution
    51  
    52  Please read the [contributing](CONTRIBUTING.md) guide for directions on submitting Pull Requests to Agones, and community membership governance.
    53  
    54  See the [Developing, Testing and Building Agones](build/README.md) documentation for developing, testing and building Agones from source. For adding a new field to one of the Custom Resource Definitions refer to [Development Work on Agones Custom Resource Definitions (CRDs)](install/helm/agones/README.md).
    55  
    56  For Agones client SDK development refer to [Developing, Testing, and Building Agones Client SDKs](sdks/README.md).
    57  
    58  The [Release Process](docs/governance/release_process.md) documentation displays the project's upcoming release calendar and release process.
    59  
    60  Agones is in active development - we would love your help in shaping its future!
    61  
    62  ## This all sounds great, but can you explain Docker and/or Kubernetes to me?
    63  
    64  ### Docker
    65  - [Docker's official "Getting Started" guide](https://docs.docker.com/get-started/)
    66  
    67  ### Kubernetes
    68  - [You should totally read this comic, and interactive tutorial](https://cloud.google.com/kubernetes-engine/kubernetes-comic/)
    69  
    70  ## Licence
    71  
    72  Apache 2.0