Agones SDK for Godot
Welcome to the community-driven Agones SDK for Godot Engine.
Example
extends Node
var peer = null
func _ready():
if "--server" in OS.get_cmdline_args() or OS.has_feature("Server"):
host_server(DEFAULT_PORT, MAX_PEERS)
func host_server(port, max_peers):
peer = NetworkedMultiplayerENet.new()
peer.create_server(port, max_peers)
get_tree().set_network_peer(peer)
# Initialize AGONES SDK
AgonesSDK.start()
# Agones .Ready()
AgonesSDK.ready()
func _process(delta):
if peer:
# Agones .Health()
AgonesSDK.health()
What is Agones?
Agones is an open source, batteries-included, multiplayer dedicated game server scaling and orchestration platform that can run anywhere Kubernetes can run.
This plugin allows your Godot Scripts communicate with Agones by giving you simple GDScript functions. Internally it works by calling the REST API that comes with Agones Server.
Only GDScript is supported for now
Install
To install this plugin, go to Releases and download the latest version agones-sdk.zip.
Inside your Godot Project folder, create a folder named addons and extract the zip file inside it.
After installed, your folder structure will look like this:
Getting Started
Activate the plugin
- Open your project in Godot Editor
- Go to Project > Project Settings... > Plugins
- You should see AgonesSDK Plugin. On the right side, check the "Enable" box
Use the SDK functions
You now have access to a singleton called AgonesSDK, which you can use to call SDK functions.
The SDK functions does the communication with Agones's sidecar server, which is a small server that goes with your Godot dedicated server inside the Agones Container.
If you want to test in local environment, check this page Local Development - Agones
Ready()
# Simple usage. Automatically retries 10 times and waits 2 seconds before trying again.
AgonesSDK.ready()
# Tries 30 times, waiting 5 seconds between each attempt.
AgonesSDK.ready(30, 5)
Health()
AgonesSDK.health()
Reserve()
# Reserves the server for 10 seconds
AgonesSDK.reserve(10)
# Reserves the server for 60 seconds
AgonesSDK.reserve(60)
Allocate()
AgonesSDK.allocate()
Shutdown()
AgonesSDK.shutdown()
GameServer()
# Get gameserver information
result = yield(AgonesSDK.gameserver(), "agones_response")
success = result[0] # true if the request was successfull, false otherwise
requested_endpoint = result[1] # the url requested
info_dict = result[2] # the JSON body returned by agones sidecar
SetLabel(key, value)
# Set metadata label on agones sidecar servr
AgonesSDK.set_label('version', '1.0.0')
SetAnnotation(key, value)
# Set metadata annotation on agones sidecar servr
AgonesSDK.set_annotation('version', '1.0.0')
Player Tracking
As of writing, the Player Tracking feature of Agones is not implemented by the SDK. Feel free to contribute and send your pull request.
Reference
| Type | Syntax | Description |
|---|---|---|
func |
.ready(retry, wait_time) |
retry how many times it will retry. wait_time time in seconds to wait between retries |
func |
.health() |
Sends a health check |
func |
.reserve(seconds) |
Reserve for seconds |
func |
.allocate() |
Set GameServer as Allocated |
func |
.shutdown() |
Tells Agones to shutdown server |
signal |
agones_response(success, endpoint, content) |
Emitted when SDK receives an response from Agones. success Boolean if response is sucessfull. endpoint the requested endpoint. content the error message or request body, usually as a Dictionary |
signal |
agones_ready_failed |
Emitted when .ready fails all its attempts. |
Contributing
Contributions are very welcome.
License
Distributed under the terms of the MIT license, "godot-agones-sdk" is free and open source software
