Repository Browser
- This is the tool that the artists use to get art from the Art Server to the Repository. For the part of HeroBlade that game designers use to get art from the Repository for the game world, see Repository File Selector.
The Repository Browser is a separate client from HeroBlade. It is a tool that is used to move game content, such as art assets, from a local storage space such as your own computer or a network or the Art Server, to the live development environment so that HeroEngine can read it.
NOTE: For information on the previous version of the Repository Browser, please refer to Repository Browser 2.0
Contents |
Types of Art Handled
It is most commonly used to manage art assets, meaning anything generated by an artist, such as Assets, Animations, and Textures.
It can also be used for other things such as Effect shaders and Keybinding files.
GUIXML files can be edited and new versions uploaded with the Repository Browser, but it is recommended to use the HSE2 Script Editor instead.
NOTE: Uploading of .gr2 files is no longer supported in HeroEngine versions later than 2.0
Installation
The Repository Browser is available on the [downloads page].
Launching the Repository Browser
Locate the Repository Browser icon on your Start page, or in the list of installer applications.
Enter your HeroEngine account name and password, then click "Log On".
In the Worlds menu, select the desired world (such as "Dev" or whatever your world has been named), and click "Enter World".
By default the Repository Browser will allow you upload, view, or delete files to the remote server repository, and download copies of those files to the local file system for editing and viewing.
Alternatively, the Repository Browser can operate in "LRC Mode" which allows you to manually populate part or all of the Local Repository Cache (LRC). In older versions of the Repository Browser LRC Mode and file mode were integrated together. However, for performance and usability reasons, they have been separated into distinct user interfaces.
Uploading and Downloading Assets
Once an asset has been uploaded to the remote repository, it's available to add, view, and manipulate in the HeroEngine.
Starting at the top of the Repository Browser interface and moving counter clockwise, the following options and interface elements are available:
- Connect
- Disconnects the current session, and allows you to log into another world, or switch modes
- About
- Displays the current version information
- Enable Lockstep / Set Local Directory / Set Repository Directory
- When uploading, downloading, or validating a large number of assets in a predetermined directory structure, it's often helpful to ensure that both the local and remote directories are synchronized to each other. By selecting a directory in the Local File System window, and a directory in the remote Repository, the Enable Lockstep button will keep the displayed directories synchronized to each other. It will not proactively transfer or update files; that is left to the user.
- Local File System
- Allows the user to browse all locally connected drives
- Local File System Context Menus
- Right clicking on a directory or file provides the following options
- Upload Uploads the file; or the directory and its contents to the selected remote repository directory, replacing files or creating directories as necessary
- Open Opens the file using the default viewer
- Open With... Opens the file, prompting the user to select a viewer
- Explore Opens the Windows Explorer at the directory location
- Show Deleted
- This option displays previously deleted remote repository files and directories in red, and allows them to be restored for use
- Remote Repository Directory Context Menu
- Right clicking on a directory provides the following options
- Create Subdirectory Prompts the user to create a new named subdirectory under the selected directory
- Delete Prompts the user to delete the selected directory
- Distribution Package... Prompts the user to specify a distribution package for the selected directory
- Restore Allows a deleted asset to be restored
- Download Downloads the selected directory to the selected local file system directory
- Remote Repository File Context Menu
- Right clicking on a file provides the following options
- Open Downloads and opens the file using the default viewer
- Open With... Downloads and opens the file, prompting the user to select a viewer
- Save As... Downloads the file and prompts the user to specify an alternative filename or directory to save it as
- Delete Prompts the user to delete the selected asset
- Distribution Package... Prompts the user to specify a distribution package for the selected asset
- Named Package Groups... Prompts the user to specify a named package group for the selected asset
- View History... Displays the history of an asset, and allows the older versions to be viewed or restored
- Restore Allows a deleted asset to be restored
- Download Downloads the selected file to the selected local file system directory
- Console window
- Displays informational messages about the operation of the Repository Browser
- Errors window
- Displays error and warning messages about the operation of the Repository Browser
- File Transfers display (right panel)
- Displays the files and directories that are, or will be, or have been uploaded or downloaded
- The user can control the maximum number of of uploads and downloads using the sliders at the top
- Right click context menu allows the user to clear completed transfers, or copy data to the clipboard
Dragging & Dropping Assets
Beside using the upload and download context menu options, individual assets and directories may be copied using Windows drag & drop. The following drag & drop operations are supported.
- Drag files or directories from the Local File System to the Remote Repository, or the Local File System itself
- Drag files or directories from the Remote Repository to the Local File System
- Drag files or directories from Windows Explorer (or any filedrop supporting application) to either the Remote Repository, or the Local File System
For performance reasons, dragging files from the Remote Repository to Windows Explorer directly is not supported. Instead, drag the files to the desired location in the Local File System window
Local Repository Cache Population Mode (LRC Mode)
LRC Mode is enabled by selecting the "LRC Mode" checkbox on the login interface. This mode allows the user to manually populate part or all of the [[Local Repository Cache|Local Repository Cache (LRC)]. In older versions of the Repository Browser LRC Mode and file mode were integrated together. However, for performance and usability reasons, they have been separated into distinct user interfaces.
This simplified interface removes the local file system window and associated controls and functionality.
Right clicking on a directory or file allows the user to download the asset(s) to the LRC.
See also
- Art Pipeline
- Repository File Selector (for the game designers' counterpart to the Repository Browser)
- Hero Export Guide
- Creating textures
- Current Exporter Package
- Populating the local repository cache
