HBLauncher README

项目的 README,来自 github.com/ravensclawx/HBLauncher。合并为一个 markdown 文件:README.md。

HBLauncher

HBLauncher interface

A native AArch64 homebrew launcher and app SDK for Nintendo Switch 2, by RavensClawX. The launcher runs inside a SmileBASIC application process with an externally established, verified 4/4 session. CPU code handles the UI layout, animation, and input; Vulkan draws the interface.

Features

Game ports, emulators, commercial assets, media, console keys, and compiled app payloads are excluded. Build the included demos from source.

Game ports

These ports are maintained by @ravensclawx in separate repositories:

Set up HBLauncher using Getting started, then follow each port's README for build, installation, and file-server instructions. Both require your own supported game disc image.

Build

Use Linux with Node.js 18+, Python 3 with Pillow, GCC, the AArch64 GNU compiler/binutils, glslang, SPIR-V Tools, and DejaVu fonts. The offline tests also need QEMU user emulation and a Vulkan implementation such as Mesa lavapipe. On Debian/Ubuntu, the dependency packages are:

sudo apt install nodejs python3 python3-pil gcc gcc-aarch64-linux-gnu \
  binutils-aarch64-linux-gnu glslang-tools spirv-tools fonts-dejavu-core \
  qemu-user libvulkan1 mesa-vulkan-drivers

From the repository root:

sh tools/build-all.sh
sh tests/run.sh
./hbl-start --mock

If Node is installed outside PATH, set HBL_NODE to its executable path. The build regenerates the font atlas, shader blobs, and ABI metadata, then builds the launcher, apps, hardware probe, SDK example, and offline preview. Generated binaries and local state are ignored by Git.

To render preview frames after building:

./build/preview/hbl-preview tests/preview/out 6

The preview uses a synthetic catalog. Tests default to the lavapipe ICD at /usr/share/vulkan/icd.d/lvp_icd.json; set VK_ICD_FILENAMES if your system uses a different path.

Console setup

Provide a separate ns2jb-kurumuz checkout and establish the required session. The launcher requires verified 4/4 before mapping native code.

export HBL_NS2JB=/path/to/ns2jb-kurumuz
./hbl-start --preflight
./hbl-start

See Getting started and Recovery for session setup and diagnostics. --spawn --guide additionally requires the external controller tooling described there.

Variable Purpose
HBL_NODE Node executable
HBL_NS2JB External session runner checkout
HBL_APPS Alternate app package directory
HBL_RPC_TARGET Console RPC address
HBL_PICO_TOOL External controller tool for guided setup
HBL_COMPAT_ROOT Optional external legacy compatibility projects

Develop an app

python3 sdk/tools/hbx-new.py apps/my-app "My App"
python3 sdk/tools/hbx-build.py apps/my-app

Read the SDK guide, SDK reference, and raw Vulkan example. The optional Linux personality runtime requires a separately configured musl toolchain and is not built by the default build.

Source layout

Directory Contents
launcher/ Native launcher, navigation, and Vulkan UI
host/ Session management, package loading, and app lifecycle
sdk/ ABI headers, runtime, templates, examples, and build tools
apps/ Original demo source packages
assets/ Font atlas and font license notice
docs/ Architecture, SDK, setup, and recovery guides
tests/ ABI, mock lifecycle, navigation, and rendering checks
tools/ Asset generators and development utilities

Source release

Run python3 tools/package-release.py to create release/hblauncher-native-source.tar.gz from the current source tree. It excludes Git history, build products, local settings, and user app assets, and checks the included files for private workstation identifiers. Use this archive for a fresh public repository; the existing local Git history still contains earlier versions and is not sanitized by deleting working files.

License

MIT, copyright RavensClawX and contributors. The font atlas retains its separate third-party notice. This independent project is not affiliated with or endorsed by Nintendo.

HBLauncher (ravensclawx/HBLauncher)

正在搜索数据库…

这是什么?HBLauncher 是面向 Nintendo Switch 2 的原生 AArch64 自制软件启动器和应用 SDK。它在一个 SmileBASIC 应用进程内运行,且需要已通过验证的会话;界面由 CPU 端代码驱动,并由 Vulkan 负责绘制。
这是现成的启动器应用,还是用来制作我自己自制软件的工具包?两者兼有:它既是一个原生启动器,可在主机上显示带手柄导航的应用目录;也提供带版本号的 SDK ABI、运行时和 UI 库,供你编写可由启动器加载的自制应用。
我要怎样才能在我的 Switch 2 上运行 HBLauncher?你需要在 Linux 上从源代码构建启动器和演示程序(不附带预编译的二进制文件),然后在主机上另外设置一份 ns2jb-kurumuz 检出副本,并先建立所需的已验证会话,启动器才能映射原生代码。
构建它需要先安装什么?需要在 Linux 上安装:Node.js 18+、带 Pillow 的 Python 3、GCC、AArch64 GNU 编译器/binutils、glslang、SPIR-V Tools 和 DejaVu 字体;若要运行离线测试,还需要 QEMU 用户态模拟,以及 Mesa lavapipe 之类的 Vulkan 实现。
这个仓库是否包含游戏移植版、模拟器或现成的游戏文件?没有。游戏移植版、模拟器、商业游戏素材、媒体文件、主机密钥以及已编译的应用载荷都被有意排除在外;只有随附的演示应用会从源代码构建。
没有改装过的真机 Switch 2,我也能试用吗?可以。仓库提供模拟主机后端和离线 Vulkan 预览模式(已在 Mesa lavapipe 上测试),因此你无需真机,也能开发并渲染预览帧。
README 里提到的 Animal Crossing 和 Twilight Princess 移植版是什么?它们是各自独立、由社区维护的游戏移植版(基于 ACGC-PC-Port 和 Dusklight),运行在 HBLauncher 之上。每个都要求你提供自己合法拥有的游戏光盘镜像。
SDK 能让应用开发者开箱即用地获得哪些东西?ABI 头文件、一个独立运行时(涵盖输入、触摸、计时、堆内存和日志)、一个小型 2D UI 库、构建模板,以及一个原始 Vulkan 的 Hello World/Triangle 示例,供你从中开始。
我能为自己的 fork 生成一份脱敏的源码发布包吗?可以。运行 python3 tools/package-release.py 会生成一个发布用的 tar 压缩包,它会去除 Git 历史、构建产物和本地设置,并扫描其余文件中是否含有私人工作站标识符。
大小
25.8 MB
星标
161
时长
26天
提交 · 90 天