Skip to content

Commit

Permalink
SDK Matrices for NodeJS, C#, CPP, REST (#3548)
Browse files Browse the repository at this point in the history 
* SDK Matrices for NodeJS, C#, CPP, REST

* review changes

* Review changes

* Rest has GetGameServer

* Player Tracking included in rest.md

* Location change
  • Loading branch information
@Kalaiselvi84
Kalaiselvi84 authored Dec 19, 2023
1 parent c7b8c0a commit e20368b
Show file tree
Hide file tree
Showing 4 changed files with 126 additions and 0 deletions.
28 changes: 28 additions & 0 deletions site/content/en/docs/Guides/Client SDKs/cpp.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,34 @@ description: "This is the C++ version of the Agones Game Server Client SDK. "

Check the [Client SDK Documentation]({{< relref "_index.md" >}}) for more details on each of the SDK functions and how to run the SDK locally.


## SDK Functionality

| Area | Action | Implemented |
|-----------------|---------------------|-------------|
| Lifecycle | Ready | ✔️ |
| Lifecycle | Health | ✔️ |
| Lifecycle | Reserve | ✔️ |
| Lifecycle | Allocate | ✔️ |
| Lifecycle | Shutdown | ✔️ |
| Configuration | GameServer | ✔️ |
| Configuration | WatchGameServer | ✔️ |
| Metadata | SetAnnotation | ✔️ |
| Metadata | SetLabel | ✔️ |
| Counters | GetCounterCount | ❌ |
| Counters | SetCounterCount | ❌ |
| Counters | IncrementCounter | ❌ |
| Counters | DecrementCounter | ❌ |
| Counters | SetCounterCapacity | ❌ |
| Counters | GetCounterCapacity | ❌ |
| Lists | AppendListValue | ❌ |
| Lists | DeleteListValue | ❌ |
| Lists | SetListCapacity | ❌ |
| Lists | GetListCapacity | ❌ |
| Lists | ListContains | ❌ |
| Lists | GetListLength | ❌ |
| Lists | GetListValues | ❌ |

## Download

