freehuntx / godot-matcha

Easy webrtc matchmaking using WebTorrent tracker

godot-matcha

Easy webrtc matchmaking using WebTorrent tracker.
This project uses webtorrent to do signaling. This allows you to connect players peer2peer without a server!
I plan on improving this library and add more features. Stay tuned!

Try the demo here

Installation

1. Copy addons/matcha to your godot project.
2. For non browser builds: Install webrtc-native
3. Done!

Usage

Example (Mesh):

extends Node

var mp1 := MatchaRoom.create_mesh_room({ "identifier": "my-unique-game-identifier" })
var mp2 := MatchaRoom.create_mesh_room({ "identifier": "my-unique-game-identifier" })

func _init():
	mp1.peer_joined.connect(func(_id, peer):
		print("(1) Peer connected: ", peer.peer_id)
	)

	mp1.peer_left.connect(func(_id, peer):
		print("(1) Peer disconnected: ", peer.peer_id)
	)

	mp2.peer_joined.connect(func(_id, peer):
		print("(2) Peer connected: ", peer.peer_id)
	)

	mp2.peer_left.connect(func(_id, peer):
		print("(2) Peer disconnected: ", peer.peer_id)
	)

Example (Server/Client):

extends Node

var server := MatchaRoom.create_server_room()
var client := MatchaRoom.create_client_room(server.room_id) # Client must know the room id

func _init():
	server.peer_joined.connect(func(_id, peer):
		print("(server) Peer connected: ", peer.peer_id)
	)

	server.peer_left.connect(func(_id, peer):
		print("(server) Peer disconnected: ", peer.peer_id)
	)

	client.peer_joined.connect(func(_id, peer):
		print("(client) Peer connected: ", peer.peer_id)
	)

	client.peer_left.connect(func(_id, peer):
		print("(client) Peer disconnected: ", peer.peer_id)
	)

Changelog

29. Dec. 2023

• Replaced asserts with push_error + Error return value
  • This fixed some nasty invisible bugs
• Added example for server/client implementation
• Improved MatchaPeer class
  • Made it extend from WebRTCPeerConnection
• Improved MatchaRoom class
  • Made it extend from MultiplayerPeer
  • Added peer_joined/peer_left signals for direct access to the peer
  • Changed naming from info_hash to room_id
  • Added client/server/mesh functionality
• Improved TrackerClient class
  • Proper user-agent for non-web environment
  • Cleaner code
  • More documentation
• Prepared nostr implementation
  • In the future you can use nostr aswell as webtorrent
• Prepared lobby implementation
  • In the future you can find/list/create lobbies

26. Dec. 2023

• Replaces EventEmitter with native Signals
  • EventEmitter did not improve RefCounted reference issue behaviour so replaced it with signals
• Removed TrackerRoom class
  • Got replaced with MatchaRoom
• Exposed MatchaRoom class
  • Using multiplayer api
• Added example game "bobble"
• Added web export github page for example

23. Dec. 2023

• Initial commit
• Exposed TrackerRoom class

Thanks to

dmotz - https://github.com/dmotz/trystero

I got the idea for using webtorrent for signaling from that project.
Big thanks :)

godot-matcha's Issues

Create GodotSteam "Mock"

Technically we could mock the godotsteam api and do all the signaling and networking over mqtt.
This would have the benefit:

• Easy port to godotsteam
• More known api
• More potential compatible libraries (e.g. Godotsteam HL)

[Demo] Use custom html (web export)

We should use a custom html in the demo web export to explain the "COI" error and what to do about it. (Allow service worker)

Errot when trying the demo.

"
Error
The following features required to run Godot projects on the Web are missing:
Cross Origin Isolation - Check web server configuration (send correct headers)
SharedArrayBuffer - Check web server configuration (send correct headers)
"

seems like the same errors that pop up when you try to upload a html game to the itch io page.

Add MatchaLobby feature

Add a feature to be able to list, create, join, find (matchmake) rooms.

Node not found: "@Node2D@40/Players/CReRlO0gROdF8u4hd8EE/MultiplayerSynchronizer"

The synchronizer seems to sync data before the node exists. Maybe add visibility filter to fix that?

MatchaRoom reference gets lost

This causes after 1-2 connects the matchaRoom reference to count to 0:

	# TODO: Find a cleaner way for this whole cleanup step
	unreference()
	unreference()
	unreference()

Vulnerability report

We are a group of researchers from Leiden University, and we conduct research on vulnerabilities in open-source software. We have discovered and verified a high-severity vulnerability in your project(freehuntx/godot-matcha). Explaining the vulnerability further in this issue could allow malicious users to access details, so we recommend enabling private vulnerability reporting on GitHub to discuss this matter confidentially.
After you have enabled this feature, please add a comment to this issue so we can continue our discussion. If you have any questions, feel free to leave a reply here or send an email to: j.akhoundali [at] liacs.leidenuniv.nl

Implement nostr

Nostr can be used for free signaling aswell

Rooms with mesh connections

Hi bro!

You did a great job and made a very cool stuff!

Could you please make an example with rooms AND a mesh connection? So that multiple players can connect to one room
(I tested the rooms and I couldn’t get them to work with more than 1 connection)

It would be amazing!

Thanks for the work you've done!

RPC calls not being received

Note: Matcha is completely foreign to me, so I don't know if this is expected, or if I made a mistake somewhere. Either way, I'd like some clarification.

if I send an RPC call, nothing happens.
if I send an RPC call on a specific peer ID, it tells me their ID is unknown and the call fails.

This was tested in your bobble example, in a fresh godot project. The only thing I changed was adding an RPC to the peer joined method.