{"id":20367810,"url":"https://github.com/flaxengine/imgui","last_synced_at":"2025-04-12T05:36:46.022Z","repository":{"id":105039984,"uuid":"557810902","full_name":"FlaxEngine/ImGui","owner":"FlaxEngine","description":"Dear ImGui plugin for Flax Engine that adds debug GUI interface to game viewport.","archived":false,"fork":false,"pushed_at":"2025-03-12T09:45:01.000Z","size":1220,"stargazers_count":13,"open_issues_count":0,"forks_count":5,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-26T01:02:45.517Z","etag":null,"topics":["cpp","csharp","flax","flax-engine","imgui"],"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/FlaxEngine.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":"2022-10-26T10:52:51.000Z","updated_at":"2025-03-23T08:50:17.000Z","dependencies_parsed_at":null,"dependency_job_id":"7d830f2d-77ba-4b64-92ee-9fbf51c7dee8","html_url":"https://github.com/FlaxEngine/ImGui","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FlaxEngine%2FImGui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FlaxEngine%2FImGui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FlaxEngine%2FImGui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FlaxEngine%2FImGui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FlaxEngine","download_url":"https://codeload.github.com/FlaxEngine/ImGui/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248524853,"owners_count":21118615,"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":["cpp","csharp","flax","flax-engine","imgui"],"created_at":"2024-11-15T00:34:50.519Z","updated_at":"2025-04-12T05:36:45.975Z","avatar_url":"https://github.com/FlaxEngine.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Dear ImGui for Flax Engine\n\n![Dear ImGui for Flax Engine](imgui-flax-engine.png)\n\n[Dear ImGui](https://github.com/ocornut/imgui) is a bloat-free graphical user interface library for C++. It outputs optimized vertex buffers that you can render anytime in your 3D-pipeline-enabled application. It is fast, portable, renderer agnostic, and self-contained (no external dependencies). This repository contains a plugin project for [Flax Engine](https://flaxengine.com/) games with ImGui.\n\nMinimum supported Flax version: `1.5`.\n\n## Installation\n\n0. Ensure to have proper system setup for C++ Scripting - see [Flax Docs](https://docs.flaxengine.com/manual/scripting/cpp/index.html)\n\n1. Clone repo into `\u003cgame-project\u003e\\Plugins\\ImGui`\n\n2. Add reference to ImGui project in your game by modyfying your game `\u003cgame-project\u003e.flaxproj` as follows:\n\n```\n...\n\"References\": [\n    {\n        \"Name\": \"$(EnginePath)/Flax.flaxproj\"\n    },\n    {\n        \"Name\": \"$(ProjectPath)/Plugins/ImGui/ImGui.flaxproj\"\n    }\n]\n```\n\n3. Add reference to *ImGui* module in your game build script (eg. `Game.Build.cs`) as follows:\n\n```cs\n/// \u003cinheritdoc /\u003e\npublic override void Setup(BuildOptions options)\n{\n    base.Setup(options);\n\n    BuildNativeCode = false;\n    options.ScriptingAPI.IgnoreMissingDocumentationWarnings = true;\n\n    // Add reference to ImGui\n    options.PrivateDependencies.Add(\"ImGui\");\n}\n```\n\n4. Test it out!\n\nNow you can use ImGui API directly in your game code within `Update` (scripts, plugins, anywhere within game logic update) as follows:\n\n```cpp\n// C++\n#include \"ImGui/imgui.h\"\n\nvoid MyScript::OnUpdate()\n{\n    ImGui::Text(\"Hello, world %d\", 123);\n    ImGui::Button(\"Click\");\n}\n```\n\n```cs\n// C#\npublic override void OnUpdate()\n{\n    ImGui.Text(\"Hello!\");\n    ImGui.Button(\"Click\");\n}\n```\n\n## License\n\nBoth this plugin and ImGui are released under **MIT License**.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflaxengine%2Fimgui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fflaxengine%2Fimgui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflaxengine%2Fimgui/lists"}