Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Sirspam/Nya
A BeatSaber mod for displaying nya-tastic images from various web APIs
https://github.com/Sirspam/Nya
beatsaber
Last synced: 5 days ago
JSON representation
A BeatSaber mod for displaying nya-tastic images from various web APIs
- Host: GitHub
- URL: https://github.com/Sirspam/Nya
- Owner: Sirspam
- License: mit
- Created: 2021-08-18T20:49:47.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-16T21:28:19.000Z (about 1 month ago)
- Last Synced: 2024-10-18T21:18:39.717Z (29 days ago)
- Topics: beatsaber
- Language: C#
- Homepage:
- Size: 42.1 MB
- Stars: 26
- Watchers: 1
- Forks: 12
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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**
* [Waifu.Pics](https://waifu.pics/)
* [Nekos.Life](https://nekos.life/)
* [Anime-Images API](https://anime-api.hisoka17.repl.co/)
* [Catboys](https://catboys.com/)
* [BocchiTheAPI](https://bocchi.pixelboom.dev/)
* [Local Files](#local-files)
### 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.
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](https://bsmg.wiki/pc-modding.html#install-mods) the latest version of [Nya](https://github.com/Sirspam/Nya/releases/latest) and the dependencies listed below.
### Dependencies
* [SiraUtil](https://github.com/Auros/SiraUtil) _- Available in ModAssistant_
* [BeatSaberMarkupLanguage](https://github.com/monkeymanboy/BeatSaberMarkupLanguage) _- Available in ModAssistant_
## Contribution
Feel free to point out any suggestions or improvements by submitting a PR or contacting me on Discord ([Sirspam#7765](https://discordapp.com/users/232574143818760192)).
