{"id":27627221,"url":"https://github.com/treasure-data/td-ue4-sdk","last_synced_at":"2025-04-23T13:53:42.832Z","repository":{"id":15603197,"uuid":"78402065","full_name":"treasure-data/td-ue4-sdk","owner":"treasure-data","description":"Treasure Data Unreal Engine 4 SDK","archived":false,"fork":false,"pushed_at":"2023-09-13T23:25:31.000Z","size":544,"stargazers_count":10,"open_issues_count":1,"forks_count":5,"subscribers_count":79,"default_branch":"master","last_synced_at":"2024-04-10T19:38:20.442Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://docs.treasuredata.com/articles/unreal-engine-sdk","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/treasure-data.png","metadata":{"files":{"readme":"README.md","changelog":"ChangeLog.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null}},"created_at":"2017-01-09T06:54:16.000Z","updated_at":"2024-04-10T19:38:20.443Z","dependencies_parsed_at":"2022-08-25T08:50:35.284Z","dependency_job_id":null,"html_url":"https://github.com/treasure-data/td-ue4-sdk","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/treasure-data%2Ftd-ue4-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/treasure-data%2Ftd-ue4-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/treasure-data%2Ftd-ue4-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/treasure-data%2Ftd-ue4-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/treasure-data","download_url":"https://codeload.github.com/treasure-data/td-ue4-sdk/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250444242,"owners_count":21431612,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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-04-23T13:53:42.209Z","updated_at":"2025-04-23T13:53:42.819Z","avatar_url":"https://github.com/treasure-data.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Treasure Data Analytics Plugin for Unreal Engine 5\n\nThis plugin behaves as an Analytics Provider for Unreal Engine 5.\n\n## Requirements\n\n- Unreal Engine 5.3.0 \n\nFollow the instructions in the link below to get access to UnrealEngine repository:\n\nhttps://github.com/EpicGames/Signup\n\nAfter getting access to the UnrealEngine repository, you should clone it to your local machine.\n\n- [Treasure Data Write-Only API Key](https://console.treasuredata.com/app/users) (Click on User \u003e API Keys)\n\n## Getting Started\n\nThe following document assumes that the current Unreal Engine have been compiled from sources or it have all dependencies so third party plugins can be build.\n\n### Download and place the plugin\n\nGet a copy of the plugin from the main GIT repository:\n\n```\n$ git glone http://github.com/treasure-data/td-ue4-sdk\n```\n\nSwitch to UE-5.3 branch:\n\n```\n$ git checkout UE-5.3\n```\n\nCopy the new __td-ue4-sdk__ to your Engine plugins folder, the target path looks like:\n\n```\nUnrealEngine/Engine/Plugins/td-ue4-sdk\n```\n\u003e Alternative you can copy the plugin content inside your Project Plugin directory, not that this approach don't work on Linux Development environment.\n\n### Build the plugin\n\nFollow the steps in this documentation [UnrealEngine up and running](https://github.com/EpicGames/UnrealEngine#getting-up-and-running) to build the `td-ue4-sdk` plugin\n\n### Enable the Analytics plugins for your project\n\nInside the Unreal Engine 5 Editor, open your project and the _plugins_ window:\n\n- Edit \u003e Plugins\n\nNow enable the two required plugins:\n\n- Blueprints: located at Built-in \u003e Analytics ![](docs/assets/ue4_blueprints_enable.jpg)\n- Treasure Data: located at Installed \u003e Analytics ![](docs/assets/ue4_td_plugin_enable.jpg)\n\n### Configure Project settings\n\nFrom your project directory, open and edit the file _Config/DefaultEngine.ini_ and append the following content at bottom:\n\n```\n[Analytics]\nProviderModuleName=TreasureData\nTDApiKey=TD-WRITE-ONLY-KEY\nTDDatabase=DATABASE_NAME\nTDRegion=[US01,AP01,AP02,AP03,EU01]\nSendInterval=10\n\n[AnalyticsDevelopment]\nProviderModuleName=TreasureData\nTDApiKey=TD-WRITE-ONLY-KEY\nTDDatabase=DATABASE_NAME\nTDRegion=[US01,AP01,AP02,AP03,EU01]\nSendInterval=10\n\n[AnalyticsTest]\nProviderModuleName=TreasureData\nTDApiKey=TD-WRITE-ONLY-KEY\nTDDatabase=DATABASE_NAME\nTDRegion=[US01,AP01,AP02,AP03,EU01]\nSendInterval=10\n```\n\n`TDDatabase` name must be shorter than 120 chars (The actual limitation: the total length of database and table must be shorter than 129 chars).\n\nSave the file and restart Unreal Engine Editor.\n\n### Gather metrics through Blueprints\n\nIn the Editor, click on the Blueprints dropdown menu and click on the _Open Level Blueprint_ option:\n\n![](docs/assets/ue4_editor_001.jpg)\n\nNow in the Event graphs, different events can be connected to Analytics functions, as an example the following image demonstrate how to track the _Session Start_, _Session End_ and _Record Event w/Attributes_ events:\n\n![](docs/assets/ue5_editor_001.png)\n\nAfter a Game starts, the plugin will send the events to Treasure Data.\n\n## Treasure Data\n\nIn order to query the game events, go to the [Treasure Data Console](http://console.treasuredata.com), click on the _Databases_ item (left menu) and open the database used in the game (Config/DefaultEngine.ini \u003e TDDatabase):\n\n![](docs/assets/ue4_td_console_001.jpg)\n\nBy default two tables are created:\n\n- Sessions: start and stop sessions\n- Events: All events with or without attributes.\n\nTo query records just click on any table name and click on the _Query_ top button. By default you can issue a SQL query like:\n\n```\nSELECT * from events;\n```\n\n![](docs/assets/ue4_td_console_002.jpg)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftreasure-data%2Ftd-ue4-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftreasure-data%2Ftd-ue4-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftreasure-data%2Ftd-ue4-sdk/lists"}