https://github.com/winston-yallow/mosaic-client

Collaborative multiplayer game made in Godot
https://github.com/winston-yallow/mosaic-client

game-development godot godot-game multiplayer webrtc-demos

Last synced: about 1 month ago
JSON representation

Collaborative multiplayer game made in Godot

• Host: GitHub
• URL: https://github.com/winston-yallow/mosaic-client
• Owner: winston-yallow
• License: mit
• Created: 2021-09-16T19:20:01.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-09-16T19:38:04.000Z (over 3 years ago)
• Last Synced: 2024-11-14T03:34:38.681Z (3 months ago)
• Topics: game-development, godot, godot-game, multiplayer, webrtc-demos
• Language: GDScript
• Homepage: https://winston-yallow.itch.io/mosaic
• Size: 174 KB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Mosaic

Collaborative multiplayer Game where players rearrange fragments to form images.

Made in 72 hours for the ["STOP WAITING FOR GODOT" Game Jam](https://itch.io/jam/stop-waiting-for-godot).

You can play the [web version on itch](https://winston-yallow.itch.io/mosaic).

## Details

This uses WebRTC to create a peer to peer network. A small signalling server is needed

so that the peers can discover each other and exchange SDP offers as well as ICE candidates.

The [Mosaic Server](https://github.com/winston-yallow/mosaic-server) I wrote uses python,

but the protocol is quite simple and it should be easy to recreate it or adjust it to your needs.

I made this game in a quite limited timeframe so please expect bugs. I also did not follow best

practices wherever that would save some time in the sort term. For a long term project that is

probably not the best approach.

Most code files have at least a small description on the top. If you have questions don't hesitate

to ask, I did not add many comments to the code.

## Running the Project

To run this project you will first need to start your own signalling server. You can download

it from the [Mosaic Server](https://github.com/winston-yallow/mosaic-server) repo.

After that you will need to edit the `src/network_mesh/NetworkMesh.gd` file.

You should adjust the `_websocket_url` to point to your server (defaults to localhost)

and add some STUN/TURN servers to `_ice_servers`.

If you test this locally you can use an empty list of URLs. This will only work if clients

can communicate with each other without the need to use STUN/TURN (for example multiple

clients running on the same computer).

## Licenses

My code: MIT License

Godot Engine: MIT License

Music Jingles by Kenney: Creative Commons Zero (CC0)

Poppins Font: Open Font License (OFL)

## Resources

- [Twitter thread](https://twitter.com/WinstonYallow/status/1435180419717210112) by me describing some of the mesh networking from this game

- [Godot Game Engine](https://godotengine.org/)

- [Music Jingles by Kenney](https://www.kenney.nl/assets/music-jingles)

- [Poppins Font on fonts.google.com](https://fonts.google.com/specimen/Poppins)