{"id":52079648,"url":"https://github.com/natinusala/borealis","last_synced_at":"2026-08-03T18:03:46.452Z","repository":{"id":38377927,"uuid":"187021885","full_name":"natinusala/borealis","owner":"natinusala","description":"Hardware accelerated, controller and TV oriented UI library for PC and Nintendo Switch (libnx)","archived":false,"fork":false,"pushed_at":"2022-08-22T01:20:16.000Z","size":9420,"stargazers_count":237,"open_issues_count":85,"forks_count":63,"subscribers_count":11,"default_branch":"main","last_synced_at":"2023-10-20T21:59:18.421Z","etag":null,"topics":["controller","cpp","cpp-library","cross-platform","gamepad","glfw","gui","hacktoberfest","homebrew","library","meson","nanovg","nintendo-switch","opengl","touch","tv","ui","yoga-layout"],"latest_commit_sha":null,"homepage":"","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/natinusala.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":"2019-05-16T12:18:15.000Z","updated_at":"2023-09-23T09:26:40.000Z","dependencies_parsed_at":"2022-08-25T02:12:25.921Z","dependency_job_id":null,"html_url":"https://github.com/natinusala/borealis","commit_stats":null,"previous_names":[],"tags_count":0,"template":null,"template_full_name":null,"purl":"pkg:github/natinusala/borealis","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/natinusala%2Fborealis","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/natinusala%2Fborealis/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/natinusala%2Fborealis/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/natinusala%2Fborealis/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/natinusala","download_url":"https://codeload.github.com/natinusala/borealis/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/natinusala%2Fborealis/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":36245385,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-07-20T02:08:10.276Z","status":"online","status_checked_at":"2026-08-03T02:00:06.975Z","response_time":56,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["controller","cpp","cpp-library","cross-platform","gamepad","glfw","gui","hacktoberfest","homebrew","library","meson","nanovg","nintendo-switch","opengl","touch","tv","ui","yoga-layout"],"created_at":"2026-08-03T18:03:45.804Z","updated_at":"2026-08-03T18:03:46.446Z","avatar_url":"https://github.com/natinusala.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"![borealis logo](https://github.com/natinusala/borealis/blob/main/resources/img/borealis_96.png?raw=true)\n# borealis\n\nController and TV oriented UI library for PC and Nintendo Switch (libnx).\n\n⚠️ Warning: the project is a WIP - See the Projects tab to follow the journey towards a stable version!\n\nThe code for the old version is available in the `legacy` branch.\n\n⚠️ The wiki only contains the documentation for the old version of the library, it has yet to be updated!\n\n- Mimicks the Nintendo Switch system UI, but can also be used to make anything else painlessly\n- Hardware acceleration and vector graphics with automatic scaling for TV usage (powered by nanovg)\n- Can be ported to new platforms and graphics APIs by providing a nanovg implementation\n- Powerful layout engine using flex box as a base for everything (powered by Yoga Layout)\n- Automated navigation paths for out-of-the-box controller navigation\n- Out of the box touch support\n- Define user interfaces using XML and only write code when it matters\n- Use and restyle built-in components or make your own from scratch\n- Display large amount of data efficiently using recycling lists\n- Integrated internationalization and storage systems\n- Integrated toolbox (logger, animations, timers, background tasks...)\n\n## Building the demo for Switch\n\nTo build for Switch, a standard development environment must first be set up. In order to do so, [refer to the Getting Started guide](https://devkitpro.org/wiki/Getting_Started).\n\n```bash\n(sudo) (dkp-)pacman -S switch-glfw switch-mesa switch-glm\nmake -j\nnxlink -s borealis_demo.nro\n```\n\n## Building the demo for PC\n\nTo build for PC, the following components are required:\n\n- meson/ninja build system\n- A C++ compiler supporting the C++17 standard\n- GLFW version 3.3 or higher (as a static library)\n- GLM version 0.9.8 or higher\n\nPlease refer to the usual sources of information for your particular operating system. Usually the commands needed to build this project will look like this:\n\n```bash\nmeson build\nninja -C build\n./build/borealis_demo\n```\n\nAlso, please note that the `resources` folder must be available in the working directory, otherwise the program will fail to find the shaders.\n\n### Building the demo for Windows using msys2\n\nmsys2 provides all packages needed to build this project:\n\n```bash\npacman -S mingw-w64-x86_64-gcc mingw-w64-x86_64-meson mingw-w64-x86_64-ninja mingw-w64-x86_64-pkg-config mingw-w64-x86_64-glfw mingw-w64-x86_64-glm\nmeson build\nninja -C build\n./build/borealis_demo\n```\n\n### Including in your project (TL;DR: see the demo makefile in this repo)\n0. Your project must be built as C++17 (`-std=c++1z`). You also need to remove `-fno-rtti` and `-fno-exceptions` if you have them\n1. Use a submodule (or even better, a [subrepo](https://github.com/ingydotnet/git-subrepo)) to clone this repository in your project\n2. Copy the `resources` folder to the root of your project\n3. For PC (meson):\n    1. take a standard meson file\n    2. use `subdir` to import the library folder\n    3. use the `borealis_files`, `borealis_dependencies`, `borealis_include` and `borealis_cpp_args` variables for respectively objects to build, dependencies (glfw...), includes directory and cpp args\n    4. add a `BRLS_RESOURCES` define pointing to the resources folder at runtime (so `resources`)\n4. For Switch:\n    1. take a standard deko3d homebrew makefile (from the switch-examples repo)\n    2. add a `BOREALIS_PATH` variable containing the subfolder you put the library in\n    3. set `ROMFS` to the resources folder - borealis resources path is set to `romfs:/` in borealis.mk\n    4. use `include` to load `borealis.mk` (after `LIBDIRS` and `BOREALIS_PATH`)\n    5. it's important for `OUT_SHADERS` to be set to `shaders` since nanovg will look for the shaders there\n    6. if you have issues with the `BRLS_RESOURCES` define (missing quote terminator), change the `@$(MAKE)` line to `@MSYS2_ARG_CONV_EXCL=\"-D;$(MSYS2_ARG_CONV_EXCL)\" $(MAKE)` in the Makefile (as in the demo Makefile)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnatinusala%2Fborealis","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnatinusala%2Fborealis","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnatinusala%2Fborealis/lists"}