Guide:Using Github

For an introduction including key terms, check source control.

Git, Github, and Source Control are different. Git is a tool used for source control (managing code), but other tools exists. Github is a service that host software that uses Git. But it is possible to use Git without Github.

This page focus on using Github because it's free and accessible. However, it should be kept in mind that it has drawbacks, but that doesn't mean you can't use Git. There's others ways to use Git, and it's key to manage your coding project successfully, especially when working with others.

Why shouldn't I use Github?

Github is owned by Microsoft, and all of the code and assets that are uploaded on Github, ie, on Microsoft's servers, are subject to their Terms of Service. In particular, for VNDevs, the main things to consider are:

• No NSFW Content.
• The service could be shutdown at any time. Don't use Github as a form of backup.
• Certain options, like extra storage for big files (GitLFS) are paid. But aren't needed for beginners.
• The ties with Copilot, Microsoft AI/LLM service, has been controversial. Github claims to not scan private repositories to train Copilot, but use this information at your best judgement.

Aside from that, Github is one of the most used and fully fleshed online Git service, aside from Gitlab. If you consider the above as acceptable, it's really worth considering using.

Getting started guide

Similar information & additional details are available in this Intro to Git for Ren'Py tutorial from Anigrams Productions.

Do it once

You can use GitHub either with the Command Line Interface (CLI) or GitHub Desktop. Installing GitHub Desktop also installs Git for the CLI. Another option is to use the integrated Git extension inside Visual Studio Code (Assuming it's already your IDE/Coding software of choice).

Git CLI

1. Create a GitHub account here
2. Install Git here
3. Set your GitHub username and email on the CLI (refer here and here)
4. Create a personal access token, set it to never expire and save it somewhere (steps here)

GitHub desktop

1. Create a GitHub account here
2. Install GitHub Desktop here
3. Authenticate your GitHub account (check here)

New game setup

With every new game.

Git CLI

1. Create a new repository on GitHub (steps here)
2. Google for the gitignore file of your game engine (here's renpy)
3. Add the .gitignore file in the repository and commit on GitHub (refer here)
4. Clone the repository to your computer (steps here)
5. Add your game files to the repository and commit in CLI

git commit -m "add game files !"

6. To update the repository on GitHub, push in CLI (enter your token when asked for password)

git push

7. Happy jamming!

GitHub Desktop

1. Create a new repository on GitHub (steps here)
2. Google for the gitignore file of your game engine (here's renpy)
3. Add the .gitignore file in the repository and commit on GitHub (refer here)
4. Clone the repository to your computer (refer here)
5. Add your game files to the repository and commit in GitHub Desktop (check here)
6. To update the repository on GitHub, push origin in GitHub Desktop (refer here)
7. Happy jamming!

For more references on getting started with GitHub, here's the official docs.