User Guide

Quick Start

How to Load the plug-in

First, install the plug-in correctly into the corresponding Unreal Engine.

Then open your project and load ShowLocalHistory4UE plugin.
img
Restart Unreal Engine

How to Record Version

The plugin will automatically record a current version in the history list when a typed asset file is saved.
img

How to Restore Version

Select the asset you want to restore in the Content Browser, right-click Show Context Menu, click Show Local History.
img

Select the version you want to restore Click on the Restore button img on the right side of the history list.
img

Waiting for recovery to complete.

History List

Comment(v1.4.1)

img

Now you can add a comment to the history. Adding a comment helps you understand the changes in the current version and navigate to them quickly. Just click Input Comment Text and fill in your description.

ContextMenu(v1.4.1)

img

Extract Version

Now you can select the version you want to extract from the history list by clicking the Extract version button in the context menu.

img

When you need to view or keep both the current version and the historical version, you can use this function to remove the historical version. The retrieved historical version will be saved in a folder created in the same directory as the source file.

Delete Version

You can delete historical versions, but be careful! Deleting versions cannot be undone.

img

img

  • menu: contains preferences and user guide.
  • Refresh: Manually refresh the historical list of current assets.

img

  • Settings: Show preferences for plug-ins.
  • Refresh: Same function as shortcut button.
  • User Guide: displaying user documentation.

Settings

img

The Preferences panel can be accessed from the Project Settings menu or the History menu item.

General

Enable Plugin
Activating plug-ins toggles whether plug-ins write a version when saving operations.

Reload List When Selecting A New Asset(v1.4.1)
When an asset is selected after activation, the history list of that asset will be automatically loaded. If you want to manually control the display history list, please select.

Save To

  • Browse: storing historical versions in custom locations.
  • Saved: Store historical versions in the Saved folder of the current project.

When the storage location is selected Browse, the historical version save directory will be displayed, you can click "..." Select a custom location.

Limit Poclicy

A quantity restriction policy is used to restrict the number of versions that are automatically backed up.

Limit Poclicy

  • Disabled: Do not control the number of versions.
  • By Count: Limit Version Quantity.
  • By Date: delete after version creation time expires

Limit Number
Set the maximum number of backup versions per resource when Total Quantity is selected, default is 100.

Limit Days
Set how many days the history version is retained when supermarket deletion mode is selected. Default is 30 days.

Filter

Filters are used to filter which assets can record historical versions.

Backup Asset Types

  • All: Backup All
  • Common: Common types in presets
  • Customn: custom filter type list

When common type filtering is used, the plugin filters the types checked in the types below.
img

When customizing a type filter, the plugin filters by the type entered in the filter list. img