Skip to content

About

No description or website provided.

Topics

Resources

Stars

3 stars

Watchers

4 watching

Forks

Latest commit

 

History

7 Commits

Folders and files

Repository files navigation

git-along-unreal

An Unreal Engine revision control plugin that integrates Git Along to prevent conflicts when working with a team.

It is built on top of the UEGitPlugin written by Sébastien Rombauts and is distributed under the same MIT license.

Pre-requisites

Installation

The recommended way to install this plugin is to submodule this repository inside the Plugins folder of a code project.

git submodule add https://github.com/douglaslassance/git-along-unreal Plugins/GitAlong

The plugin replaces the Git plugin that ships with the engine for that project.

Important

We currently don't provide a built version of the plugin therefore non-code projects will not be able to use the plugin without extra work on your part.

Repository setup

Every clone of the repository needs to be set up for Git Along. Tracking uncommitted changes is what lets checkouts reach the rest of the team, so it is strongly recommended.

git along setup --track-uncommitted --update-hooks --tracked-extensions .uasset,.umap

Add --modify-permissions to keep files read-only until they are checked out. Refer to the Git Along documentation for the available stores.

Usage

Pick Git Along as the provider in the editor revision control settings. The plugin finds git and git-along in the usual install locations and on the PATH, and both paths can be overridden there.

  • Checking out a file claims it with git along claim. The claim is refused when someone else is changing the file.
  • Files claimed in another clone, committed but not pushed, or changed on another branch show as checked out by someone else.
  • Files changed on the remote branch show as not current until synced.
  • Reverting a file releases its claim, and pushing releases the files of the pushed commits.

You should be able to submit, revert, sync and push using the editor or any Git interface interchangeably.

Without --track-uncommitted the plugin behaves like the plain Git plugin, where every tracked file is editable, but still reports the changes of other clones.

License

MIT

About

No description or website provided.

Topics

Resources

Stars

3 stars

Watchers

4 watching

Forks

Releases

Sponsor this project

Contributors

Languages