Skip to content

Commit 3038778

Browse files
committed
TOC for the SDK integration and tooling
I did this because I thought the local tooling wasn't getting noticed, so a TOC would help bring that to attention, and also make the documentation easier to navigate. Also found some semantic issues with header depth that I also fixed.
1 parent 8669cf4 commit 3038778

1 file changed

Lines changed: 26 additions & 4 deletions

File tree

sdks/README.md

Lines changed: 26 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,27 @@
11
# Agones Game Server Client SDKs
22

3+
4+
Table of Contents
5+
=================
6+
7+
* [Overview](#overview)
8+
* [Function Reference](#function-reference)
9+
* [Ready()](#ready)
10+
* [Health()](#health)
11+
* [Shutdown()](#shutdown)
12+
* [SetLabel(key, value)](#setlabelkey-value)
13+
* [SetAnnotation(key, value)](#setannotationkey-value)
14+
* [GameServer()](#gameserver)
15+
* [WatchGameServer(function(gameserver){...})](#watchgameserverfunctiongameserver)
16+
* [Local Development](#local-development)
17+
* [Providing your own GameServer configuration for local development](#providing-your-own-gameserver-configuration-for-local-development)
18+
* [Writing your own SDK](#writing-your-own-sdk)
19+
* [gRPC Client Generation](#grpc-client-generation)
20+
* [REST API Implementation](#rest-api-implementation)
21+
* [Building the Local Tools](#building-the-local-tools)
22+
23+
## Overview
24+
325
The SDKs are integration points for game servers with Agones itself.
426

527
They are required for a game server to work with Agones.
@@ -148,25 +170,25 @@ $ ./sdk-server.linux.amd64 --local -f ../../../examples/simple-udp/gameserver.ya
148170
{"level":"info","msg":"Starting SDKServer grpc-gateway...","source":"main","time":"2018-08-25T17:56:39-07:00"}
149171
```
150172

151-
### Writing your own SDK
173+
## Writing your own SDK
152174

153175
If there isn't a SDK for the language and platform you are looking for, you have several options:
154176

155-
#### gRPC Client Generation
177+
### gRPC Client Generation
156178

157179
If client generation is well supported by [gRPC](https://grpc.io/docs/), then generate a client from the
158180
[sdk.proto](../sdk.proto), and look at the current [sdks](.) to see how the wrappers are implemented to make interaction
159181
with the SDK server simpler for the user.
160182

161-
#### REST API Implementation
183+
### REST API Implementation
162184

163185
If client generation is not well supported by gRPC, or if there are other complicating factors, implement the SDK through
164186
the [REST](../docs/sdk_rest_api.md) HTTP+JSON interface. This could be written by hand, or potentially generated from
165187
the [Swagger/OpenAPI Spec](../sdk.swagger.json).
166188

167189
Finally, if you build something that would be usable by the community, please submit a pull request!
168190

169-
### Building the Local Tools
191+
## Building the Local Tools
170192

171193
If you wish to build the binaries for local development from source
172194
the `make` target `build-agones-sdk-binary` will compile the necessary binaries

0 commit comments

Comments
 (0)