{"id":19269877,"url":"https://github.com/lyqht/builderbuddy","last_synced_at":"2026-05-18T04:41:31.994Z","repository":{"id":103559864,"uuid":"273402873","full_name":"lyqht/builderbuddy","owner":"lyqht","description":"Mixed Reality App for remote teaching to build a Gunpla Kit! Built with Unity and MRTK v2","archived":false,"fork":false,"pushed_at":"2021-10-20T03:38:54.000Z","size":30496,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-02-23T20:13:52.044Z","etag":null,"topics":["helloholo","hololens2","mixed-reality","mrtk","unity"],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lyqht.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":"2020-06-19T04:23:47.000Z","updated_at":"2021-10-20T03:39:03.000Z","dependencies_parsed_at":null,"dependency_job_id":"98133abc-d6b5-4524-b42f-b34a13831870","html_url":"https://github.com/lyqht/builderbuddy","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/lyqht/builderbuddy","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lyqht%2Fbuilderbuddy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lyqht%2Fbuilderbuddy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lyqht%2Fbuilderbuddy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lyqht%2Fbuilderbuddy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lyqht","download_url":"https://codeload.github.com/lyqht/builderbuddy/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lyqht%2Fbuilderbuddy/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274125646,"owners_count":25226491,"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","status":"online","status_checked_at":"2025-09-08T02:00:09.813Z","response_time":121,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["helloholo","hololens2","mixed-reality","mrtk","unity"],"created_at":"2024-11-09T20:22:27.499Z","updated_at":"2026-05-18T04:41:31.939Z","avatar_url":"https://github.com/lyqht.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# BuilderBuddy\r\n\r\nTable of Contents\r\n\r\n- [BuilderBuddy](#builderbuddy)\r\n  - [Description](#description)\r\n  - [Storyboard](#storyboard)\r\n  - [Features](#features)\r\n    - [Implemented ✅](#implemented-)\r\n    - [Future work 🤞](#future-work-)\r\n  - [Demo](#demo)\r\n    - [In Unity Editor](#in-unity-editor)\r\n    - [In HoloLens 2](#in-hololens-2)\r\n\r\n## Description\r\n\r\n- A mixed reality app that serves as a proof-of-concept to remotely teach students how to build a gunpla model kit! _(especially given the COVID19 situation...)_\r\n- A collab project done by [lyqht](https://github.com/lyqht) and [software312](https://github.com/software312) for Mixed Reality Developer Course by [HelloHolo](https://helloholo.sg/)\r\n  - Special thanks to HelloHolo for providing the 3D model assets and technical help in debugging!\r\n  - We were both later awarded Mixed Reality Developer Course (Merit) certificate.\r\n\r\n## Storyboard\r\n\r\n![](demo/storyboard.jpg)\r\n\r\nSee it bigger at https://miro.com/app/board/o9J_ksM-crI=/\r\n\r\n## Features\r\n\r\n### Implemented ✅\r\n\r\n- **Introduction to the guide app**\r\n\r\n  - `StartCoroutine()` for text transition timeout\r\n  - `SurfaceMagnetism` used to attach the introduction text to any nearby walls and moves around as the user moves head around\r\n\r\n- **State is tracked** with `StateManager`\r\n  - Keep tracks of user's current progress, whether they are in the tutorial or in the building mode.\r\n  - **Progress UI** for back, next and current step (x / 14).\r\n    - Buttons implemented with `PressableButton`\r\n      - can also be clicked with speech commands such as Next, Back, Start.\r\n      - Speech commands configured with custom `SpeechProfile`\r\n    - Attaches to nearby walls similarly, and moves along with the head.\r\n  - **Shows correct models at current steps**\r\n    - On the runner: Current step is highlighted as a 3D object protruding out of the runner\r\n    - The model kit: A scaled `Tooltip` containing text instruction is attached to the non-moving part in the current step, and it always faces in the right orientation to the user. A looping **animation** is also shown to show users how to attach the parts.\r\n    - GameObjects for all the steps are instantiated since the start of the app, they are setActive(true) and setActive(false) depending on the current state/ step number.\r\n- **Models**\r\n  - Both the runner and the model kit **can be moved around and rotated independently**, thanks to `ManipulationHandler` and a `BoxCollider` around respective parent objects.\r\n  - just for fun: you can actually bash the model against the runner\r\n- **Completion of guide**\r\n  - Upon completing all the steps, \"You're done\" text is shown and a screenshot is taken.\r\n\r\n### Future work 🤞\r\n\r\n- Az ure Custom ML Model for automatic detection of the kit from the kit's box cover\r\n- Confirmation UI for screenshot and restart\r\n\r\n## Demo\r\n\r\n### In Unity Editor\r\n\r\n![](demo/haro_both.png)\r\n\r\n![](demo/demo_in_unity.gif)\r\n\r\n### In HoloLens 2\r\n\r\nDebug mode to show that the spatial mesh works\r\n\r\n![](demo/before_removal_of_mesh.png)\r\n\r\nVideo (this is taken before surface magnetism and manipulation handler on the runner)\r\n\r\nhttps://www.youtube.com/watch?v=SdTLZkyVhaE\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flyqht%2Fbuilderbuddy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flyqht%2Fbuilderbuddy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flyqht%2Fbuilderbuddy/lists"}