Files
UnrealEngineUWP/Engine/Source/Programs/Horde/Docs/Config/UgsMetadataServer.md
ben marsh 9578285edc Horde: Documentation updates.
* Add screenshots and sample code for configuring job parameters.
* Add placeholder files for tutorials.
* Fix markdown linting in most files.

[CL 30893696 by ben marsh in ue5-main branch]
2024-01-25 13:45:53 -05:00

1.2 KiB

Horde > Configuration > UnrealGameSync Metadata Server

UnrealGameSync Metadata Server

UnrealGameSync (UGS) is a tool designed to simplify syncing from Perforce, supporting retrieval of pre-built editor binaries for artists or correctly versioning the local build to allow modifying content for engineers. It acts as a convienient hub for surfacing build health, flagging issues, and scripting common workflow tasks outside the Unreal Editor.

For more information on UGS, see the UE docs site.

Horde includes an updated version of the legacy MetadataServer IIS web-app that ships alongside UGS, which integrates seamlessly with Horde's CI functionality.

Configuration

To configure UnrealGameSync to source data from Horde, add the following lines in the UnrealGameSync.ini config file:

[Default]
ApiUrl=https://{{ horde_server_url }}/ugs

This config file can be in a project-specific location (eg. {{ PROJECT_DIR }}/Build/UnrealGameSync.ini) or in a location that applies to all projects in a stream (eg. {{ ENGINE_DIR }}/Programs/UnrealGameSync/UnrealGameSync.ini).