{"id":25976217,"url":"https://github.com/depthso/dear-regui","last_synced_at":"2025-04-10T02:19:34.658Z","repository":{"id":250164569,"uuid":"833613574","full_name":"depthso/Dear-ReGui","owner":"depthso","description":"🖼 A retained recreation of ImGui for Roblox that doesn't need a Renderstep connection like Iris","archived":false,"fork":false,"pushed_at":"2025-03-31T16:09:56.000Z","size":742,"stargazers_count":69,"open_issues_count":1,"forks_count":20,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-04-03T01:13:28.581Z","etag":null,"topics":["gui","imgui","imgui-menu","lua","luau","roblox","roblox-gui","roblox-lib","roblox-library","roblox-script","roblox-scripts","roblox-ui","roblox-ui-lib","ui-library"],"latest_commit_sha":null,"homepage":"https://depso.gitbook.io/regui","language":"Luau","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/depthso.png","metadata":{"files":{"readme":"docs/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-07-25T11:59:59.000Z","updated_at":"2025-03-31T16:10:00.000Z","dependencies_parsed_at":"2024-12-14T13:23:40.159Z","dependency_job_id":"154700bb-33a0-42b7-b005-753945093f28","html_url":"https://github.com/depthso/Dear-ReGui","commit_stats":null,"previous_names":["depthso/roblox-imgui","depthso/dear-regui"],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/depthso%2FDear-ReGui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/depthso%2FDear-ReGui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/depthso%2FDear-ReGui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/depthso%2FDear-ReGui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/depthso","download_url":"https://codeload.github.com/depthso/Dear-ReGui/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248142908,"owners_count":21054672,"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":["gui","imgui","imgui-menu","lua","luau","roblox","roblox-gui","roblox-lib","roblox-library","roblox-script","roblox-scripts","roblox-ui","roblox-ui-lib","ui-library"],"created_at":"2025-03-05T03:35:50.839Z","updated_at":"2025-04-10T02:19:34.633Z","avatar_url":"https://github.com/depthso.png","language":"Luau","readme":"# Dear ReGui\nDear ReGui is a retained dear ImGui library remake designed to be used on Roblox!\nThis is perfect for beginners and performance.\n\nDemo place: https://www.roblox.com/games/136436665525145/ReGui-Demo \\\nDocumentation: https://depso.gitbook.io/regui\n\n## Notices\n- ReGui will have bugs, please report any bugs by opening an issue on Github\n- For suggestions or questions, please visit the [discussions page](https://github.com/depthso/Dear-ReGui/discussions)\n- If you would like to fork this, please read the [Forking](#forking) section\n- Technical documentation and addional infomation such as commonly asked questions can be found on the [Gitbook documentation](https://depso.gitbook.io/regui)\n\n## Demo\nThe best way to learn ReGUI is to look through the Demo window which comes bundled with ReGUI.\nThe demo window is updated every significant update such as an addition of an element or a flag has been renamed.\n\nhttps://github.com/depthso/Dear-ReGui/blob/main/Demo%20window.lua\n\n## Usage\nReGui can be used on any GUI type you want such as CoreGui, PlayerGui, BillboardGui, PluginGui, and SurfaceGui.\nInstallation is as simple as importing the rbxm model into your project and connecting a client script to begin using it!\n\nReGui requires prefabs as it does not generate the base elments required for many elements such as the Window.\n\nSee the [Getting Started - Installing](https://depso.gitbook.io/regui/getting-started/installing) section for more details\n\nOnce you have installed ReGUI into your project, it can be used by any client script anywhere!\n```lua\nlocal Window = ReGui:Window({\n\tTitle = \"Hello world!\",\n\tSize = UDim2.fromOffset(300, 200)\n})\n\nWindow:Label({Text=\"Hello, world!\"})\nWindow:Button({\n\tText = \"Save\",\n\tCallback = function()\n\t\tMySaveFunction()\n\tend,\n})\nWindow:InputText({Label=\"string\"})\nWindow:SliderFloat({Label = \"float\", Minimum = 0.0, Maximum = 1.0})\n```\n\n\u003cimg src=\"https://github.com/user-attachments/assets/9181571f-39c3-42bc-8677-3a433c92e6e3\" width=\"400px\"\u003e\n\n## Gallery\n\u003ctable\u003e\n\t\u003ctr\u003e\n\t\t\u003ctd width=\"50%\"\u003e\n\t\t\t\u003cimg src=\"https://github.com/user-attachments/assets/a2f7c6bd-17fa-460a-b6d4-c033720cce3a\"\u003e\n\t\t\u003c/td\u003e\n  \t\t\u003ctd width=\"50%\"\u003e\n\t\t\t\u003cimg src=\"https://github.com/user-attachments/assets/08cff202-d6b9-4b26-b54d-454a93566202\"\u003e\n\t\t\u003c/td\u003e\n\t\u003c/tr\u003e\n\t\u003ctr\u003e\n\t\t\u003ctd\u003e\n\t\t\tAdvanced customization example\n\t\t\t\u003cimg src=\"https://github.com/user-attachments/assets/c2e9be5d-819b-4620-9a0f-b99f42e21886\"\u003e\n\t\t\u003c/td\u003e\n\t\t\u003ctd\u003e\n\t\t\tDemo window  \n\t\t\t\u003cimg src=\"https://github.com/user-attachments/assets/f1324da5-81c2-41f1-bc51-73b381592c97\"\u003e\n\t\t\u003c/td\u003e\n\t\u003c/tr\u003e\n\u003c/table\u003e\n\n## Forking\nIf you would like to create a fork of ReGui, please read the steps below\n\n### Custom module\nIf you are going to edit the module and publish it, please create a copy of the [Prefabs](https://create.roblox.com/store/asset/71968920594655) \nas the module will quickly become outdated and cause issues with the Prefabs. Currently you only need to download a copy of the `main.lua` file\n\n### Custom Prefabs\nUsing custom prefabs with ReGUI is very simple. \nTo use custom prefabs you can point the library's `Prefabs` to the custom prefabs in the `:Init` call. For externally using custom prefabs, replace `rbxassetid://{ReGui.PrefabsId}` with `rbxassetid://PrefabsID` and replace `PrefabsID` with the id of your custom prefabs that you have published on Roblox.\n\nReGui prefabs asset: [Prefabs Gui - Roblox](https://create.roblox.com/store/asset/71968920594655)\n\n#\n\n\u003ctable\u003e\n\t\u003ctr\u003e\n\t\t\u003cimg src=\"/docs/images/Dear ReGui.png\" width=\"30%\"\u003e\n\t\u003c/tr\u003e\n\t\u003ctr\u003e\n\t\t\u003cp\u003eDear ReGui, a retained dear ImGui library remake for Roblox developed by depso\u003c/p\u003e\n\t\u003c/tr\u003e\n\u003c/table\u003e\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdepthso%2Fdear-regui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdepthso%2Fdear-regui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdepthso%2Fdear-regui/lists"}