Skip to content

RGonzalezTech/Friendslop-Template

Repository files navigation

Friendslop Template 🎮

This is a Godot 4.4 starter kit designed to get your multiplayer game running quickly. It comes with scene synchronization, lobby, and player spawning systems.

Tests Godot Version License: MIT Stars Forks

Tip

This is intended as a GitHub Template. Github does not support Git LFS in templates, so you will need to manually clone/fork this repo to use it.

📺 Video

Check out the overview video below to see the template in editor.

Friendslop Template Walkthrough

🚀 Key Features

  • Multiplayer Ready: Supports ENet out of the box and can be easily extended.
  • Safe Scene Management: A robust system to handle level transitions for all connected players simultaneously.
  • Input Routing: A clean pattern to handle local co-op input.
  • Handshake Replication: A custom spawning system that ensures clients are actually ready to receive spawn/sync packets
  • Testing: Pre-configured with GUT for unit testing.

📂 Project Structure

  • addons/: Third-party tools (I always start with GUT in my projects).
  • scenes/: All your .tscn files (Menus, Levels, UI).
    • Gameplay scenes should contain and manage their own logic and state when possible.
  • scripts/: The brains
    • core/: The Scene Manager nodes.
    • input/: Device input handling logic.
    • multiplayer/: Networking, Lobby, and Replication logic.
  • test/: Unit tests to keep your code sane.

🛠️ Getting Started

  1. Clone or Fork: Manually clone or fork this repository to your account (GitHub Templates do not support Git LFS).
  2. Open in Godot: Open the project in Godot 4.4 or later.
  3. Run & Play: Run the project to host or join a lobby right away.

Philosophy

I prefer Simple over Complex. This template avoids massive, monolithic managers in favor of smaller, focused components. If a script does more than one thing, it's probably doing too much.

See CONTRIBUTING.md for more information.

Enjoy!

About

A Godot 4.4 starter kit to get a lobby of players connected and synchronized

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Contributors