{"id":21712495,"url":"https://github.com/ornstein89/open3de-extsimint-gem","last_synced_at":"2025-10-28T15:14:55.363Z","repository":{"id":251419298,"uuid":"837289781","full_name":"Ornstein89/Open3DE-ExtSimInt-Gem","owner":"Ornstein89","description":"Open3D engine gem providing integration with external simulation model: video output to external model and motion input from external model","archived":false,"fork":false,"pushed_at":"2024-08-28T10:29:02.000Z","size":31558,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-25T17:11:27.011Z","etag":null,"topics":["gem","ipc","modeling","o3de","open3d-engine","open3de","simulation"],"latest_commit_sha":null,"homepage":"","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Ornstein89.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,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-08-02T16:10:06.000Z","updated_at":"2024-08-28T10:29:05.000Z","dependencies_parsed_at":"2024-08-28T11:44:50.612Z","dependency_job_id":null,"html_url":"https://github.com/Ornstein89/Open3DE-ExtSimInt-Gem","commit_stats":null,"previous_names":["ornstein89/open3de-extsimint-gem"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ornstein89%2FOpen3DE-ExtSimInt-Gem","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ornstein89%2FOpen3DE-ExtSimInt-Gem/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ornstein89%2FOpen3DE-ExtSimInt-Gem/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ornstein89%2FOpen3DE-ExtSimInt-Gem/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Ornstein89","download_url":"https://codeload.github.com/Ornstein89/Open3DE-ExtSimInt-Gem/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244668445,"owners_count":20490619,"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":["gem","ipc","modeling","o3de","open3d-engine","open3de","simulation"],"created_at":"2024-11-25T23:39:24.839Z","updated_at":"2025-10-28T15:14:55.271Z","avatar_url":"https://github.com/Ornstein89.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Open3DE-ExtSimInt-Gem \u003c!-- omit from toc --\u003e\n\n![logo](logo.png)\n\nOpen3D Engine gem providing interaction with external simulation model without ROS, via system Inter Process Communication (IPC): video output to external model/application and motion input from external application. Work is in progress yet, see [TODO \\\u0026 current progress (dev branch)](#todo--current-progress-dev-branch).\n\n![Under development, coming soon](/doc/img/under_construction.png)\n\n## Contents \u003c!-- omit from toc --\u003e\n\n- [Use](#use)\n- [Development guidelines](#development-guidelines)\n- [Links and resources](#links-and-resources)\n- [TODO \\\u0026 current progress (dev branch)](#todo--current-progress-dev-branch)\n\n## Use\n\n1. Create game project in O3DE Project manager on choose existing one.\n2. Open project menu and select `Configure Gems...`\n3. Open top right menu, choose `Add Existing Gem` and find this gem repository folder. Then save changes.\n\n    \u003ctable style=\"border: 0px solid black;padding : 2px;\"\u003e\n        \u003ctr style=\"border: 0px solid black;padding : 2px;\"\u003e\n            \u003ctd style=\"border: 0px solid black;padding : 2px;\"\u003e\n                \u003cimg src=\"/doc/img/configure_gems.png\"/\u003e\n            \u003c/td\u003e\n            \u003ctd style=\"border: 0px solid black;padding : 2px;\" rowspan=\"2\"\u003e\n                \u003cimg src=\"/doc/img/add_gem.png\"/\u003e\n            \u003c/td\u003e\n        \u003c/tr\u003e\n    \u003c/table\u003e\n\n4. Build project.\n\n    \u003ctable style=\"border: 0px solid black;padding : 2px;\"\u003e\n        \u003ctr style=\"border: 0px solid black;padding : 2px;\"\u003e\n            \u003ctd style=\"border: 0px solid black;padding : 2px;\"\u003e\n                \u003cimg src=\"/doc/img/build_project.png\"/\u003e\n            \u003c/td\u003e\n            \u003ctd style=\"border: 0px solid black;padding : 2px;\"\u003e\n                \u003cimg src=\"/doc/img/building2.png\"/\u003e\n            \u003c/td\u003e\n            \u003ctd style=\"border: 0px solid black;padding : 2px;\"\u003e\n                \u003cimg src=\"/doc/img/building3.png\"/\u003e\n            \u003c/td\u003e\n        \u003c/tr\u003e\n    \u003c/table\u003e\n\n5. If build successful, `Open` project in O3DE Editor.\n6. To use `ReceiveMotionParamsComponent`\n\n   6.1. Choose entity you want to move.\n\n   6.2. Add `ReceiveMotionParamsComponent` in `Add Component` dialog:\n\n    \u003ctable style=\"border: 0px solid black;padding : 2px;\"\u003e\n        \u003ctr style=\"border: 0px solid black;padding : 2px;\"\u003e\n            \u003ctd style=\"border: 0px solid black;padding : 2px;\"\u003e\n                \u003cimg src=\"/doc/img/add_RMP_component.png\"/\u003e\n            \u003c/td\u003e\n            \u003ctd style=\"border: 0px solid black;padding : 2px;\"\u003e\n                \u003cimg src=\"/doc/img/add_RMP_component2.png\"/\u003e\n            \u003c/td\u003e\n        \u003c/tr\u003e\n        \u003ctr style=\"border: 0px solid black;padding : 2px;\"\u003e\n            \u003ctd style=\"border: 0px solid black;padding : 2px;\"\u003e\n                \u003cimg src=\"/doc/img/add_RMP_component3.png\"/\u003e\n            \u003c/td\u003e\n        \u003c/tr\u003e\n    \u003c/table\u003e\n\n    6.3. Build and launch `examples/minimal_app`, choose IPC method (yet only `UDP`) in combobox, press start.\n\n    6.4. Launch `Play Game` in O3DE Editor.\n\n    ![ReceiveMotionParams Demo](/doc/img/demo_RMP.gif)\n\n    (**Project, entities, level, assets are not included in this repo, used [copter 3D model](https://sketchfab.com/3d-models/dji-fpv-by-sdc-high-performance-drone-d471ea8c6235457b8e131842e2cf3783), terrain made by [tutorial1](https://docs.o3de.org/docs/learning-guide/tutorials/environments/create-terrain-from-images/) and [tutorial2](https://www.youtube.com/watch?v=rd8tEMUIEIY)**)\n\n7. To use `TranslatePictureComponent`\n   **`In progress yet`**\n   **`TODO when ready`**\n\n## Development guidelines\n\n- To make development more automated, I recommend VS Code with [Microsoft C++ Estension Pack](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools-extension-pack).\n\n- To generate IntelliSense hints when using O3DE classes, add path to O3DE SDK to extension paths in `.vscode\\c_cpp_properties.json`\n\n    \u003cdetails\u003e\n    \u003csummary\u003ec_cpp_properties.json code sample\u003c/summary\u003e\n\n    ```\n    {\n        \"configurations\": [\n            {\n                ...\n                \"includePath\": [\n                    ...,\n                    \"\u003cpath\u003e/\u003cto\u003e/\u003cyour\u003e/O3DE/23.10.3/Code/**\" // added this in VS C++ Extension to scan O3DE headers and generate IntelliSense hints\n                ],\n            }\n        ],\n\n    }\n    ```\n    \u003c/details\u003e\n\n    or do the same in VS Code C++ Extension dialog:\n\n    \u003ctable style=\"border: 0px solid black;padding : 2px;\"\u003e\n        \u003ctr style=\"border: 0px solid black;padding : 2px;\"\u003e\n            \u003ctd style=\"border: 0px solid black;padding : 2px;\"\u003e\n                \u003cimg src=\"/doc/img/add_intellisense1.png\"/\u003e\n            \u003c/td\u003e\n            \u003ctd style=\"border: 0px solid black;padding : 2px;\" rowspan=\"2\"\u003e\n                \u003cimg src=\"/doc/img/add_intellisense3.png\"/\u003e\n            \u003c/td\u003e\n        \u003c/tr\u003e\n        \u003ctr style=\"border: 0px solid black;padding : 2px;\"\u003e\n            \u003ctd style=\"border: 0px solid black;padding : 2px;\"\u003e\n                \u003cimg src=\"/doc/img/add_intellisense2.png\"/\u003e\n            \u003c/td\u003e\n        \u003c/tr\u003e\n    \u003c/table\u003e\n\n- To build project with gems and components directly from IDE, create `.vscode/tasks.json` file, add two tasks based on lines from your O3DE Project Editor Cmake log and make them run in `Visual Studio Developer Command Prompt`, like in example below:\n    \u003cdetails\u003e\n    \u003csummary\u003etasks.json code sample\u003c/summary\u003e\n\n    ```json\n    {\n        \"version\": \"2.0.0\",\n        \"windows\": {\n            \"options\": {\n                \"shell\": { // run all tasks below in Visual Studio Developer Command Prompt !!!\n                    \"executable\": \"cmd.exe\",\n                    \"args\": [\n                        \"/C\",\n                        \"\\\"C:/Program Files/Microsoft Visual Studio/2022/Community/Common7/Tools/VsDevCmd.bat\\\"\",\n                        \"\u0026\u0026\"\n                    ]\n                }\n            }\n        },\n        \"tasks\": [\n            { // Cmake configure task\n                \"type\": \"shell\",\n                \"label\": \"O3DE Project configure\",\n                \"command\": \"cmake\",\n                \"detail\": \"CMake configure task, copy of O3DE Project manager command\",\n                \"options\": {\n                    \"cwd\": \"\u003c!!! your/path/to/o3de_project\u003e/YourProjectName\"\n                },\n                \"args\": [ // made from original command line, shown in O3DE Project Manager Cmake Log \n                    \"-B\",\n                    \"\u003c!!! your/path/to/o3de_project\u003e/YourProjectName/build/windows\",\n                    \"-S\",\n                    \"\u003c!!! your/path/to/o3de_project\u003e/YourProjectName\",\n                    \"-DLY_3RDPARTY_PATH=\u003c!!! copy_from_your_cmake_log\u003e\"\n                ]\n            },\n            { // Cmake build task, depends on configure\n                \"type\": \"shell\",\n                \"label\": \"O3DE Project build\",\n                \"command\": \"cmake\",\n                \"detail\": \"CMake build task, copy of O3DE Project manager command\",\n                \"options\": {\n                    \"cwd\": \"\u003c!!! your/path/to/o3de_project\u003e/YourProjectName\"\n                },\n                \"args\": [ // made from original command line, shown in O3DE Project Manager Cmake Log \n                    \"--build\",\n                    \"\u003c!!! your/path/to/o3de_project\u003e/YourProjectName/build/windows\",\n                    \"--config\",\n                    \"profile\",\n                    \"--target\",\n                    \"YourProjectName.GameLauncher\",\n                    \"YourProjectName.ServerLauncher\",\n                    \"YourProjectName.UnifiedLauncher\",\n                    \"Editor\"\n                ],\n                \"dependsOn\": \"O3DE Project configure\"\n            },\n        ]\n    }\n    ```\n    \u003c/details\u003e\n\n## Links and resources\n\n1. Open 3D Engine (O3DE) Tutorials and Examples. - URL: https://www.docs.o3de.org/docs/learning-guide.\n2. Open 3D Engine and Atom API Reference. - URL: https://www.docs.o3de.org/docs/api.\n3. Open 3D Engine (O3DE) User Guide. Components. - URL: https://www.docs.o3de.org/docs/user-guide/components.\n4. Open 3D Engine (O3DE) User Guide. Gems in Open 3D Engine. - URL: https://www.docs.o3de.org/docs/user-guide/gems.\n5. Your First Network Component. - URL: https://docs.o3de.org/docs/learning-guide/tutorials/multiplayer/first-multiplayer-component, https://github.com/SelfishOlex/O3DEBookCode2111.\n6. Olex Lozitskiy. Game Programming with O3DE. - URL: https://o3debook.com.\n\nAPI documentation yet is very poor and formal. For this reason it's often required to look into the source code:\n\n7. O3DE. - URL: https://github.com/o3de/o3de/tree/development.\n\n## TODO \u0026 current progress (dev branch)\n\n- [x] `ReceiveMotionParams` component + example external app, UDP.\n- [ ] `ReceiveMotionParams` component + example external app, shared memory.\n- [ ] `TranslatePicture` component: render viewport + display in external example app via UDP.\n- [ ] `TranslatePicture` component: render viewport + display in external example app via shared memory.\n- [ ] Add Editor GUI options to components.\n- [ ] 80% Documentation\n- [ ] Release: reliability, usability, optimization.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fornstein89%2Fopen3de-extsimint-gem","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fornstein89%2Fopen3de-extsimint-gem","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fornstein89%2Fopen3de-extsimint-gem/lists"}