Consequence Client Installation

Downloading and installing Consequence Client

While logged in as the primary project administrator, use the download link from within Consequence's Settings page to download the Consequence Client as a Docker image.

Configuring Consequence Client

  • For running using a Linux Docker image, a sample docker-compose.yml file is provided below, which should be configured with your installation-specific settings.
  • You should replace [Project] throughout with the name of your Unreal Engine project directory.
  • [DOCKER_HOST_PERSISTENT_P4_WORKSPACE_LOCATION] should be replaced with a permanent Docker volume location containing your Perforce workspace, onto which your Docker image must be able to sync the Perforce files it needs.
  • [DOCKER_HOST_PERSISTENT_AUDIOSTATS_DATA_CACHE_LOCATION] should be replaced with a permanent Docker volume location for use in caching audio data.
services:
  app:
    image: consequence-client-debian:[VersionNumber]
    container_name: consequence-client
    environment:
      - [email protected]
      - CONSEQUENCE_CLIENT_PASSWORD=MyTerriblePassword!*1234
      - CONSEQUENCE_CLIENT_PROJECT=my_consequence_project_name
      - CONSEQUENCE_CLIENT_SUBMISSION_DIRECTORY_PERFORCE=//depot/[Project]/Consequence/
      - CONSEQUENCE_CLIENT_SUBMISSION_DIRECTORY=/Workspace/[Project]/Consequence/
      - CONSEQUENCE_CLIENT_FACTS_TAG_DIRECTORY_PERFORCE=//depot/[Project]/Config/
      - CONSEQUENCE_CLIENT_FACTS_TAG_DIRECTORY=/Workspace/[Project]/Config/
      - CONSEQUENCE_CLIENT_AUDIO_DIRECTORY_PERFORCE=//depot/[Project]/Wwise/[ProjectName]_WwiseProject/Originals/Voices/English(US)/
      - CONSEQUENCE_CLIENT_AUDIO_DIRECTORY=/Workspace/[Project]/Wwise/[ProjectName]_WwiseProject/Originals/Voices/English(US)/
      - CONSEQUENCE_CLIENT_TTS_DIRECTORY_PERFORCE=//depot/{{ProjectName}}/Wwise/{{ProjectName}}_WwiseProject/Originals/Voices/English(US)/TTS/
      - CONSEQUENCE_CLIENT_TTS_DIRECTORY=/Workspace/{{ProjectName}}/Wwise/{{ProjectName}}_WwiseProject/Originals/Voices/English(US)/TTS/
      - CONSEQUENCE_CLIENT_DOMAIN=consequence.app
      - CONSEQUENCE_CLIENT_SUBMIT_PREFIX=# Consequence Client\r\n-
      - CONSEQUENCE_CLIENT_DO_PERFORCE_LOGIN=true
      - CONSEQUENCE_CLIENT_API_TTS=tts_elevenlabs
      - CONSEQUENCE_CLIENT_API_VAR_1_tts_elevenlabs=someAPIKey
      - CONSEQUENCE_CLIENT_API_VAR_2_tts_elevenlabs=eleven_multilingual_v2
      - P4USER=MyUserName
      - P4PASSWD=MyTerriblePassword!*1234
      - P4CLIENT=AWorkspaceName
      - P4PORT=ServerHost:1666
    volumes:
      - /[DOCKER_HOST_PERSISTENT_P4_WORKSPACE_LOCATION]:/Workspace
      - /[DOCKER_HOST_PERSISTENT_AUDIOSTATS_DATA_CACHE_LOCATION]:/Data
    restart: always

Review the sections below for information on what every setting does.

