Skip to content

Latest commit

 

History

History
34 lines (29 loc) · 2.19 KB

README.md

File metadata and controls

34 lines (29 loc) · 2.19 KB

Nya

A BeatSaber mod for displaying nya-tastic images from various web APIs

Usage

Accessing Nya's Settings

Nya's settings can be accessed from the ⚙️ button, pressing this will bring up a modal for common settings, such as the currently selected API. Further settings can be accessed from the ➕ tab.

Alternatively settings can also be accessed from BSML's Mod Settings view.

Resetting Nya's Floating Screen Position

Nya features a floating screen, allowing Nya to be accessed outside of the gameplay setup panel. In the event that this floating screen gets stuck somewhere inaccessible it's position can be reset from Nya's settings.

Supported Image Sources

Note: I don't own any of these sources so I can't guarantee the images will always be appropriate

Local Files

Nya can load images which are saved within Beat Saber\UserData\Nya\sfw and Beat Saber\UserData\Nya\nsfw. Additionally Nya will treat any subfolders in these directories as 'endpoints', meaning you can switch from local files saved in different folders.

Local Files Example

Nya will only load images with the file type of png, jpg, jpeg, gif or apng.

Images which are downloaded via Nya will be saved in the sfw / nsfw folders.

Installation

Install the latest version of Nya and the dependencies listed below.

Dependencies

Contribution

Feel free to point out any suggestions or improvements by submitting a PR or contacting me on Discord (Sirspam#7765).

Nya Gif