borealis

Controller and TV oriented UI library for PC and Nintendo Switch (libnx).

⚠️ Warning: the project is a WIP - See the Projects tab to follow the journey towards a stable version!

The code for the old version is available in the legacy branch.

⚠️ The wiki only contains the documentation for the old version of the library, it has yet to be updated!

Mimicks the Nintendo Switch system UI, but can also be used to make anything else painlessly
Hardware acceleration and vector graphics with automatic scaling for TV usage (powered by nanovg)
Can be ported to new platforms and graphics APIs by providing a nanovg implementation
Powerful layout engine using flex box as a base for everything (powered by Yoga Layout)
Automated navigation paths for out-of-the-box controller navigation
Out of the box touch support
Define user interfaces using XML and only write code when it matters
Use and restyle built-in components or make your own from scratch
Display large amount of data efficiently using recycling lists
Integrated internationalization and storage systems
Integrated toolbox (logger, animations, timers, background tasks...)

Building the demo for Switch

To build for Switch, a standard development environment must first be set up. In order to do so, refer to the Getting Started guide.

cmake -B build_switch -DPLATFORM_SWITCH=ON
make -C build_switch borealis_demo.nro -j$(nproc)

Building the demo for PC

To build for PC, the following components are required:

cmake/make build system
A C++ compiler supporting the C++17 standard

Please refer to the usual sources of information for your particular operating system. Usually the commands needed to build this project will look like this:

cmake -B build_pc -DPLATFORM_DESKTOP=ON -DCMAKE_BUILD_TYPE=Release
make -C build_pc -j$(nproc)

crosscompile using mingw64 under ubuntu/debian

sudo apt-get install g++-mingw-w64-x86-64-posix
cmake -B build_mingw -DPLATFORM_DESKTOP=ON -DCMAKE_BUILD_TYPE=Release -DCMAKE_TOOLCHAIN_FILE="library/cmake/MinGWCross.cmake"
make -C build_mingw -j$(nproc)

Also, please note that the resources folder must be available in the working directory, otherwise the program will fail to find the shaders.

Building the demo for WinRT

# generate key for codesigning (optional)
openssl req -nodes -newkey rsa:2048 -keyout cert.key -out cert.crt -x509 -days 365 -subj '//CN=borealis' \
  -extensions 'v3_req' -addext 'extendedKeyUsage=codeSigning'
openssl pkcs12 -export -nodes -out winrt/key.pfx -inkey cert.key -in cert.crt -passout pass:

# add xmake repo
xmake repo -a local https://github.com/zeromake/xrepo.git

xmake f -c -y --winrt=y --window=sdl --driver=d3d11
xmake b -y demo

Building the demo for PSV

install VITASDK
install PVR_PSP2 headers and libs. refer to: SDL/vita.yaml
put *.suprx files (PVR_PSP2) to psv/module
Unlock unsafe mode in System Settings/HENkaku

We only need: libGLESv2.suprx libgpu_es4_ext.suprx libIMGEGL.suprx libpvrPSP2_WSEGL.suprx
Overclock ES4(GPU) to 166MHz or higher for a smoother experience.

cmake -B build_psv -DPLATFORM_PSV=ON
make -C build_psv borealis_demo.vpk -j$(nproc)

My daily development experience on PSV

Install PrincessLog to psv.(This can help display the log, see their README for more info)
Install vitacompanion to psv.(Sending updated files to psv without fully installing a vpk)
Install the borealis_demo.vpk we built before.
Run nc -kl -w 3 9999 in Your computer. (Working as a logging server)
After modifying the code, run:

make -j$(nproc) && \
mv borealis_demo.self eboot.bin && \
curl --ftp-method nocwd -T eboot.bin ftp://192.168.1.140:1337/ux0:/app/BRLS00000/ && \
echo launch BRLS00000 | nc 192.168.1.140 1338

192.168.1.140 is the ip address of my psv
BRLS00000 is the demo app ID For me using PSMLogUSB with psmlogusb-client is more stable than PrincessLog.

Building the demo for PS4

You need install pacbrew-packages（SDL2 provided by pacbrew-packages supports OpenGL ES2）

source /opt/pacbrew/ps4/openorbis/ps4vars.sh
openorbis-cmake -B build_ps4 -DPLATFORM_PS4=ON
make -C build_ps4 -j$(nproc)

There is a docker image for building ps4 homebrew: xfangfang/pacbrew:231021
docker run --rm -v $(pwd):/src/ xfangfang/pacbrew:231021 "openorbis-cmake -B build_ps4 -DPLATFORM_PS4=ON && make -C build_ps4 -j$(nproc)"

Sending pkg to ps4:
make -j$(nproc) && curl --ftp-method nocwd -T *.pkg ftp://<your_ps4_ip>:2121/data/pkg/

Enable klog TTY Redirect in GoldHEN, then connect to ps4 klog:
nc <your_ps4_ip> 3232

Building the demo for Android

# build libromfs generator
./build_libromfs_generator.sh

cd android-project
export JAVA_HOME=/Applications/Android\ Studio.app/Contents/jbr/Contents/Home
export ANDROID_SDK_ROOT=~/Library/Android/sdk
# Once built, the APK will be located in the app/build/outputs/apk/debug directory by default
./gradlew assembleDebug
# Directly install the APK (requires the device or emulator to be connected via adb)
./gradlew installDebug

Building the demo for iOS

# build libromfs generator
./build_libromfs_generator.sh

1. Build for arm64 iphoneOS

# 1. Generate a Xcode project
# IOS_CODE_SIGN_IDENTITY: code is not signed when IOS_CODE_SIGN_IDENTITY is empty
# IOS_GUI_IDENTIFIER: optional, default is com.borealis.demo
cmake -B build-ios -G Xcode -DPLATFORM_IOS=ON -DPLATFORM=OS64 -DDEPLOYMENT_TARGET=13.0 \
  -DIOS_CODE_SIGN_IDENTITY="Your identity" \
  -DIOS_GUI_IDENTIFIER="custom.app.id.here"

# 2. open project in Xcode
open build-ios/*.xcodeproj

# 3. Set up Team and Bundle Identifiers in Xcode, then connect devices to run.

How to install the borealis demo on your iPhone (in a beginner-friendly way):

Download the borealis_demo.app (borealis-ios) from GitHub Actions.
Create a new iOS project in xcode (make sure you can install the app on your iPhone).
Download ios-app-signer.
Open ios-app-signer, select borealis_demo.app for Input File, select the newly created xcode project for Provisioning Profile, and click start.
Change the suffix of the generated ipa to zip and unzip it to get the Payload folder.
Open xcode, select Window -> Devices and Simulators from the menu bar, connect the device, click the + in installed apps, and select the borealis_demo.app file in the Payload folder.

2. Build for arm64 iphoneOS Simulator

cmake -B build-ios -G Xcode -DPLATFORM_IOS=ON -DPLATFORM=SIMULATORARM64 -DDEPLOYMENT_TARGET=13.0

# Build
cmake --build build-ios

# Open simulator
open -a Simulator

# After simulator is booted, install app
xcrun simctl install booted build-ios/Debug-iphonesimulator/borealis_demo.app

Including in your project (TL;DR: see the CMakeLists.txt in this repo)

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
Use a submodule (or even better, a subrepo) to clone this repository in your project
Copy the resources folder to the root of your project

Here is my work with borealis: https://github.com/xfangfang/wiliwili

PoloNX/borealis