mirror of
https://github.com/InstanceBrick/nightcap.git
synced 2026-10-17 20:00:46 +02:00
63 lines
3.0 KiB
Markdown
63 lines
3.0 KiB
Markdown
<div align="center">
|
||
<img src="packaging/io.github.CoderDayton.nightcap.svg" alt="Nightcap logo" width="128">
|
||
<h1>Nightcap Roblox VR for Steam Frame</h1>
|
||
</div>
|
||
|
||
Native ARM64 Roblox VR for Steam Frame, with eye-tracked foveated rendering,
|
||
controller input and SteamVR integration.
|
||
|
||
The standard video profile is **native 2160 × 2160 per eye**, **72 Hz**,
|
||
**SMAA High** and **Performance** foveation. Frame rate depends on the Roblox
|
||
experience and its graphics settings; 72 FPS is the target.
|
||
|
||
## Features
|
||
|
||
- Native ARM64 execution through Nightcap's Android compatibility layer.
|
||
- Stereo OpenXR rendering, head tracking, VR controllers, haptics and an
|
||
in-headset keyboard.
|
||
- Direct eye tracking with a full-detail gaze region and gradual reductions in
|
||
peripheral shading quality.
|
||
- Adjustable gaze radius and Quality, Balanced and Performance foveation modes.
|
||
- Gaze-only FXAA, SMAA Low and SMAA High anti-aliasing.
|
||
- Native-resolution rendering with a 2160 × 2160 per-eye recommended default.
|
||
- Roblox's internal frame-rate cap follows the selected headset refresh rate.
|
||
- Renderer and session handling across menu, game and game-to-game transitions.
|
||
- Native microphone capture bridge for Roblox voice chat.
|
||
- One **Nightcap Roblox VR** Steam entry with the original Nightcap icon and an
|
||
optional desktop mirror. The mirror is off by default on Steam Frame.
|
||
- Simple **Foveated Rendering**, **Gaze sharp radius** and **Anti Aliasing**
|
||
controls in SteamVR's Video settings.
|
||
- Optional in-headset performance overlay with actual game FPS, headset Hz,
|
||
frame time, GPU time and current per-eye resolution.
|
||
|
||
## Install
|
||
|
||
Install the native ARM64 build from [Releases](https://github.com/InstanceBrick/nightcap/releases),
|
||
or build it on the Frame using the [installation guide](docs/INSTALL.md).
|
||
The ARM64 package contains Nightcap and its open-source runtime dependencies.
|
||
Roblox is downloaded separately on the device. Roblox binaries, account data,
|
||
SteamVR files and the Frame's graphics drivers are not included in the package.
|
||
|
||
Current ARM64 client support: **2.742.1059 (3222)** and **2.736.1408 (2998)**.
|
||
|
||
- [Installation and updates](docs/INSTALL.md)
|
||
- [Video, input and microphone settings](docs/SETTINGS.md)
|
||
- [Building and source layout](docs/DEVELOPMENT.md)
|
||
|
||
## About this fork
|
||
|
||
The `steam-frame` branch is the Steam Frame edition of the `vr` branch of
|
||
[CoderDayton/nightcap](https://github.com/CoderDayton/nightcap), itself a fork of
|
||
[komaruworld/mocktail](https://github.com/komaruworld/mocktail). It adds the native
|
||
ARM64 VR bridge and Frame rendering, input, audio and Steam integration changes.
|
||
The original Nightcap artwork is retained. Internal executable and configuration
|
||
names keep `mocktail` for compatibility with the upstream source.
|
||
|
||
## License
|
||
|
||
[Apache License 2.0](LICENSE). Original copyright notices and third-party
|
||
licenses remain in their source directories. See [third-party credits](THIRD_PARTY.md).
|
||
|
||
Nightcap is an independent community project and is not affiliated with Roblox
|
||
Corporation or Valve.
|