Godot Together

A work in progress plugin for real-time collaboration over the network for Godot Engine.

Wiki & help | Troubleshooting | Report bugs | Feature TODO list

Caution

This plugin allows for remote code execution.
Make sure to never collaborate with people you don't FULLY trust.

There's also a risk of your projects becoming corrupted so always make backups or/and use version control like git.

Installation

First create a folder called addons in your project's directory.

Getting the plugin

Note

As the plugin is not fully released, you're going to download the current state of development which may be unstable.

With Git (recommended)

Open the terminal in your addons folder, then run:

git clone https://github.com/Wolfyxon/GodotTogether.git

Then proceed to the enabling section.

Manual download

1. Download the source code zip.
2. Extract the zip contents into your addons folder.
3. Rename GodotTogether-main to GodotTogether. IMPORTANT!!!

The structure should look like this

yourProject
|_ addons
  |_ GodotTogether
    |_ src
      |_ scripts
      |_ img
      |_ scenes

Enabling

1. Click on Project on the top-left toolbar.
2. Go to Project settings
3. Go to the plugins tab
4. Enable Godot Together

Testing

To run unit tests, enable the plugin, go to settings (inside the plugin) and use run unit tests now or run unit tests on start.

You will see results in the output console.

Writing tests

To create a test:

1. Go to src/scripts/tests.gd.
2. Create a function called test_your_test_name and typehint its return value as bool
3. Return true or false based on if the test failed or succeed, and use printerr to explain details of the error
4. Call it in run_tests using exec_test as seen there.