Browser games (wss://)

​

When you need this

​

Set it up

1. Set your port to TCP. A new project starts with one UDP port. WebSocket needs TCP.
2. Turn on TLS for that port. Open your project’s Environment tab, click Edit ports in the Ports section, and tick TLS on the port. Or click Browser / WebSocket game. It sets a TCP port named game with TLS on, listening on 8080. You can change the number. Then click Save.
3. Listen on plain TCP in your game. Don’t add encryption to your server. Simpl does that. Read the port from SIMPL_PORT_GAME when your server starts, as described in Ports and environment.

​

How to connect

wss://<host>:<port>

​

What to expect

• A TLS port accepts wss:// only. A plain ws:// connection to it fails.
• If you also need plain ws://, for example to test on your own computer, add a second TCP port and leave TLS off on it.
• Your game still sees plain TCP. It never sees the encryption.
• TLS works on TCP ports only. A UDP port with TLS on is refused with the error TLS_REQUIRES_TCP.

​

If it does not connect

• The port is still UDP. Switch it to TCP, then turn on TLS.
• You used the IP address. Use the host name from the server’s details.
• The page is on http and the address is ws://. A page on https can only open wss://. Use the wss:// address with the host name.
• The server started before you saved the setting. Running servers keep the settings they started with. Start a new server.
• You tried ws:// on a TLS port. Use wss://, or add a second TCP port without TLS.

​

Example: Godot 4

extends Node


func _ready() -> void:
	var port := int(OS.get_environment("SIMPL_PORT_GAME"))
	if port == 0:
		port = 8080  # Running on your own computer.
	var bind := OS.get_environment("SIMPL_TCP_BIND_ADDRESS")
	if bind.is_empty():
		bind = "*"

	var peer := WebSocketMultiplayerPeer.new()
	var err := peer.create_server(port, bind)
	if err != OK:
		push_error("Could not listen: %s" % error_string(err))
		get_tree().quit(1)
		return
	multiplayer.multiplayer_peer = peer
	multiplayer.peer_connected.connect(func(id: int) -> void: print("Player joined: ", id))

extends Node


func connect_to_server(host: String, port: int) -> void:
	var peer := WebSocketMultiplayerPeer.new()
	var err := peer.create_client("wss://%s:%d" % [host, port])
	if err != OK:
		push_error("Could not start connecting: %s" % error_string(err))
		return
	multiplayer.multiplayer_peer = peer
	multiplayer.connected_to_server.connect(func() -> void: print("Connected"))
	multiplayer.connection_failed.connect(func() -> void: print("Could not connect"))