Repository navigation
Azahar for Frame 1.0.0
Nintendo 3DS games in VR, running natively on the Valve Steam Frame. Azahar for Frame is the Azahar emulator with the VR modes of amwatson's CitraVR, built for SteamVR and the Frame controllers. You need your own games; no game data is included.
Compared with CitraVR through Lepton and similar forks
- It runs natively on the Frame. There is no Android layer, APK or adb.
- It starts in under a second.
- Far less work per frame. In Ocarina of Time 3D at 120 Hz with a 4K texture pack: 0.6 ms of CPU and 1.5 ms of GPU time, against 4.8 ms and 2.7 ms.
- Less work for the chip means better battery life.
- Texture packs load as ASTC with no stutter. CitraVR loads PNGs and stalls while it decodes them.
The emulator on the Frame
- A native OpenXR app in the Frame's SteamVR, at 120 Hz, or 90 Hz if you prefer.
- The release brings its own Qt and libraries. It runs on SteamOS Stable, Beta and Preview.
- Play in VR on 3D screens, in immersive VR with head tracking, or flat on SteamVR's big screen.
- Settings, saves, keys and shader caches are in one folder,
~/.local/share/AzaharFrame.
The screens
- Grip a screen to move both. The stick of that hand moves them nearer or farther, and makes them bigger or smaller, up to 3 times: big enough to fill the whole view.
- While you hold them, the D-pad nudges them half a degree at a time, for a big screen with an edge just out of view.
- Tap the right stick click to swap the screens. Hold it for a second to put them back.
- Tap the left stick click to hide or show the other screen.
- Hide Bottom Screen, per game, for games that do not need it. Both bumpers and View bring it back.
- Screen Shape, per game: 5:3, 16:9, 21:9, 4:3, 3:2 or 16:10, for mods and cheats that change the game's aspect. A change shows at once.
- Background: black, or passthrough to see the room. The in-game menu has a button for it.
Immersive mode
- Grip the immersive screen and move your hand to raise or lower it. The stick of that hand moves it nearer or farther, and makes it bigger or smaller.
- The screen position is remembered for each game.
- SteamVR's recenter (hold the Steam button) also re-centres the immersive view.
- The default size keeps the HUD within the clear centre of the lenses. You can make the screen up to 2.5 times bigger.
- While you hold it, the D-pad shifts it half a degree at a time. Immersive Offset is global, since it corrects for small differences in each user's IPD.
- Wider View, per game, shows more of the game around a bigger screen.
- Squeeze Width, per game, makes the screen 10 or 20% narrower, to bring HUD elements at the sides into view.
- In future updates I may extend this, or add game-specific cheats or mods that move the HUD.
- Immersive Game FOV, per game, for mods that change the game's field of view. A change shows at once.
- Mario Kart 7, Super Mario 3D Land and Asphalt 3D start in Full (6DoF) mode, set up for each game.
Controls
- The Steam Frame controllers, with the real D-pad.
- The face buttons go by position, as on a 3DS. Face Buttons switches them to by label.
- A trigger aimed at the bottom screen is a touch. Anywhere else it is ZL or ZR. Each hand decides on its own.
- Hold View, then the right bumper, to Quick Save. Hold View, then the left bumper, to Quick Load.
- Hold View, then pull the right trigger, to turn Fast Forward on or off. "Fast Forward" or "Normal Speed" shows for 2 seconds.
- Hold Menu for a second to open the in-game menu: Azahar's window over the paused game. It has Quick Save, Quick Load and Passthrough buttons.
- Hold View for 1.5 seconds to stop the game.
- The right controller is the 3DS's gyroscope, for games that aim by moving the 3DS.
- A Controls panel shows both controllers, with a line from each button to what it does. It has a page for the game and one for Azahar's window.
- A Stats panel shows the frame rate, the emulation speed and the frame times.
- The Frame controllers show in your hands, with soft beams that fade when you put them down.
- The layout is a controls profile in Azahar's window, so you can change it.
VR and Flat
- Press both bumpers, View and Menu to switch between VR and a flat window. The game keeps running.
- In Flat, Azahar's window sits on SteamVR's big screen, the theater. It stays there when you close the dashboard.
- In Flat the controllers work as in VR, with the same holds and combos. A tap of View or Menu is still Select or Start.
- In Flat the window is 16:9, so it fills the big screen with no bars at the sides.
- In Flat, hold Menu for a second to open the Flat menu: the game pauses and the window leaves Fullscreen with its menu bar, so the pointer reaches Azahar's menus and settings. Hold Menu again, press B or select Emulation > Continue to go back.
- In Flat the stick clicks change the window's layout. Tap the right one to swap the screens and the left one to show only one screen. Hold the right one to go back to Large Screen, one big screen and one small, which is where Flat starts. VR keeps your own layout.
- The next start uses the mode you used last.
Texture packs
- Optimize Texture Pack for Frame in the game list converts a PNG pack to ASTC, so it loads with no stutter.
- Use Original Texture Pack switches it back to how it was before.
- Packs that ship DDS or KTX files keep their own mip levels.
Install
- An installer that adds the library entry with its art, names the SteamVR dock entry, and sets SteamVR to 120 Hz with no motion smoothing. It sets them again at every launch.
install.sh --dry-runshows what it would do first.- Installing again updates the same entry. Your settings, saves and keys stay.
- It installs and updates through Frametanium and FrameDrop too.
- An uninstaller, with
--purgefor your data.
From Azahar and CitraVR
- The emulation, the game list and the settings are Azahar 2127.0-alpha4's, and the 3D screens and immersive modes are CitraVR's. Thanks to the Azahar team and amwatson.
Download
azaharframe-1.0.0-linux-arm64.tar.gz: the release, forinstall.shand Frametaniumazaharframe-1.0.0-framedrop-linux-arm64.zipandazaharframe.framedrop.json: the same release, for FrameDrop
Install
Download the tarball and run steam-frame/install.sh from the repository with it as the argument. You can also add simplysanatori/AzaharFrame in Frametanium, or install with FrameDrop. An update keeps your settings, saves and keys. The README has the steps and the main controls. The user guide has how to add your games, every control and every setting.
Known
- Mario Kart 7's menus show white panels in Full (6DoF): Other Games mode.
Reporting problems
Open an issue with what you did, what you expected and what happened, and attach launch.log and user/log/azahar_log.txt from ~/.local/share/AzaharFrame. They hold the paths of your games, which include your user name. Read them first.