Skip to content
mcoms edited this page Aug 10, 2024 · 6 revisions

Features

  • One click git repo sync and editor binaries sync for artists (no VS)
    • Binaries sync is tied to GitHub Releases, but we are open to contributions which add support for other release download platforms
  • Automatic Git, Git LFS and Git Credential Manager version check, with guided install process
  • Automatic editor/VS/Rider launch after sync
  • Automatic trivial Git repo error resolution
  • Diagnostic tools for tech support in the case of rare Git repository errors
  • Custom Unreal Engine build support, through ueversionator
  • Extended ueversionator downloads through longtail, providing fast, chunked and incremental patching downloads of a custom Unreal Engine fork
    • ueversionator provides basic support for any HTTP URL download
    • Also supports Git source repo engines, side by side with installed versions for programmers
  • Automatic UE4 prerequisites install, file association setup (UnrealVersionSelector) after a custom engine update (and for programmers, automatic project file generation)
  • Automatic editor setup of Git plugin, including LFS lock username
  • Automatic editor setup of Project Borealis p4merge integration, for improved visual diffing in Unreal Editor
    • Note: must include p4merge yourself in .github/p4merge/p4merge.exe
    • More information in our gitconfig (p4merge_pb)
  • Support for precaching DDC, in some cases where large maps can crash the editor on some systems
  • Support for workspace clean script
  • Build system support, allows for easy command line access to generating project files, building C++ source, inspecting C++ source with ReSharper, releasing a new binaries version and more. Can be used as a basis for CI automation.
  • Support for uploading game builds to Discord Games (open to Steamworks, itch.io, etc. support being added)
  • Automatic management of read-only status for LFS lockable files, which can get out of sync in Unreal Editor if users use "Make Writable" for temporary changes
    • Also unlocks files which have not been modified
  • Automatic setup of Git maintenance, which includes background fetch and repo optimization
  • Cloud DDC support, which syncs DDC packages and virtual textures from cloud storage

Setup

A full set up guide is coming soon! For now, you can look at the samples listed in our usage section of the readme.

GUI

A PBSync GUI is coming soon! This provides a robust alternative vs. UnrealGameSync.

Clone this wiki locally