{"id":15039228,"url":"https://github.com/elw00d/consoleframework","last_synced_at":"2025-05-16T07:07:17.671Z","repository":{"id":14027689,"uuid":"16729790","full_name":"elw00d/consoleframework","owner":"elw00d","description":"Cross-platform toolkit for easy development of TUI applications.","archived":false,"fork":false,"pushed_at":"2020-11-19T22:25:56.000Z","size":2007,"stargazers_count":557,"open_issues_count":13,"forks_count":63,"subscribers_count":48,"default_branch":"develop","last_synced_at":"2025-05-09T21:14:35.901Z","etag":null,"topics":["console","dotnetcore","linux","tui"],"latest_commit_sha":null,"homepage":"http://elw00d.github.io/consoleframework","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/elw00d.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}},"created_at":"2014-02-11T12:14:48.000Z","updated_at":"2025-05-06T12:51:36.000Z","dependencies_parsed_at":"2022-08-28T20:50:57.212Z","dependency_job_id":null,"html_url":"https://github.com/elw00d/consoleframework","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elw00d%2Fconsoleframework","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elw00d%2Fconsoleframework/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elw00d%2Fconsoleframework/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elw00d%2Fconsoleframework/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/elw00d","download_url":"https://codeload.github.com/elw00d/consoleframework/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254485065,"owners_count":22078767,"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":["console","dotnetcore","linux","tui"],"created_at":"2024-09-24T20:42:02.461Z","updated_at":"2025-05-16T07:07:15.400Z","avatar_url":"https://github.com/elw00d.png","language":"C#","readme":"Console Framework\r\n==\r\n\r\n![](https://travis-ci.org/elw00d/consoleframework.svg?branch=develop)\r\n[![NuGet](https://img.shields.io/nuget/v/Elwood.ConsoleFramework.svg)](https://www.nuget.org/packages/Elwood.ConsoleFramework)\r\n\r\n\r\nConsole framework is cross-platform toolkit that allows to develop [TUI] applications using C# and based on WPF-like concepts.\r\n\r\nFeatures\r\n--------\r\n\r\n- Declarative markup (custom lightweight XAML implementation)\r\n- Data binding (integrated with XAML markup)\r\n- Retained mode rendering system\r\n- WPF-compatible simple and flexible layout system\r\n- A lot of controls available (including Grid, ScrollViewer, ListBox, ComboBox)\r\n- Routed events system (compatible with WPF)\r\n- Windows, Mac OS X and Linux (64-bit) support\r\n\r\n![](http://gyazo.com/81e1ae92cfba8c7a1c2a98da7da75ad7.png)\r\n\r\nInstall from NuGet\r\n--\r\n\r\nNuGet package is available here [https://www.nuget.org/packages/Elwood.ConsoleFramework]\r\n\r\nBuild from source\r\n--\r\nTo build a library with examples you can use standard dotnet tool:\r\n\r\n```sh\r\ndotnet build\r\n```\r\n\r\nIt should work in all platforms.\r\n\r\nRunning examples\r\n--\r\nIn Windows\r\n\r\n```sh\r\ndotnet run --project ExamplesStandalone/ManyControls\r\n```\r\n\r\nIn Linux\r\n\r\n```sh\r\n# Copy native dependencies before run\r\nmkdir -p ExamplesStandalone/ManyControls/bin/Debug/netcoreapp3.0/\r\nunzip native/libtermkey-0.18-x86_64.zip -d ExamplesStandalone/ManyControls/bin/Debug/netcoreapp3.0/\r\n\r\n# Build and run project\r\ndotnet run --project ExamplesStandalone/ManyControls\r\n```\r\n\r\nPress Ctrl+D to exit application.\r\n\r\nRunning unit tests\r\n--\r\n```sh\r\ndotnet test Tests\r\n```\r\n\r\nDevelopment\r\n--\r\nThere were two IDEs where I've worked with .NET Core project: Visual Studio 2017 Community and JetBrains Rider. Both of them works well with this source code.\r\n\r\nNative dependencies\r\n--\r\nFor Windows there are no native dependencies required. But in Linux and Mac OS X environments you should prepare some native dependencies to be able to execute examples. Dependencies are:\r\n\r\n- libtermkey\r\n- libc\r\n- ncursesw\r\n\r\nTo build *libtermkey* go to its source code directory and simply run\r\n\r\n```sh\r\nmake\r\n```\r\n\r\nAfter that you can copy binaries from ./libs into directory with examples. Or you can use binaries of libtermkey from zip in **/native** directory.\r\n\r\nLibc and ncursesw are distributed in binaries in vast majority of Linux distros and OS X, so all you need is locate actual binaries and copy them in the output directory if the target machine does not have them, for example, if you are Mac OS X user, you will need to install libtermkey.\r\n\r\n```sh\r\nbrew install --universal libtermkey\r\n```\r\n\r\nConsole Framework expects that libraries will be available strictly by these names on Linux. If your system already has symlinks *libc.so.6* and *libncursesw.so.5*, you can skip this step.\r\n\r\nMono support\r\n--\r\nSupport of Mono runtime have been discontinued. If you need library for Mono, you can download previous releases. All further development will be continued for .NET Core runtime only.\r\n\r\n\r\nTerminal emulators in Mac OS X\r\n--\r\nStandard terminal emulator is not very good for console applications deals with mouse. My recommendation is to use [ITerm2]. ITerm2 provides a good emulation with mouse support. If you want to see how console framework renders in various Mac emulators, visit [http://elwood.su/2014/02/console-framework-on-mac/]\r\n\r\nLicense\r\n-------\r\nCopyright 2011-2018 I. Kostromin\r\n\r\nLicense: MIT/X11\r\n\r\n[TUI]:http://en.wikipedia.org/wiki/Text-based_user_interface\r\n[MacPorts]:http://www.macports.org/\r\n[ITerm2]:http://www.iterm2.com/#/section/home\r\n[http://elwood.su/2014/02/console-framework-on-mac/]:http://elwood.su/2014/02/console-framework-on-mac/\r\n[https://www.nuget.org/packages/Elwood.ConsoleFramework]:https://www.nuget.org/packages/Elwood.ConsoleFramework\r\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felw00d%2Fconsoleframework","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Felw00d%2Fconsoleframework","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felw00d%2Fconsoleframework/lists"}