How to share Godot Project using Github?

:information_source: Attention Topic was automatically imported from the old Question2Answer platform.
:bust_in_silhouette: Asked By Malthur123

Hey Everyone,

A friend of me and I recently started using Godot to make our first game. We set up a Github Repository so we both can work on the project. In the beginning it was only me working on the project and commiting and pushing to Github as usual.
Now after I did some work, my friend wanted to have a look at what I had done. When he tried to open the project, the following errors showed up:

Sorry for bad image quality.
We are unsure how to fix this. We are both using GitHub Desktop as client.
Does anyone know what’s the problem here? The resources that cannot be loaded are available in the folders in the Github Repository.

Thank you all for any advice in advance!

Best
Malthur123

In that photo, are you using just the command line, or can you access a desktop environment?

Ertain | 2020-08-17 19:28

We are using normal Windows 10 PCs and open Godot via Desktop Shortcut. This is just the console that opens with Godot every time we start it and that’s what it showed when my friend tried to open our project.
I hope that clarifies? Let me know if you need to know more!

Malthur123 | 2020-08-17 20:40

:bust_in_silhouette: Reply From: Amateur.game.dev.

***ANSWER DELETED***

:bust_in_silhouette: Reply From: JimArtificer

You need to eliminate variables that may be different between the two machines. Steps to troubleshoot this problem:

  1. Confirm that both you and your friend are using the same version of Godot (including if it is the mono version or not).
  2. Confirm that your friend has MSBuild installed if you are using C#.
  3. Clone your existing repository into a new folder on your machine and try to run it. If you forgot to include some important files in the repo you will encounter the same problem.

This should eliminate the 3 most likely collaboration problems. I suggest following these steps before looking at the log in detail because they will help you solve future problems too.

Next, double-check that you committed Map.tscn and tilemap.png to your project.

Hey,

Thank you very much for your reply. My friend and I went through the steps you posted. We both do have exactly the same version of Godot now. We checked the first line in the console when opening Godot and they show exactly the same thing.
We are not using C# but GDScript.
I downloaded the zip file of our project from Github and tried opening the extracted files with Godot.
When trying for the first time, Godot opened normally without any errors logged in the console, however, once in the engine, the project could not be loaded completely. While trying to (re)-import the assets, it got stuck at 83% when trying to import the Godot icon asset:

It was just loading forever at this point. When closing Godot and trying again, I did not even get that far, but Godot just froze when in the splashscreen.

This is now exactly the same behavior for my friend and me, using the file from Github.

I also checked the files at Github and the two files you mentioned are both there:


What should we try next? Thank you all for your help! Let us know if you need more info.

Best,
Malthur123

Malthur123 | 2020-08-18 09:58

The next step I would suggest is to try to narrow down if this specific project is the problem. Make a new, minimal, project that includes some of the elements of your main project. For example, some imported .png files and a simple script.

Create a new repo and share the new project with your friend. If you encounter the same problem sharing it via Github, try simply zipping up the directory and sending that file directly.

JimArtificer | 2020-08-18 23:11

Little follow up to this one:

We continue to have problems sharing our project via github. It more and more feels like there is some issue with imported assets. In our case the stock icon file which comes as base in every project seems to cause a lot of trouble. If the icon.png file is not in the repository, Godot freezes in the splash screen.
This is also the case if the icon.png and icon.import file are in the folder.

If only the png file is in the folder, Godot creates the relevant import file after the splash screen and shows the (Re)Importing Assets progress bar, which just freezes everything at this point.

As gitignore file, we use the standard Godot template from Github.

Any other ideas how we can fix this? It is causing a lot of disruption.

Malthur123 | 2020-08-24 19:52

I’m sure you’ve already figured it out, but I’ll tell you that the icon must not be saved in png (but it is necessary to keep it in png) because Godot cannot use png as ico, I had the same problem before.

Foxboiii96 | 2023-01-19 21:26