{"id":13611027,"url":"https://github.com/simonkrauter/NiGui","last_synced_at":"2025-04-13T01:34:12.934Z","repository":{"id":37549461,"uuid":"95961846","full_name":"simonkrauter/NiGui","owner":"simonkrauter","description":"Cross-platform desktop GUI toolkit written in Nim","archived":false,"fork":false,"pushed_at":"2024-08-18T20:54:14.000Z","size":740,"stargazers_count":724,"open_issues_count":63,"forks_count":49,"subscribers_count":28,"default_branch":"master","last_synced_at":"2024-11-07T14:13:19.438Z","etag":null,"topics":["cross-platform","gtk","gui","linux","nim","toolkit"],"latest_commit_sha":null,"homepage":"","language":"Nim","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/simonkrauter.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"license.md","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":"2017-07-01T12:05:04.000Z","updated_at":"2024-11-05T22:42:24.000Z","dependencies_parsed_at":"2023-02-16T21:40:13.737Z","dependency_job_id":"e7868728-ecca-41ca-ba3f-4de14d36e2e0","html_url":"https://github.com/simonkrauter/NiGui","commit_stats":null,"previous_names":["trustable-code/nigui"],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simonkrauter%2FNiGui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simonkrauter%2FNiGui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simonkrauter%2FNiGui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simonkrauter%2FNiGui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/simonkrauter","download_url":"https://codeload.github.com/simonkrauter/NiGui/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223558485,"owners_count":17165140,"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":["cross-platform","gtk","gui","linux","nim","toolkit"],"created_at":"2024-08-01T19:01:51.060Z","updated_at":"2024-11-07T17:31:15.302Z","avatar_url":"https://github.com/simonkrauter.png","language":"Nim","funding_links":[],"categories":["Nim"],"sub_categories":[],"readme":"NiGui\r\n=====\r\n\r\nNiGui is a cross-platform desktop GUI toolkit written in [Nim](https://nim-lang.org/).\u003cbr\u003e\r\nNiGui provides an easy way to develop applications in Nim with a full-featured graphical user interface.\r\n\r\nTarget platforms:\r\n* Windows (Win32 API)\r\n* Linux over GTK+ 3\r\n* macOS over GTK+ 3 (native support planned)\r\n\r\nDesign goals:\r\n* **Full abstraction**\u003cbr\u003e\r\nNiGui provides full abstraction of the underlying platform. NiGui applications are written once and can be compiled for different platforms. Application developers don't have to care about platform-specific details.\r\n* **Simple and elegant**\u003cbr\u003e\r\nNiGui has a clean and beginner-friendly high-level API. It is much less complex than the Win32 API, GTK+ or Qt.\u003cbr\u003e\r\nNiGui profits of Nim's features and elegance in contrast to C code, for example Nim's polymorphism capabilities.\r\n* **Powerful**\u003cbr\u003e\r\nNiGui uses the native controls of the underlying platform to give a familiar use and feel for the user. In addtion, NiGui allows to create custom controls for special use cases or a themed UI. \u003cbr\u003e\r\nNiGui has it's own layout manager for automatic resizing and positioning of controls.\r\n* **Minimal dependencies**\u003cbr\u003e\r\nThe NiGui source code has no dependencies except Nim's standard library. Platform bindings are included.\u003cbr\u003e\r\nGenerated binaries (exe files) include NiGui and do not need external libraries.\r\n\r\nScreenshots\r\n-------------\r\n\r\nExample program with native controls running under Windows 10 and Xubuntu:\r\n\u003ca href=\"https://github.com/trustable-code/NiGui/blob/master/screenshots.png\"\u003e\u003cimg src=\"https://raw.githubusercontent.com/trustable-code/NiGui/master/screenshots.png\" width=\"600\"\u003e\u003c/a\u003e\r\n\r\nCurrent state\r\n-------------\r\nNiGui is currently work in progress. Very basic things work, many things are missing.\r\n\r\nWorking:\r\n* Window, Button, Label, TextBox, TextArea\r\n* LayoutContainer (own layout manager)\r\n* Timers\r\n* Message boxes and file dialogs\r\n* Custom controls including scrolling\r\n* Drawing and image processing\r\n\r\nWIP:\r\n* Event handling\r\n* Documentation\r\n\r\nPlanned:\r\n* macOS support\r\n* More widgets\r\n\r\nGetting started\r\n---------------\r\n\r\n### How to install NiGui manually\r\n\r\n1. Clone the NiGui repository with Git or download the source code\r\n2. Add the following line to one of your [Nim configuration files](https://nim-lang.org/docs/nimc.html#compiler-usage-configuration-files):\u003cbr\u003e\r\n`--path:\"\u003cpath_to_nigui\u003e/src\"`\r\n\r\n### How to install NiGui with Nimble\r\n\r\nRun the [Nimble](https://github.com/nim-lang/nimble) install command: `$ nimble install nigui`\r\n\r\n### Additional configuration\r\n\r\n* To disable the command line window under Windows, add this line to your Nim configuration: `--app:gui`\r\n* To compile a Windows binary which uses Gtk, add this line to your Nim configuration: `-d:forceGtk`\r\n\r\n### How to verify the installation\r\n\r\nCompile and run one of the included example programs.\r\n\r\nShow cases\r\n----------\r\n* [NiCalc](https://github.com/trustable-code/NiCalc) - Simple calculator\r\n* [Gravitate](https://www.qtrac.eu/gravitate.html) - Samegame/tilefall-like game\r\n\r\nContributing\r\n------------\r\nYou can help to improve NiGui by:\r\n* Trying to use it and giving feedback\r\n* Test the programs under different Windows versions or Linux distributions\r\n* Developing show cases\r\n* Help improving and extending the code\r\n* Adding macOS support\r\n\r\nContact: see https://github.com/trustable-code\r\n\r\nFAQ\r\n---\r\n\r\n[FAQ](faq.md)\r\n\r\nLicense\r\n-------\r\nNiGui is FLOSS (free and open-source software).\u003cbr\u003e\r\nAll files in this repository are licensed under the [MIT License](https://opensource.org/licenses/MIT). As a result you may use any compatible license (essentially any license) for your own programs developed with NiGui. You are explicitly permitted to develop commercial applications using NiGui.\u003cbr\u003e\r\nCopyright 2017-2020 Simon Krauter and contributors\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimonkrauter%2FNiGui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsimonkrauter%2FNiGui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimonkrauter%2FNiGui/lists"}