Skip to content

Commit

Permalink
Better readme, added screenshot
Browse files Browse the repository at this point in the history
  • Loading branch information
TsilaAllaoui committed Jul 3, 2023
1 parent 347f6ff commit dde999d
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 2 deletions.
32 changes: 30 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,34 @@
# SwitchHomeMenu-React-Tauri

The Nintendo Switch HorizonOS home menu remade with ReactJS + Typescript + Tauri + Rust.
The **Nintendo Switch HorizonOS** home menu remade with **ReactJS + Typescript + Tauri + Rust***.

## Disclaimer
All right related to the Nintendo Switch and games are properties of Nintendo.
- All right related to the Nintendo Switch and games are properties of Nintendo.
- you should add your own owned prod.keys

## Features
- Show all games (NSP) specified path in config.cfg
- Navigate between games in list
- Real time system information displayed: time, connection status, battery file and state
- Launch selected game using yuzu-cmd.exe specified in emu.cfg

## Requirements for building
- Yarn and Tauri
- Rust installed
- nstool.exe, only the version forked in [my repo](https://github.com/TsilaAllaoui/nstool) work because i edited it manually to do what is necessary (should be already included in the release)
- prod.keys (needed to be placed at the same level as nsool.exe and the built binary)
- edit config.cfg and emu.cfg for paths

## Building
- Just run yarn tauri dev to test locally and debug or yarn tauri build to build binary file

## Credits
- [jakcron](https://github.com/jakcron) for his version of [nstool](https://github.com/jakcron/nstool) that i have forked

## Screenshots

![pic1](./screenshots/picture.png)

## Future features
- Add controller (xbox, joycons, pro controller) support
- Add user and HorizonOS settings navigation
Binary file added screenshots/picture.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit dde999d

Please sign in to comment.