Required Environment Variables
Environment Variable Name Description Example
CONSEQUENCE_CLIENT_EMAIL The email address for your ConsequenceClient user [email protected]
CONSEQUENCE_CLIENT_PASSWORD The password for your ConsequenceClient user MyTerriblePassword!*1234
CONSEQUENCE_CLIENT_PROJECT The login name of your Project at Consequence.app on the Login page my_consequence_project_name
CONSEQUENCE_CLIENT_PERFORCE_DEPOT_DIRECTORY_PERFORCE The root depot in Perforce //depot/
CONSEQUENCE_CLIENT_SUBMISSION_DIRECTORY_PERFORCE The Consequence submission file's directory in your Perforce depot //depot/[Project]/Consequence/
CONSEQUENCE_CLIENT_SUBMISSION_DIRECTORY The same directory on your local disk C:\[PerforceWorkspace]\[Project]\Consequence\
CONSEQUENCE_CLIENT_FACTS_TAG_DIRECTORY_PERFORCE The DefaultGameplayTags.ini file's directory in your Perforce depot //depot/[Project]/Config/
CONSEQUENCE_CLIENT_FACTS_TAG_DIRECTORY The same directory on your local disk C:\[PerforceWorkspace]\[Project]\Config\
CONSEQUENCE_CLIENT_AUDIO_DIRECTORY_PERFORCE Perforce depot directory all English .wav files are under //depot/[Project]/Wwise/[ProjectName]_WwiseProject/Originals/Voices/English(US)/
CONSEQUENCE_CLIENT_AUDIO_DIRECTORY The same directory on your local disk C:\[PerforceWorkspace]\[Project]\Wwise\[ProjectName]_WwiseProject\Originals\Voices\English(US)\
Optional Environment Variables
Environment Variable Name Description Example
CONSEQUENCE_CLIENT_DOMAIN The domain name of your Consequence app Usually consequence.app, but can be a custom subdomain for Enterprise projects
CONSEQUENCE_CLIENT_SUBMIT_PREFIX Text prefix for all Perforce checkins from Consequence Client. Default: # Consequence Client\r\n-
CONSEQUENCE_CLIENT_DOCKER Whether the Client is running in a Docker container. Must be set true for Docker containers to properly write to the persistent bound /Data/ volume. Default: false
CONSEQUENCE_CLIENT_TTS_DIRECTORY_PERFORCE Perforce path: enables TTS (text-to-speech) .wav files to be submitted to an intermediate directory other than your Wwise Originals directory. Default: //depot/[ProjectName]/Wwise/[ProjectName]_WwiseProject/Originals/Voices/English(US)/TTS/
CONSEQUENCE_CLIENT_TTS_DIRECTORY Local file path: enables TTS (text-to-speech) .wav files to be submitted to an intermediate directory other than your Wwise Originals directory. Default: /Workspace/[ProjectName]/Wwise/[ProjectName]_WwiseProject/Originals/Voices/English(US)/TTS/
Text-To-Speech API Variables

Three Text-To-Speech APIs are supported, and more are added on request. The currently supported APIs are ElevenLabs, Azure Speech, and Amazon Polly.

Environment Variable Name Description Example
CONSEQUENCE_CLIENT_API_TTS The TTS API you are using. Example: tts_elevenlabs or tts_azure or tts_aws_polly
CONSEQUENCE_CLIENT_API_VAR_1_[TTS name, e.g. tts_elevenlabs] Used for the API key for the relevant service. For Polly, this is the Access Key ID. Example: someAPIKey
CONSEQUENCE_CLIENT_API_VAR_2_[TTS name, e.g. tts_elevenlabs] Used for additional parameters needed for the TTS library. For ElevenLabs, this is the model ID. For Azure, this is the region. For Polly, this is the Secret Access Key. Examples: eleven_multilingual_v2
CONSEQUENCE_CLIENT_API_VAR_3_[TTS name, e.g. tts_elevenlabs] Used for additional parameters needed for the TTS library. For ElevenLabs, this is not needed. For Azure, this is the optional format. For Polly, this is the region. Examples: riff-16khz-16bit-mono-pcm or us-east-1
Perforce Environment Variables

Note: if running in a Docker container or an environment where "p4 set" has not been used to set your Perforce configuration, you should also be sure to set the P4USER, P4PASSWD, P4CLIENT, and P4PORT environment variables so that Perforce can connect, sync, and submit files.

Environment Variable Name Description Example
P4USER The Perforce username under whose credentials Consequence Client will be syncing and submitting files. MyUserName
P4PASSWD The Perforce password for that user. MyTerriblePassword!*1234
P4CLIENT The name of the Perforce Workspace that has been set up for this user to use on this machine. AWorkspaceName
P4PORT The hostname and port combination to connect to the perforce server ServerHost:1666