1. Downloading Bridge CLI (Command Line Interface)

The Odyssey Bridge CLI client currently supports Windows 10 or greater, Linux, and MacOS.

📘
Odyssey Bridge currently only supports Unreal Engine version 5.2.1.

2. Running Bridge CLI

After downloading, you can run the Bridge CLI in two ways:

You can double-click on the binary odyssey-ue-bridge-<platform> file wherever it's located.

Or, run the binary in a command line application:

Start-Process .\odyssey-ue-bridge-win-x64.exe -Wait -NoNewWindow -PassThru

./odyssey-ue-bridge-linux-x64

chmod +x odyssey-ue-bridge-mac-x64
./odyssey-ue-bridge-mac-x64

3. Authenticating your Odyssey account

When you first start up you will be requested to login through your browser and provide the Bridge CLI the permissions required to run.

Following the link will take you to Odyssey, where you'll be required to login if you aren't.

After allowing the Odyssey Bridge permission to access your Odyssey account, you will have a one-time code generated, this is required to continue set up of the Odyssey Bridge CLI client.

After copying your authorization code back into the CLI, the CLI will begin the process of downloading necessary files onto your machine.

4. Adding Bridge plugin to your Unreal project

Before uploading your Unreal project to Odyssey, you'll first have to install the Bridge plugin to your project, and prepare it for upload.

To get started you'll need to tell the Bridge CLI which Unreal project it should install the plugin.

After authentication, and all the Bridge files are fully downloaded onto your machine, you will be prompted to set up a New Project.

🚧
A valid project folder contains a .uproject file.

You'll be prompted to specify the full path to the folder containing your desired project.

You can get the full directory path by opening your file explorer window, navigating to the desired project folder, and then copying the full path in the address bar. On Windows you will need to right click to paste the directory path back into the CLI.

Then select the appropriate .umap file that will represent the starting map for the given deployment.

And finally, select the organization that this project belongs to.

When you have finished setting up your local project, the CLI client will begin the plugin installation process by extracting the Odyssey Plugin into the project directory.

5. Deploying your Unreal project

After you have added the Bridge plugin to your project, perform the tasks in Preparing Your UE5 Project before continuing to deployment.

After you have prepared your Unreal Engine project with the Odyssey Plugin and the various in editor changes, you are ready to begin deployment of your project to Odyssey via the Odyssey Bridge.

Select Publish current project to begin the deployment process.

After selecting the target environment you wish to deploy your project, the Bridge CLI will begin by compressing and uploading your project to Odyssey, triggering the automated steps required to build and deploy your project.

While the Bridge CLI builds and deploys your project, it will update you with what stage the deployment process is at, until it reaches a complete or failure status.

📘
The upload process takes ~15 minutes to complete.