{"id":31841912,"url":"https://github.com/ir-engine/ir-engine-bridge-unreal","last_synced_at":"2026-02-16T08:07:12.218Z","repository":{"id":43253125,"uuid":"468922870","full_name":"ir-engine/ir-engine-bridge-unreal","owner":"ir-engine","description":" Unreal Engine to Ethereal Engine Backend Bridge","archived":false,"fork":false,"pushed_at":"2023-08-04T23:35:29.000Z","size":515,"stargazers_count":12,"open_issues_count":3,"forks_count":6,"subscribers_count":11,"default_branch":"main","last_synced_at":"2025-10-27T06:28:45.197Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ir-engine.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2022-03-11T22:56:02.000Z","updated_at":"2025-05-21T16:20:03.000Z","dependencies_parsed_at":"2022-09-03T01:22:52.167Z","dependency_job_id":"aa7cb822-09fb-4eb5-bbce-dba1800b2048","html_url":"https://github.com/ir-engine/ir-engine-bridge-unreal","commit_stats":{"total_commits":22,"total_committers":3,"mean_commits":7.333333333333333,"dds":0.09090909090909094,"last_synced_commit":"a81827b0909019d13fe13a3e62df2d92b0fbb1bb"},"previous_names":["ir-engine/ir-engine-bridge-unreal"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ir-engine/ir-engine-bridge-unreal","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ir-engine%2Fir-engine-bridge-unreal","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ir-engine%2Fir-engine-bridge-unreal/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ir-engine%2Fir-engine-bridge-unreal/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ir-engine%2Fir-engine-bridge-unreal/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ir-engine","download_url":"https://codeload.github.com/ir-engine/ir-engine-bridge-unreal/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ir-engine%2Fir-engine-bridge-unreal/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29503193,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-16T05:57:17.024Z","status":"ssl_error","status_checked_at":"2026-02-16T05:56:49.929Z","response_time":115,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-10-12T05:55:19.997Z","updated_at":"2026-02-16T08:07:12.214Z","avatar_url":"https://github.com/ir-engine.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Ethereal Engine Bridge - Unreal\n\nINTRO VIDEO\n\n[![Watch the video](https://img.youtube.com/vi/GbOpJRxkux8/default.jpg)](https://youtu.be/GbOpJRxkux8)\n\nhttps://www.youtube.com/watch?v=GbOpJRxkux8/\n\nUnreal SDK XREngine Alpha\n- User Management API\n- Server Party Matchmaker\n- Unreal Game Server Lifecycle System\n- Unreal Blueprints XREngine SDK\n\nCMS and marketplace services coming soon\n\nEXAMPLE https://github.com/XRFoundation/XREngine-Bridge-Unreal-Example\n\n![Screenshot 2022-06-06 193750](https://user-images.githubusercontent.com/5104160/172299848-3e1c6a5f-ecd2-4562-a894-0d8b55e5b9e5.png)\n\n## Setup\n\nThis guide assumes you have a working linux dedicated server build of you game.\n- https://docs.unrealengine.com/4.27/en-US/InteractiveExperiences/Networking/HowTo/DedicatedServers/\n- old guides \n   - https://michaeljcole.github.io/wiki.unrealengine.com/Dedicated_Server_Guide_(Windows_\u0026_Linux)/\n   - https://medium.com/swlh/building-and-hosting-an-unreal-engine-dedicated-server-with-aws-and-docker-75317780c567\n\nPreinstall Requirements\n- VaRest https://github.com/ufna/VaRest\n   - https://www.notion.so/VaRest-UE4-Plugin-40b98c54fc184033b60a42e0e4753536\n   - VaREST Tuturials https://www.youtube.com/watch?v=B90jnsEJ6E0\n- Agones SDK w/ Unreal tools https://agones.dev/site/docs/guides/client-sdks/unreal/\n\n### Containerizaiton details\n\n- https://unrealcontainers.com/docs/use-cases/dedicated-servers\n- https://unrealcontainers.com/docs/use-cases/linux-installed-builds\n- killer advanced use https://unrealcontainers.com/docs/use-cases/pixel-streaming\n- killer advanced use https://unrealcontainers.com/docs/use-cases/continuous-integration\n- killer advanced use https://unrealcontainers.com/docs/use-cases/linux-sandboxed-editor\n\n## Configuring gameserver\n\nregister a process with ENV VARS or Unreal executable arguments\n\nhttps://docs.unrealengine.com/4.26/en-US/ProductionPipelines/CommandLineArguments/\n\n```\nTroveServer.exe IslandLobby.uproject /Trove/Maps/Island1?game=MyGameInfo?listen -lobbygame -server 127.0.0.1\nTroveServer.exe IsleOfDeath.uproject /Trove/Maps/IsleOfDeathStart?game=MyGameInfo?listen -stakedgame -server 127.0.0.1\n```\n\n## VaREST and wrapping the XREngine Web API \n\nknowledge required: Learn REST APIs, OpenAPI, Header based http auth, Verbs:Get/Post/etc, paylods, json\n\n![image](https://user-images.githubusercontent.com/5104160/172028597-08e4c4cc-973b-4e4a-924a-1f508dfb4711.png)\n\nTargeting support for 4.26 and 4.27\n\nTrial implementations on epic games unreal examples for the XREngine bridge for Unreal\n\nhttps://github.com/XRFoundation/XRE-Bridge-Unreal/\n\nThis bridge is wrapping OpenAPI endpoints presented by XREngine \n\nhttps://api-dev.theoverlay.io/openapi/\n\nThis first requires a generated bearer token for API autorization. OAuth API app digestion with socpes is coming soon!\n\nThis can be found in the EnvVars of the XREngine cluster and in the XRE SQL Database\n\n\u003cimg width=\"1189\" alt=\"Screen Shot 2022-06-04 at 4 25 43 PM\" src=\"https://user-images.githubusercontent.com/5104160/172028647-084f7aa0-d358-4b15-b6be-5788ee7d7ec4.png\"\u003e\n\nBlueprints multiplayer Unreal reference\n\nhttps://docs.unrealengine.com/4.27/en-US/InteractiveExperiences/Networking/Blueprints/\n\nAll K8 control plane systems can be access via rest calls to the local network of the gameserver, the functionality of Agones can be done via adding a node in Blueprints.\n\nThe XREngine matchmaker service exposes the default endopints for open match. \n\nhttps://github.com/XRFoundation/XREngine/blob/dev/packages/ops/open-match/templates/01-open-match-core.yaml\nhttps://github.com/XRFoundation/XREngine/blob/dev/packages/ops/open-match/templates/07-open-match-default-evaluator.yaml\n\nREST API local call access docs\n\nhttps://open-match.dev/site/docs/guides/access/\n\nThis is a ticketing system to be placed into a lobby group and then into a gameserver. XREngine has API call examples of this\n\nMatch User Relation\n\nhttps://github.com/XRFoundation/XREngine/blob/dev/packages/server-core/src/matchmaking/match-user/match-user.class.ts\n\n#### Open Match Endpoint Reference\n\nMatch the ticket for an assignment\n\nhttps://github.com/XRFoundation/XREngine/blob/dev/packages/server-core/src/matchmaking/match-ticket/match-ticket.class.ts\n\nMatch Gameserver Instance Relation\n\nhttps://github.com/XRFoundation/XREngine/blob/dev/packages/server-core/src/matchmaking/match-instance/match-instance.class.ts\n\nGet a ticket for assignment to a gameserver instance\n\nhttps://github.com/XRFoundation/XREngine/blob/dev/packages/server-core/src/matchmaking/match-ticket-assignment/match-ticket-assignment.class.ts\n\n\n\n\nAgones Actions\n\n![unreal_bp_actions](https://user-images.githubusercontent.com/5104160/172027649-676723a1-a5d1-46f0-9406-eb2aa429cf18.png)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fir-engine%2Fir-engine-bridge-unreal","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fir-engine%2Fir-engine-bridge-unreal","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fir-engine%2Fir-engine-bridge-unreal/lists"}