Agones Game Server Client SDKs on Agones /site/docs/guides/client-sdks/ Recent content in Agones Game Server Client SDKs on Agones Hugo en Sun, 12 Apr 2026 09:34:00 -0700 Unreal Engine Game Server Client Plugin /site/docs/guides/client-sdks/unreal/ Mon, 13 May 2019 00:00:00 +0000 /site/docs/guides/client-sdks/unreal/ <p>Check the <a href="/site/docs/guides/client-sdks/">Client SDK Documentation</a> for more details on each of the SDK functions and how to run the SDK locally.</p> <h2 id="sdk-functionality">SDK Functionality</h2> <table> <thead> <tr> <th>Area</th> <th>Action</th> <th>Implemented</th> </tr> </thead> <tbody> <tr> <td>Lifecycle</td> <td>Ready</td> <td>✔️</td> </tr> <tr> <td>Lifecycle</td> <td>Health</td> <td>✔️</td> </tr> <tr> <td>Lifecycle</td> <td>Reserve</td> <td>✔️</td> </tr> <tr> <td>Lifecycle</td> <td>Allocate</td> <td>✔️</td> </tr> <tr> <td>Lifecycle</td> <td>Shutdown</td> <td>✔️</td> </tr> <tr> <td>Configuration</td> <td>GameServer</td> <td>✔️</td> </tr> <tr> <td>Configuration</td> <td>Watch</td> <td>✔️</td> </tr> <tr> <td>Metadata</td> <td>SetAnnotation</td> <td>✔️</td> </tr> <tr> <td>Metadata</td> <td>SetLabel</td> <td>✔️</td> </tr> <tr> <td>Counters</td> <td>GetCounterCount</td> <td>✔️</td> </tr> <tr> <td>Counters</td> <td>SetCounterCount</td> <td>✔️</td> </tr> <tr> <td>Counters</td> <td>IncrementCounter</td> <td>✔️</td> </tr> <tr> <td>Counters</td> <td>DecrementCounter</td> <td>✔️</td> </tr> <tr> <td>Counters</td> <td>SetCounterCapacity</td> <td>✔️</td> </tr> <tr> <td>Counters</td> <td>GetCounterCapacity</td> <td>✔️</td> </tr> <tr> <td>Lists</td> <td>GetList</td> <td>✔️</td> </tr> <tr> <td>Lists</td> <td>UpdateList</td> <td>✔️</td> </tr> <tr> <td>Lists</td> <td>AddListValue</td> <td>✔️</td> </tr> <tr> <td>Lists</td> <td>RemoveListValue</td> <td>✔️</td> </tr> <tr> <td>Player Tracking</td> <td>GetConnectedPlayers</td> <td>✔️</td> </tr> <tr> <td>Player Tracking</td> <td>GetPlayerCapacity</td> <td>✔️</td> </tr> <tr> <td>Player Tracking</td> <td>GetPlayerCount</td> <td>✔️</td> </tr> <tr> <td>Player Tracking</td> <td>IsPlayerConnected</td> <td>✔️</td> </tr> <tr> <td>Player Tracking</td> <td>PlayerConnect</td> <td>✔️</td> </tr> <tr> <td>Player Tracking</td> <td>PlayerDisconnect</td> <td>✔️</td> </tr> <tr> <td>Player Tracking</td> <td>SetPlayerCapacity</td> <td>✔️</td> </tr> </tbody> </table> <p>Additional methods have been added for ease of use (both of which are enabled by default):</p> Unity Game Server Client SDK /site/docs/guides/client-sdks/unity/ Thu, 13 Jun 2019 10:17:50 +0000 /site/docs/guides/client-sdks/unity/ <p>Check the <a href="/site/docs/guides/client-sdks/">Client SDK Documentation</a> for more details on each of the SDK functions and how to run the SDK locally.</p> <h2 id="sdk-functionality">SDK Functionality</h2> <table> <thead> <tr> <th>Area</th> <th>Action</th> <th>Implemented</th> </tr> </thead> <tbody> <tr> <td>Lifecycle</td> <td>Ready</td> <td>✔️</td> </tr> <tr> <td>Lifecycle</td> <td>Health</td> <td>✔️</td> </tr> <tr> <td>Lifecycle</td> <td>Reserve</td> <td>✔️</td> </tr> <tr> <td>Lifecycle</td> <td>Allocate</td> <td>✔️</td> </tr> <tr> <td>Lifecycle</td> <td>Shutdown</td> <td>✔️</td> </tr> <tr> <td>Configuration</td> <td>GameServer</td> <td>✔️</td> </tr> <tr> <td>Configuration</td> <td>Watch</td> <td>✔️</td> </tr> <tr> <td>Metadata</td> <td>SetAnnotation</td> <td>✔️</td> </tr> <tr> <td>Metadata</td> <td>SetLabel</td> <td>✔️</td> </tr> <tr> <td>Counters</td> <td>GetCounterCount</td> <td>❌</td> </tr> <tr> <td>Counters</td> <td>SetCounterCount</td> <td>❌</td> </tr> <tr> <td>Counters</td> <td>IncrementCounter</td> <td>❌</td> </tr> <tr> <td>Counters</td> <td>DecrementCounter</td> <td>❌</td> </tr> <tr> <td>Counters</td> <td>SetCounterCapacity</td> <td>❌</td> </tr> <tr> <td>Counters</td> <td>GetCounterCapacity</td> <td>❌</td> </tr> <tr> <td>Lists</td> <td>AppendListValue</td> <td>❌</td> </tr> <tr> <td>Lists</td> <td>DeleteListValue</td> <td>❌</td> </tr> <tr> <td>Lists</td> <td>SetListCapacity</td> <td>❌</td> </tr> <tr> <td>Lists</td> <td>GetListCapacity</td> <td>❌</td> </tr> <tr> <td>Lists</td> <td>ListContains</td> <td>❌</td> </tr> <tr> <td>Lists</td> <td>GetListLength</td> <td>❌</td> </tr> <tr> <td>Lists</td> <td>GetListValues</td> <td>❌</td> </tr> <tr> <td>Player Tracking</td> <td>GetConnectedPlayers</td> <td>✔️</td> </tr> <tr> <td>Player Tracking</td> <td>GetPlayerCapacity</td> <td>✔️</td> </tr> <tr> <td>Player Tracking</td> <td>GetPlayerCount</td> <td>✔️</td> </tr> <tr> <td>Player Tracking</td> <td>IsPlayerConnected</td> <td>✔️</td> </tr> <tr> <td>Player Tracking</td> <td>PlayerConnect</td> <td>✔️</td> </tr> <tr> <td>Player Tracking</td> <td>PlayerDisconnect</td> <td>✔️</td> </tr> <tr> <td>Player Tracking</td> <td>SetPlayerCapacity</td> <td>✔️</td> </tr> </tbody> </table> <p>Additional methods have been added for ease of use:</p> C++ Game Server Client SDK /site/docs/guides/client-sdks/cpp/ Wed, 02 Jan 2019 10:17:50 +0000 /site/docs/guides/client-sdks/cpp/ <p>Check the <a href="/site/docs/guides/client-sdks/">Client SDK Documentation</a> for more details on each of the SDK functions and how to run the SDK locally.</p> <h2 id="sdk-functionality">SDK Functionality</h2> <table> <thead> <tr> <th>Area</th> <th>Action</th> <th>Implemented</th> </tr> </thead> <tbody> <tr> <td>Lifecycle</td> <td>Ready</td> <td>✔️</td> </tr> <tr> <td>Lifecycle</td> <td>Health</td> <td>✔️</td> </tr> <tr> <td>Lifecycle</td> <td>Reserve</td> <td>✔️</td> </tr> <tr> <td>Lifecycle</td> <td>Allocate</td> <td>✔️</td> </tr> <tr> <td>Lifecycle</td> <td>Shutdown</td> <td>✔️</td> </tr> <tr> <td>Configuration</td> <td>GameServer</td> <td>✔️</td> </tr> <tr> <td>Configuration</td> <td>WatchGameServer</td> <td>✔️</td> </tr> <tr> <td>Metadata</td> <td>SetAnnotation</td> <td>✔️</td> </tr> <tr> <td>Metadata</td> <td>SetLabel</td> <td>✔️</td> </tr> <tr> <td>Counters</td> <td>GetCounterCount</td> <td>❌</td> </tr> <tr> <td>Counters</td> <td>SetCounterCount</td> <td>❌</td> </tr> <tr> <td>Counters</td> <td>IncrementCounter</td> <td>❌</td> </tr> <tr> <td>Counters</td> <td>DecrementCounter</td> <td>❌</td> </tr> <tr> <td>Counters</td> <td>SetCounterCapacity</td> <td>❌</td> </tr> <tr> <td>Counters</td> <td>GetCounterCapacity</td> <td>❌</td> </tr> <tr> <td>Lists</td> <td>AppendListValue</td> <td>❌</td> </tr> <tr> <td>Lists</td> <td>DeleteListValue</td> <td>❌</td> </tr> <tr> <td>Lists</td> <td>SetListCapacity</td> <td>❌</td> </tr> <tr> <td>Lists</td> <td>GetListCapacity</td> <td>❌</td> </tr> <tr> <td>Lists</td> <td>ListContains</td> <td>❌</td> </tr> <tr> <td>Lists</td> <td>GetListLength</td> <td>❌</td> </tr> <tr> <td>Lists</td> <td>GetListValues</td> <td>❌</td> </tr> </tbody> </table> <h2 id="installation">Installation</h2> <h3 id="download">Download</h3> <p>Download the source from the <a href="https://github.com/agones-dev/agones/releases">Releases Page</a> or <a href="https://github.com/agones-dev/agones/blob/main/sdks/cpp" target="_blank" data-proofer-ignore>directly from GitHub</a> .</p> Go Game Server Client SDK /site/docs/guides/client-sdks/go/ Fri, 17 May 2019 10:17:50 +0000 /site/docs/guides/client-sdks/go/ <p>Check the <a href="/site/docs/guides/client-sdks/">Client SDK Documentation</a> for more details on each of the SDK functions and how to run the SDK locally.</p> <h2 id="sdk-functionality">SDK Functionality</h2> <table> <thead> <tr> <th>Area</th> <th>Action</th> <th>Implemented</th> </tr> </thead> <tbody> <tr> <td>Lifecycle</td> <td>Ready</td> <td>✔️</td> </tr> <tr> <td>Lifecycle</td> <td>Health</td> <td>✔️</td> </tr> <tr> <td>Lifecycle</td> <td>Reserve</td> <td>✔️</td> </tr> <tr> <td>Lifecycle</td> <td>Allocate</td> <td>✔️</td> </tr> <tr> <td>Lifecycle</td> <td>Shutdown</td> <td>✔️</td> </tr> <tr> <td>Configuration</td> <td>GameServer</td> <td>✔️</td> </tr> <tr> <td>Configuration</td> <td>Watch</td> <td>✔️</td> </tr> <tr> <td>Metadata</td> <td>SetAnnotation</td> <td>✔️</td> </tr> <tr> <td>Metadata</td> <td>SetLabel</td> <td>✔️</td> </tr> <tr> <td>Counters</td> <td>GetCounterCount</td> <td>✔️</td> </tr> <tr> <td>Counters</td> <td>SetCounterCount</td> <td>✔️</td> </tr> <tr> <td>Counters</td> <td>IncrementCounter</td> <td>✔️</td> </tr> <tr> <td>Counters</td> <td>DecrementCounter</td> <td>✔️</td> </tr> <tr> <td>Counters</td> <td>SetCounterCapacity</td> <td>✔️</td> </tr> <tr> <td>Counters</td> <td>GetCounterCapacity</td> <td>✔️</td> </tr> <tr> <td>Lists</td> <td>AppendListValue</td> <td>✔️</td> </tr> <tr> <td>Lists</td> <td>DeleteListValue</td> <td>✔️</td> </tr> <tr> <td>Lists</td> <td>SetListCapacity</td> <td>✔️</td> </tr> <tr> <td>Lists</td> <td>GetListCapacity</td> <td>✔️</td> </tr> <tr> <td>Lists</td> <td>ListContains</td> <td>✔️</td> </tr> <tr> <td>Lists</td> <td>GetListLength</td> <td>✔️</td> </tr> <tr> <td>Lists</td> <td>GetListValues</td> <td>✔️</td> </tr> <tr> <td>Player Tracking</td> <td>GetConnectedPlayers</td> <td>✔️</td> </tr> <tr> <td>Player Tracking</td> <td>GetPlayerCapacity</td> <td>✔️</td> </tr> <tr> <td>Player Tracking</td> <td>GetPlayerCount</td> <td>✔️</td> </tr> <tr> <td>Player Tracking</td> <td>IsPlayerConnected</td> <td>✔️</td> </tr> <tr> <td>Player Tracking</td> <td>PlayerConnect</td> <td>✔️</td> </tr> <tr> <td>Player Tracking</td> <td>PlayerDisconnect</td> <td>✔️</td> </tr> <tr> <td>Player Tracking</td> <td>SetPlayerCapacity</td> <td>✔️</td> </tr> </tbody> </table> <h2 id="installation">Installation</h2> <p><code>go get</code> the source, <a href="https://github.com/agones-dev/agones/blob/main/sdks/go" target="_blank" data-proofer-ignore>directly from GitHub</a> </p> C# Game Server Client SDK /site/docs/guides/client-sdks/csharp/ Thu, 28 May 2020 00:00:00 +0000 /site/docs/guides/client-sdks/csharp/ <p>Check the <a href="/site/docs/guides/client-sdks/">Client SDK Documentation</a> for more details on each of the SDK functions and how to run the SDK locally.</p> <h2 id="sdk-functionality">SDK Functionality</h2> <table> <thead> <tr> <th>Area</th> <th>Action</th> <th>Implemented</th> </tr> </thead> <tbody> <tr> <td>Lifecycle</td> <td>Ready</td> <td>✔️</td> </tr> <tr> <td>Lifecycle</td> <td>Health</td> <td>✔️</td> </tr> <tr> <td>Lifecycle</td> <td>Reserve</td> <td>✔️</td> </tr> <tr> <td>Lifecycle</td> <td>Allocate</td> <td>✔️</td> </tr> <tr> <td>Lifecycle</td> <td>Shutdown</td> <td>✔️</td> </tr> <tr> <td>Configuration</td> <td>GetGameServer</td> <td>✔️</td> </tr> <tr> <td>Configuration</td> <td>WatchGameServer</td> <td>✔️</td> </tr> <tr> <td>Metadata</td> <td>SetAnnotation</td> <td>✔️</td> </tr> <tr> <td>Metadata</td> <td>SetLabel</td> <td>✔️</td> </tr> <tr> <td>Counters</td> <td>GetCounterCount</td> <td>✔️</td> </tr> <tr> <td>Counters</td> <td>SetCounterCount</td> <td>✔️</td> </tr> <tr> <td>Counters</td> <td>IncrementCounter</td> <td>✔️</td> </tr> <tr> <td>Counters</td> <td>DecrementCounter</td> <td>✔️</td> </tr> <tr> <td>Counters</td> <td>SetCounterCapacity</td> <td>✔️</td> </tr> <tr> <td>Counters</td> <td>GetCounterCapacity</td> <td>✔️</td> </tr> <tr> <td>Lists</td> <td>AppendListValue</td> <td>✔️</td> </tr> <tr> <td>Lists</td> <td>DeleteListValue</td> <td>✔️</td> </tr> <tr> <td>Lists</td> <td>SetListCapacity</td> <td>✔️</td> </tr> <tr> <td>Lists</td> <td>GetListCapacity</td> <td>✔️</td> </tr> <tr> <td>Lists</td> <td>ListContains</td> <td>✔️</td> </tr> <tr> <td>Lists</td> <td>GetListLength</td> <td>✔️</td> </tr> <tr> <td>Lists</td> <td>GetListValues</td> <td>✔️</td> </tr> <tr> <td>Player Tracking</td> <td>GetConnectedPlayers</td> <td>✔️</td> </tr> <tr> <td>Player Tracking</td> <td>GetPlayerCapacity</td> <td>✔️</td> </tr> <tr> <td>Player Tracking</td> <td>GetPlayerCount</td> <td>✔️</td> </tr> <tr> <td>Player Tracking</td> <td>IsPlayerConnected</td> <td>✔️</td> </tr> <tr> <td>Player Tracking</td> <td>PlayerConnect</td> <td>✔️</td> </tr> <tr> <td>Player Tracking</td> <td>PlayerDisconnect</td> <td>✔️</td> </tr> <tr> <td>Player Tracking</td> <td>SetPlayerCapacity</td> <td>✔️</td> </tr> </tbody> </table> <h2 id="download">Download</h2> <p>Download the source <a href="https://github.com/agones-dev/agones/blob/main/sdks/csharp" target="_blank" data-proofer-ignore>directly from GitHub</a> .</p> Node.js Game Server Client SDK /site/docs/guides/client-sdks/nodejs/ Mon, 01 Apr 2019 00:00:00 +0000 /site/docs/guides/client-sdks/nodejs/ <p>Check the <a href="/site/docs/guides/client-sdks/">Client SDK Documentation</a> for more details on each of the SDK functions and how to run the SDK locally.</p> <h2 id="sdk-functionality">SDK Functionality</h2> <table> <thead> <tr> <th>Area</th> <th>Action</th> <th>Implemented</th> </tr> </thead> <tbody> <tr> <td>Lifecycle</td> <td>Ready</td> <td>✔️</td> </tr> <tr> <td>Lifecycle</td> <td>Health</td> <td>✔️</td> </tr> <tr> <td>Lifecycle</td> <td>Reserve</td> <td>✔️</td> </tr> <tr> <td>Lifecycle</td> <td>Allocate</td> <td>✔️</td> </tr> <tr> <td>Lifecycle</td> <td>Shutdown</td> <td>✔️</td> </tr> <tr> <td>Configuration</td> <td>GetGameServer</td> <td>✔️</td> </tr> <tr> <td>Configuration</td> <td>WatchGameServer</td> <td>✔️</td> </tr> <tr> <td>Metadata</td> <td>SetAnnotation</td> <td>✔️</td> </tr> <tr> <td>Metadata</td> <td>SetLabel</td> <td>✔️</td> </tr> <tr> <td>Counters</td> <td>GetCounterCount</td> <td>✔️</td> </tr> <tr> <td>Counters</td> <td>SetCounterCount</td> <td>✔️</td> </tr> <tr> <td>Counters</td> <td>IncrementCounter</td> <td>✔️</td> </tr> <tr> <td>Counters</td> <td>DecrementCounter</td> <td>✔️</td> </tr> <tr> <td>Counters</td> <td>SetCounterCapacity</td> <td>✔️</td> </tr> <tr> <td>Counters</td> <td>GetCounterCapacity</td> <td>✔️</td> </tr> <tr> <td>Lists</td> <td>AppendListValue</td> <td>✔️</td> </tr> <tr> <td>Lists</td> <td>DeleteListValue</td> <td>✔️</td> </tr> <tr> <td>Lists</td> <td>SetListCapacity</td> <td>✔️</td> </tr> <tr> <td>Lists</td> <td>GetListCapacity</td> <td>✔️</td> </tr> <tr> <td>Lists</td> <td>ListContains</td> <td>✔️</td> </tr> <tr> <td>Lists</td> <td>GetListLength</td> <td>✔️</td> </tr> <tr> <td>Lists</td> <td>GetListValues</td> <td>✔️</td> </tr> <tr> <td>Player Tracking</td> <td>GetConnectedPlayers</td> <td>✔️</td> </tr> <tr> <td>Player Tracking</td> <td>GetPlayerCapacity</td> <td>✔️</td> </tr> <tr> <td>Player Tracking</td> <td>GetPlayerCount</td> <td>✔️</td> </tr> <tr> <td>Player Tracking</td> <td>IsPlayerConnected</td> <td>✔️</td> </tr> <tr> <td>Player Tracking</td> <td>PlayerConnect</td> <td>✔️</td> </tr> <tr> <td>Player Tracking</td> <td>PlayerDisconnect</td> <td>✔️</td> </tr> <tr> <td>Player Tracking</td> <td>SetPlayerCapacity</td> <td>✔️</td> </tr> </tbody> </table> <h2 id="prerequisites">Prerequisites</h2> <ul> <li>Node.js &gt;= 10.13.0</li> </ul> <h2 id="usage">Usage</h2> <p>Add the agones dependency to your project:</p> Rust Game Server Client SDK /site/docs/guides/client-sdks/rust/ Wed, 02 Jan 2019 10:17:57 +0000 /site/docs/guides/client-sdks/rust/ <p>Check the <a href="/site/docs/guides/client-sdks/">Client SDK Documentation</a> for more details on each of the SDK functions and how to run the SDK locally.</p> <h2 id="sdk-functionality">SDK Functionality</h2> <table> <thead> <tr> <th>Area</th> <th>Action</th> <th>Implemented</th> </tr> </thead> <tbody> <tr> <td>Lifecycle</td> <td>Ready</td> <td>✔️</td> </tr> <tr> <td>Lifecycle</td> <td>Health</td> <td>✔️</td> </tr> <tr> <td>Lifecycle</td> <td>Reserve</td> <td>✔️</td> </tr> <tr> <td>Lifecycle</td> <td>Allocate</td> <td>✔️</td> </tr> <tr> <td>Lifecycle</td> <td>Shutdown</td> <td>✔️</td> </tr> <tr> <td>Configuration</td> <td>GameServer</td> <td>✔️</td> </tr> <tr> <td>Configuration</td> <td>Watch</td> <td>✔️</td> </tr> <tr> <td>Metadata</td> <td>SetAnnotation</td> <td>✔️</td> </tr> <tr> <td>Metadata</td> <td>SetLabel</td> <td>✔️</td> </tr> <tr> <td>Counters</td> <td>GetCounterCount</td> <td>✔️</td> </tr> <tr> <td>Counters</td> <td>SetCounterCount</td> <td>✔️</td> </tr> <tr> <td>Counters</td> <td>IncrementCounter</td> <td>✔️</td> </tr> <tr> <td>Counters</td> <td>DecrementCounter</td> <td>✔️</td> </tr> <tr> <td>Counters</td> <td>SetCounterCapacity</td> <td>✔️</td> </tr> <tr> <td>Counters</td> <td>GetCounterCapacity</td> <td>✔️</td> </tr> <tr> <td>Lists</td> <td>AppendListValue</td> <td>✔️</td> </tr> <tr> <td>Lists</td> <td>DeleteListValue</td> <td>✔️</td> </tr> <tr> <td>Lists</td> <td>SetListCapacity</td> <td>✔️</td> </tr> <tr> <td>Lists</td> <td>GetListCapacity</td> <td>✔️</td> </tr> <tr> <td>Lists</td> <td>ListContains</td> <td>✔️</td> </tr> <tr> <td>Lists</td> <td>GetListLength</td> <td>✔️</td> </tr> <tr> <td>Lists</td> <td>GetListValues</td> <td>✔️</td> </tr> <tr> <td>Player Tracking</td> <td>GetConnectedPlayers</td> <td>✔️</td> </tr> <tr> <td>Player Tracking</td> <td>GetPlayerCapacity</td> <td>✔️</td> </tr> <tr> <td>Player Tracking</td> <td>GetPlayerCount</td> <td>✔️</td> </tr> <tr> <td>Player Tracking</td> <td>IsPlayerConnected</td> <td>✔️</td> </tr> <tr> <td>Player Tracking</td> <td>PlayerConnect</td> <td>✔️</td> </tr> <tr> <td>Player Tracking</td> <td>PlayerDisconnect</td> <td>✔️</td> </tr> <tr> <td>Player Tracking</td> <td>SetPlayerCapacity</td> <td>✔️</td> </tr> </tbody> </table> <h2 id="prerequisites">Prerequisites</h2> <ul> <li><a href="https://www.rust-lang.org/tools/install">Rust &gt;= 1.50</a></li> </ul> <h2 id="usage">Usage</h2> <p>Add <a href="https://crates.io/crates/agones" data-proofer-ignore>this crate</a> to <code>dependencies</code> section in your Cargo.toml.</p> REST Game Server Client API /site/docs/guides/client-sdks/rest/ Wed, 02 Jan 2019 10:18:08 +0000 /site/docs/guides/client-sdks/rest/ <p>Check the <a href="/site/docs/guides/client-sdks/">Client SDK Documentation</a> for more details on each of the SDK functions and how to run the SDK locally.</p> <h2 id="sdk-functionality">SDK Functionality</h2> <table> <thead> <tr> <th>Area</th> <th>Action</th> <th>Implemented</th> </tr> </thead> <tbody> <tr> <td>Lifecycle</td> <td>Ready</td> <td>✔️</td> </tr> <tr> <td>Lifecycle</td> <td>Health</td> <td>✔️</td> </tr> <tr> <td>Lifecycle</td> <td>Reserve</td> <td>✔️</td> </tr> <tr> <td>Lifecycle</td> <td>Allocate</td> <td>✔️</td> </tr> <tr> <td>Lifecycle</td> <td>Shutdown</td> <td>✔️</td> </tr> <tr> <td>Configuration</td> <td>GetGameServer</td> <td>✔️</td> </tr> <tr> <td>Configuration</td> <td>WatchGameServer</td> <td>✔️</td> </tr> <tr> <td>Metadata</td> <td>SetAnnotation</td> <td>✔️</td> </tr> <tr> <td>Metadata</td> <td>SetLabel</td> <td>✔️</td> </tr> <tr> <td>Counters</td> <td>GetCounter</td> <td>✔️</td> </tr> <tr> <td>Counters</td> <td>UpdateCounter</td> <td>✔️</td> </tr> <tr> <td>Lists</td> <td>GetList</td> <td>✔️</td> </tr> <tr> <td>Lists</td> <td>UpdateList</td> <td>✔️</td> </tr> <tr> <td>Lists</td> <td>AddListValue</td> <td>✔️</td> </tr> <tr> <td>Lists</td> <td>RemoveListValue</td> <td>✔️</td> </tr> <tr> <td>Player Tracking</td> <td>GetPlayerCapacity</td> <td>✔️</td> </tr> <tr> <td>Player Tracking</td> <td>SetPlayerCapacity</td> <td>✔️</td> </tr> <tr> <td>Player Tracking</td> <td>PlayerConnect</td> <td>✔️</td> </tr> <tr> <td>Player Tracking</td> <td>GetConnectedPlayers</td> <td>✔️</td> </tr> <tr> <td>Player Tracking</td> <td>IsPlayerConnected</td> <td>✔️</td> </tr> <tr> <td>Player Tracking</td> <td>GetPlayerCount</td> <td>✔️</td> </tr> <tr> <td>Player Tracking</td> <td>PlayerDisconnect</td> <td>✔️</td> </tr> </tbody> </table> <p>The REST API can be accessed from <code>http://localhost:${AGONES_SDK_HTTP_PORT}/</code> from the game server process. <code>AGONES_SDK_HTTP_PORT</code> 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 hard coded port; otherwise your game server will not be able to contact the SDK server if it is configured to use a non-default port.</p> Local Development /site/docs/guides/client-sdks/local/ Tue, 29 Jan 2019 10:18:08 +0000 /site/docs/guides/client-sdks/local/ <p>When the game server is running on Agones, the SDK communicates over TCP to a small gRPC server that Agones coordinated to run in a container in the same network namespace as it - usually referred to in Kubernetes terms as a &ldquo;sidecar&rdquo;.</p> <p>Therefore, when developing locally, we also need a process for the SDK to connect to!</p> <p>To do this, we can run the same binary (the SDK Server) that runs inside Agones, but pass in a flag to run it in &ldquo;local mode&rdquo;. Local mode means that the sidecar binary will not try to connect to anything, and will just send log messages to stdout and persist local state in memory so that you can see exactly what the SDK in your game server is doing, and can confirm everything works.</p>