Welcome to the community-driven Agones SDK for Godot Engine.
Latest version is for Godot 4.2.
If you're using Godot < 4.2, please use Release 0.4.0
If you're using Godot <= 3.x, please use Release 0.3.0
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
To install this plugin, go to Releases and download the latest version agones-sdk.zip.
If you are using Godot 3.x, please install Release 0.3.0
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:
- 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
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