I first learned of working with Github with Fall Right for Cave. My programmer Vygan helped set up the repo and provided a helpful document for how to join it. I'll lay out the contents of his guide here, adapted for more general use!

This guide does not also apply to Github, it can work with Bitbucket and other similar places to host repositories.

Before we jump in, I'd like to explain a bit about Github. I am not a programmer myself, but it is an extremely useful tool for collaboration. While using Github for Ren'Py, you can work on the game and make changes for everyone else to see.

The branch 'Android' and the changes from the Main branch.

<aside> ✅ Pros

</aside>

• You can work in real-time on the project and have other people work on it alongside you.
• If there's something you need to bring back, you can bring back changes by reverting to a previous commit.

<aside> ⛔ Cons

</aside>

• Merging branches can be stressful and cause some conflicts if you're not familiar with using either Git or Ren'Py.
• Git is not really designed for large file uploads, so it can be a struggle to upload a lot of media files.

Joining the Repo

To join the repo, create an account on Github.com (or Bitbucket, etc) and send your email or username to the owner of the repository.

Setting up Github Desktop

Download Github Desktop, Sourcetree, Gitkraken / Axosoft or similar programs. Github Desktop was what Vygan used, I used Gitkraken / Axosoft from working with FallRight.

Log in with your relevant account. To add the repo, it is usually done with a feature like this:

Current Repository > Add > Clone Repository > [URL of repository]

Click on 'Clone' and you can name the folder in the local path appropriately.

You can also do it on Github. Click on the green button called:

Code > Open with GitHub Desktop > Clone

It will ask where to place the files, this is up to you. Vygan has a special "Code" folder with a "Git" map, which he recommends doing as well.

How to work with Github Desktop

In the top left corner, you can see your current repository.

Right from the current repo, you can see you will be on the current branch, likely the main branch.