Collaborate with GitHub

You work on your computer. GitHub stores the shared version online. Save writes locally. Compare with team checks and incorporates team changes. Send to GitHub shares your prepared version. You can write offline and share your work later.

Before you begin

1. Create a free account at github.com. Each teammate uses their own account.
2. Install Git from git-scm.com/downloads if it is not already installed, then restart VNLE.
3. For a private story, create a private repository. This repository holds your story. Keep the public wiki in a different repository.

1 · Sign in to GitHub from VNLE

1. Click the project name at the top left and choose Set up team or the current team status. Choose Sign in with GitHub.
2. VNLE displays a short code and opens GitHub in your browser. Sign in there, enter the code and approve the sign-in.
3. Return to VNLE. Your account name appears after confirmation. You do not enter your password in VNLE.
4. Open the repository access link. Choose Only select repositories and select your story. Confirm Install or Save, then refresh the repository list in VNLE.

2 · Publish a new team project

1. On GitHub, choose + → New repository at the top right. Enter a name such as harbour-story and choose Private. Leave README, .gitignore and License empty for this new repository. Click Create repository.
2. In VNLE, select the repository from the list or paste its address into GitHub Repository.
3. Enter the name and email to associate with your versions. You can use your noreply address from GitHub → Settings → Emails. Click Connect locally.
4. Briefly describe your changes. Choose Compare with team. VNLE saves, creates a local version and checks the team version. Then click Send to GitHub to share your work.
5. Open the repository in your browser and check that project.vnle.json and the project folders appear. Invite teammates under Settings → Collaborators.

3 · Join an existing project

1. Accept the GitHub invitation. Install GitHub Desktop from desktop.github.com and sign in.
2. Choose File → Clone repository, select the team repository and an empty destination folder, then click Clone. This creates your local working copy.
3. Open that folder in VNLE with Open project. Sign in to GitHub through the team entry in the project menu and check repository access.
4. Sync before editing. Work on your scene, compare again when finished, then choose Send to GitHub.

Understand the status

Set up team means setup is incomplete. Not sent yet means local work is waiting to upload. Team updates available means teammates have uploaded changes. Up to date means everything matched at the last check. Status not checked means GitHub could not be checked, for example while offline. VNLE checks configured projects roughly every two minutes.

When you both changed the same content

1. Choose Compare with team. Independent changes are combined. If the same content was changed differently, VNLE shows a review.
2. Compare Your version and Team version. Choose the version to keep for each affected item.
3. Click Validate choices and sync. VNLE checks the combined project before replacing your working version. Then choose Compare with team again, followed by Send to GitHub.
4. If unsure, choose Decide later and discuss the content with your team. Your saved work is retained.

Agree on who edits each scene where possible. Also coordinate changes to shared characters, variables and translations. Applying a new team version reloads the project and ends the current preview and undo session.

If syncing fails

First check your internet connection. Sign in again if your authorization has expired. Check that the VNLE app has access to this specific repository and your account has write permission. If the team version changed while you were reviewing, fetch it again and repeat the sync. Keep your project folder when troubleshooting.