https://github.com/projectborealis/pbsync
System for syncing Unreal Engine project git repositories
https://github.com/projectborealis/pbsync
git hacktoberfest ue4 ue5
Last synced: 6 months ago
JSON representation
System for syncing Unreal Engine project git repositories
- Host: GitHub
- URL: https://github.com/projectborealis/pbsync
- Owner: ProjectBorealis
- License: mit
- Created: 2020-01-11T15:59:56.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2025-02-05T18:26:14.000Z (8 months ago)
- Last Synced: 2025-03-30T19:07:27.484Z (6 months ago)
- Topics: git, hacktoberfest, ue4, ue5
- Language: Python
- Homepage:
- Size: 2.24 MB
- Stars: 84
- Watchers: 7
- Forks: 9
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PBSync
Advanced workspace synchronization tool for Unreal Engine projects hosted on git repositories.
## Development
### Pipenv
Before running any scripts, use `pipenv install` and then `pipenv shell`.
### Dependencies
Run `dependencies.bat` on Windows or `dependencies.sh` on Linux.
### Setup
On Linux, this step can be skipped.
PyInstaller is required for executable generation, and it should be built from source to prevent false positive virus detections of generated PBSync executable.
You can run `install_pyinstaller.bat` to do this automatically.
### Build
#### Windows
To generate a binary file from python source code, just run `build.bat` script. If generation was successful, the binary file will be put inside `dist` folder. To start using, generated executable should be put into root folder of the Unreal Engine project.
#### Linux
On Linux systems, run the `build.sh` script to generate binary file.
But, since most Linux systems come with a version of Python already available, another option is to run it directly:
```
git clone https://github.com/ProjectBorealis/PBSync
PYTHONPATH= python /pbsync/pbsync.py --help
```
### Contribution
Everyone is welcomed to fork the repository, or open pull requests and new issues in this main repository.
## Usage
### Sample usage
You can refer to our [PBCore repo](https://github.com/ProjectBorealis/PBCore) for an example of usage.
Essentially, we use a batch script to sync PBSync with the remote branch, and then launch PBSync (`UpdateProject.bat`). We have our configuration file in `PBSync.xml`.
`PBSync.exe` and `ueversionator.exe` are distributed as part of the repo, at the root game project level.
`.ueversionator` in the repo configures the engine download.
Additional scripts for managing various PBSync functionality can be found in the `Script` folder.
### Available Commands
List of available commands can be printed to console by passing `--help` to generated executable.