{"id":27125423,"url":"https://github.com/dubit/unity-debug-menu","last_synced_at":"2025-04-07T14:53:16.216Z","repository":{"id":73194320,"uuid":"135445027","full_name":"dubit/unity-debug-menu","owner":"dubit","description":"A prebuilt DebugMenu that includes typically needed debugging features.","archived":false,"fork":false,"pushed_at":"2025-03-31T14:51:55.000Z","size":242,"stargazers_count":8,"open_issues_count":6,"forks_count":2,"subscribers_count":4,"default_branch":"development","last_synced_at":"2025-03-31T16:05:53.183Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dubit.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2018-05-30T13:14:34.000Z","updated_at":"2025-03-31T14:52:01.000Z","dependencies_parsed_at":null,"dependency_job_id":"8271e73b-e3d8-4be3-b444-d3f4a5375e38","html_url":"https://github.com/dubit/unity-debug-menu","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dubit%2Funity-debug-menu","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dubit%2Funity-debug-menu/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dubit%2Funity-debug-menu/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dubit%2Funity-debug-menu/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dubit","download_url":"https://codeload.github.com/dubit/unity-debug-menu/tar.gz/refs/heads/development","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247675602,"owners_count":20977376,"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-07T14:53:15.590Z","updated_at":"2025-04-07T14:53:16.205Z","avatar_url":"https://github.com/dubit.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# unity-debug-menu\n\n## What is it?\nA prebuilt debug menu with some customizable options.\n\nThe DebugMenu is designed to reduce the time and effort made per project to build custom debug menus. It's customizability with summoning makes it easy for your unique project to implement a custom method to open the DebugMenu.\n\nBuilt-in Features:\n* Custom buttons\n* Access and display the cloud build manifest.\n* Visible debug logs and exceptions with thier stacktrace.\n* Email the log and callstack.\n\n## How to use it.\nHave the DebugMenu prefab active in the scene.\n\n### Buttons\nRegister a custom button with the DebugMenu by using the `AddButton` method. This method requires a unique identifier for the button (which it will also display as the the label for the button) and an Action to invoke when the button is clicked. The method also inclused an optional parameter (`hideDebugMenuOnClick`) for closing the DebugMenu when this custom button is clicked.  \n`DebugMenu.Instance.AddButton(\"Button\", () =\u003e { Debug.Log(\"My custom button was clicked.\"); });`\n\n### Summoners\nThe ready-made prefab that ships with DUCK, has a DefaultDebugMenuSummoner. Use `F7` on PC or `6 touches` on mobile to open the DebugMenu.\n\nIf you want to use your own logic to summon the debug menu then implement your own `IDebugMenuSummoner` and register it.\n\nTo register a custom `IDebugMenuSummoner` with the DebugMenu either use `DebugMenu.Instance.AddSummoner`, or add it to the instance of the DebugMenu prefab in the scene, and it will find it on `Start()`.\n\n### Email Addresses\nEmail addresses can be added to the dropdown via a JSON text asset. You can store this asset anywhere in you Unity project Assets directory as long as you reference it in the `DebugMenu (GameObject) -\u003e EmailPage (GameObject) -\u003e emailAddressesJson (SerializedField)`.\n\n### Stacktrace\nTo view a stacktrace simpley click on the log and a view will open up with the visible log and stacktrace.\nUse the email button in the top right of the screen to generate and send the callstack to an email address.\n\n## Releasing\n* Use [gitflow](https://nvie.com/posts/a-successful-git-branching-model/)\n* Create a release branch for the release\n* On that branch, bump version number in package json file, any other business (docs/readme updates)\n* Merge to master via pull request and tag the merge commit on master.\n* Merge back to development.\n\n## DUCK\n\nThis repo is part of DUCK (dubit unity component kit)\nDUCK is a series of repos containing reusable component, utils, systems \u0026 tools. \n\nDUCK packages can be added to a project as git submodules or by using [Unity Package Manager](https://docs.unity3d.com/Manual/upm-git.html). \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdubit%2Funity-debug-menu","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdubit%2Funity-debug-menu","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdubit%2Funity-debug-menu/lists"}