Download the source from the [Releases Page](https://github.com/googleforgames/agones/releases)
Expand Down
35 changes: 35 additions & 0 deletions site/content/en/docs/Guides/Client SDKs/csharp.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,41 @@ publishDate: 2020-05-28

Check the [Client SDK Documentation]({{< relref "_index.md" >}}) for more details on each of the SDK functions and how to run the SDK locally.


## SDK Functionality

| Area | Action | Implemented |
|-----------------|---------------------|-------------|
| Lifecycle | Ready | ✔️ |
| Lifecycle | Health | ✔️ |
| Lifecycle | Reserve | ✔️ |
| Lifecycle | Allocate | ✔️ |
| Lifecycle | Shutdown | ✔️ |
| Configuration | GetGameServer | ✔️ |
| Configuration | WatchGameServer | ✔️ |
| Metadata | SetAnnotation | ✔️ |
| Metadata | SetLabel | ✔️ |
| Counters | GetCounterCount | ❌ |
| Counters | SetCounterCount | ❌ |
| Counters | IncrementCounter | ❌ |
| Counters | DecrementCounter | ❌ |
| Counters | SetCounterCapacity | ❌ |
| Counters | GetCounterCapacity | ❌ |
| Lists | AppendListValue | ❌ |
| Lists | DeleteListValue | ❌ |
| Lists | SetListCapacity | ❌ |
| Lists | GetListCapacity | ❌ |
| Lists | ListContains | ❌ |
| Lists | GetListLength | ❌ |
| Lists | GetListValues | ❌ |
| Player Tracking | GetConnectedPlayers | ✔️ |
| Player Tracking | GetPlayerCapacity | ✔️ |
| Player Tracking | GetPlayerCount | ✔️ |
| Player Tracking | IsPlayerConnected | ✔️ |
| Player Tracking | PlayerConnect | ✔️ |
| Player Tracking | PlayerDisconnect | ✔️ |
| Player Tracking | SetPlayerCapacity | ✔️ |

## Download

Download the source {{< ghlink href="sdks/csharp" >}}directly from GitHub{{< /ghlink >}}.
Expand Down
35 changes: 35 additions & 0 deletions site/content/en/docs/Guides/Client SDKs/nodejs.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,41 @@ description: "This is the Node.js version of the Agones Game Server Client SDK."

Check the [Client SDK Documentation]({{< relref "_index.md" >}}) for more details on each of the SDK functions and how to run the SDK locally.


## SDK Functionality

| Area | Action | Implemented |
|-----------------|---------------------|-------------|
| Lifecycle | Ready | ✔️ |
| Lifecycle | Health | ✔️ |
| Lifecycle | Reserve | ✔️ |
| Lifecycle | Allocate | ✔️ |
| Lifecycle | Shutdown | ✔️ |
| Configuration | GetGameServer | ✔️ |
| Configuration | WatchGameServer | ✔️ |
| Metadata | SetAnnotation | ✔️ |
| Metadata | SetLabel | ✔️ |
| Counters | GetCounterCount | ❌ |
| Counters | SetCounterCount | ❌ |
| Counters | IncrementCounter | ❌ |
| Counters | DecrementCounter | ❌ |
| Counters | SetCounterCapacity | ❌ |
| Counters | GetCounterCapacity | ❌ |
| Lists | AppendListValue | ❌ |
| Lists | DeleteListValue | ❌ |
| Lists | SetListCapacity | ❌ |
| Lists | GetListCapacity | ❌ |
| Lists | ListContains | ❌ |
| Lists | GetListLength | ❌ |
| Lists | GetListValues | ❌ |
| Player Tracking | GetConnectedPlayers | ✔️ |
| Player Tracking | GetPlayerCapacity | ✔️ |
| Player Tracking | GetPlayerCount | ✔️ |
| Player Tracking | IsPlayerConnected | ✔️ |
| Player Tracking | PlayerConnect | ✔️ |
| Player Tracking | PlayerDisconnect | ✔️ |
| Player Tracking | SetPlayerCapacity | ✔️ |

## Prerequisites

- Node.js >= 10.13.0
Expand Down
28 changes: 28 additions & 0 deletions site/content/en/docs/Guides/Client SDKs/rest.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,34 @@ description: "This is the REST version of the Agones Game Server Client SDK. "

Check the [Client SDK Documentation]({{< relref "_index.md" >}}) for more details on each of the SDK functions and how to run the SDK locally.


## SDK Functionality

| Area | Action | Implemented |
|---------------------|-----------------------|-------------|
| Lifecycle | Ready | ✔️ |
| Lifecycle | Health | ✔️ |
| Lifecycle | Reserve | ✔️ |
| Lifecycle | Allocate | ✔️ |
| Lifecycle | Shutdown | ✔️ |
| Configuration | GetGameServer | ✔️ |
| Configuration | WatchGameServer | ✔️ |
| Metadata | SetAnnotation | ✔️ |
| Metadata | SetLabel | ✔️ |
| Counters | GetCounter | ✔️ |
| Counters | UpdateCounter | ✔️ |
| Lists | GetList | ✔️ |
| Lists | UpdateList | ✔️ |
| Lists | AddListValue | ✔️ |
| Lists | RemoveListValue | ✔️ |
| Player Tracking | GetPlayerCapacity | ✔️ |
| Player Tracking | SetPlayerCapacity | ✔️ |
| Player Tracking | PlayerConnect | ✔️ |
| Player Tracking | GetConnectedPlayers | ✔️ |
| Player Tracking | IsPlayerConnected | ✔️ |
| Player Tracking | GetPlayerCount | ✔️ |
| Player Tracking | PlayerDisconnect | ✔️ |

The REST API can be accessed from `http://localhost:${AGONES_SDK_HTTP_PORT}/` from the game server process.
`AGONES_SDK_HTTP_PORT` is an environment variable automatically set for the game server process by Agones to
support binding the REST API to a dynamic port. It is advised to use the environment variable rather than a
Expand Down

0 comments on commit e20368b

Please sign in to comment.