The HolePunch plugin can be used in combination with the Server to manage port-forwarding in your game through a method known as hole punching. To get started with the plugin start by importing the addons folder into your Godot game folder and enabling the plugin. Afterwards you can add the HolePunch node to the scene where you utilize matchmaking to begin setting up hole punching for your game.
You can find a simple example project at: https://github.com/lukester535/godot-holepuncher-example-project
| Type | Name |
|---|---|
| PacketPeerUDP | server_udp |
| PacketPeerUDP | peer_udp |
| String | client_name |
| String | rendevouz_address |
| String | host_address |
| String | host_port |
| int | rendevouz_port |
| int | max_player_count |
| bool | is_host |
| bool | local_testing |
| Return type | Name |
|---|---|
| void | start_traversal( string key, bool is_player_host, string player_name, string nickname) |
| void | finalize_peers() |
| void | client_disconnect() |
| void | close_session() |
-hole_punched(int my_port, int hosts_port, string hosts_address, int num_players_joining)
Emitted when all peers have completed their holepunch and are ready to connect to your game server
-session_registered()
Sends a message to the host once the server has acknowledged the lobby. Used to inform UI, status, or to stop connection timeout timers.
-update_lobby(nicknames,max_players)
Sends an array of player nicknames and max players to all clients, so you can construct something like "Lobby 2/5, Players: Bob, Jazmine"
-return_unsuccessful(message)
Returns a message if connection failed in anyway, allowing the client to reset UI.
-PacketPeerUDP server_udp The server PackPeerUDP used for connecting to the server. Not usually necessary to interact with directly as the node will handle most of this.
-PacketPeerUDP peer_udp The peer PackPeerUDP used for connecting to peers. Not usually necessary to interact with directly as the node will handle most of this.
-string client_name The name the player or client is using on the local machine.
-string rendevouz_address The ip address that is being used for the intermediate or holepunch server.
-string host_address The ip address of the confirmed host (will default to "" if the client is the host or before the host information is obtained).
-string host_port The port of the confirmed host (will default to 0 if the client is the host or before the host information is obtained).
-int rendevouz_port The port that is being used for the intermediate or holepunch server.
-int max_player_count The maximum amount of players the holepunch server sessions will account for before automatically connecting peers.
-bool is_host If the client running this game is the client hosting the game server or not.
-bool local_testing If set to true, it will allow you to connect to your own computer, for testing the server and game functionality.
-void start_traversal(string key, bool is_player_host, string player_name, string nickname) Call this method on the HolePunch node when you are ready to begin the HolePunch process.
-void finalize_peers() Call this method on the HolePunch node when you want to stop waiting for peers to begin the HolePunch process early before the server has reached the max_player_count value.
-void client_disconnect() This method has a non-client disconnect from the current session.
-void close_session() Called as host, this attempts to close your current session (if any) kicking all players including you.
A UDP hole punching server in python + Godot Client
The python server is based on https://github.com/stylesuxx/udp-hole-punching/
Server requires Python 3 and Twisted: https://twistedmatrix.com/trac/
Usage: ./server.py PORT AUTOSTART(y/n)
Autostart determines whether the game starts automatically upon reaching player max. Otherwise it has to be started by clients.
This began as a fork of: https://github.com/dalton5000/tyson/blob/master/LICENSE, but has since been reimplemented and converted to a plugin.
This simple implementation is still a work in progress. All help and contributions are welcome!