UI Outline
Documentation for the Osero Suite: Plugin Sync Tool update 1.1 (5.2+)
Last updated
Documentation for the Osero Suite: Plugin Sync Tool update 1.1 (5.2+)
Last updated
Target Project means a project other than the one the Plugin Sync Tool is running in right now.
This Project means the host project that is currently running the Plugin Sync Tool.
Store Page: Opens the Fab Store Page for this tool in your web browser.
Documentation: Opens the documentation page for this tool in your web browser.
Osero Suite Symbol: Opens the Jeren Osero website in your web browser.
Export Project Data: Exports all data in Target Projects to a Json file for backup anbd easy transfer between projects.
Import Project Data: Imports a valid Json file and replaces all the information in Target Projects with the imported data.
Target Projects are Unreal Engine projects other than This Project (the project with the Plugin Sync Tool running).
If there are no Target Projects, the only option here will be to add a new Target Project, and the tool's buttons will be greyed out.
When there are Target Projects, the UI will change to allow editing of one Target Project at a time.
Add new Target Project.
Delete ALL Target Projects.
Insert a new Target Project here.
Duplicate the focused Target Project's data into a new Target Project.
Delete the focused Target project.
Shift this Target Project one place to the left (order to sync when clicking "Sync All").
Shift this Target Project one place to the right (order to sync when clicking "Sync All").
Click any of the Target Projects to see and update their data.
If unticked, the Target Project will be considered "inactive" and will be ignored when clicking "Sync All".
Project Display Name: This is just for your reference only - the tool internally uses indexes, not this name, so it can be anything.
Project Plugin Directory: Path to the project's '/Plugin' folder. Note: For Revision Control to work, This Project has to be under the same Revision Control directory as the Target Project.
Reverse Sync: If ticked, this Target Project will be considered the "This Project" and This Project will be considered the "Target Project" when syncing.
Plugins to Sync: Which plugins in This Project (or the Target Project if Reverse Sync is ticked) that should be synced between the two projects.
Ignore Directories: Directories to ignore when syncing the Plugin(s) between projects.
Ignore File Types: File types to ignore when syncing the Plugin(s) between projects.
Ignore Files: Specific files to ignore when syncing the Plugin(s) between projects.
Force Update: The sync will re-copy EVERYTHING regardless of date-time. If this is ticked off, it will only sync files that have a more recent timestamp than the equivilant file in then Target Project. Note: This can slow down the sync quite significantly, especially if Revision Control is active.
Skip Newer Check: If ticked, the tool will skip the prompt asking whether you want to copy newer files from the target project back to this project. It will just overwite them in the target project with the files from this project (as if No All was pressed). It will still perform a date-time check to filter out unchanged files, however.
Skip Delete Check: If ticked, the tool will skip the prompt asking whether you want to delete files that exist in the target project but not this project. It will just delete them in the target project (as if No All was pressed).
Copy Binaries: If ticked, the files in the /Binaries folder will be copied too.
Fix Plugin Engine Versions: If ticked, all .uplugin files being copied will have their engine version updated to match the Target Project's engine version.
Check Revision Control: If Revision Control is enabled in this project, should it be used for the sync?
Push Binaries (.dll) to Revision Control: If ticked .dll files will also be pushed to Revision Control, otherwise they'll be copied but not pushed.
Push .pdb to Revision Control: If ticked .pdb files will also be pushed to Revision Control, otherwise they'll be copied but not pushed.
Version Number: Shows the tool's current version number.
Sync All: Syncs all active Target Projects with This Project.
Sync "Single Project" Only: Syncs the focused Target Project (at the top of the tool) with This Project.
Sync Single Plugin Menu: For all active Target Projects, sync just the selected plugin with This Project if the Target Project has this plugin set to sync.
If a project is marked as Reverse Sync, then the exact same thing happens, except the Target Project and This Project are swapped.
For each project to sync, find all the relevant files in the .../<Project Name>/Plugins folder.
Compare the timestamp of each file, or if Force Update is ticked on, skip this check.
If the file in the Target Project is older than the matching file in This Project, the file will be overwritten.
If the file in the Target Project does not exist, the file from This Project will be created in the Target Project.
If the file in the Target Project is newer than the file in This Project, the user will be prompted to either copy the file back to This Project, or overwrite the file in the Target Project with the older file from This Project.
If the file exists in the Target Project but does not exist in This Project, the user will be prompted to either copy the file back to This Project, or delete the file in the Target Project.
As the tool runs, it will also perform the appropriate Revision Control actions, depending on your settings.
