https://github.com/legoandmars/BeatSaberCustomNotes

Adds custom notes to beat saber
https://github.com/legoandmars/BeatSaberCustomNotes

Last synced: 5 days ago
JSON representation

Adds custom notes to beat saber

• Host: GitHub
• URL: https://github.com/legoandmars/BeatSaberCustomNotes
• Owner: legoandmars
• License: mit
• Created: 2019-04-13T03:20:06.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-03-12T15:58:37.000Z (8 months ago)
• Last Synced: 2024-08-03T11:08:55.589Z (3 months ago)
• Language: C#
• Size: 766 KB
• Stars: 42
• Watchers: 9
• Forks: 16
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# BeatSaberCustomNotes

CustomNotes adds the ability to swap out the default notes with custom ones in Beat Saber.

# Installation Instructions

Download the latest version of CustomNotes from any current mod manager or the [Github releases page](https://github.com/legoandmars/BeatSaberCustomNotes/releases/).

You can install custom note files (`.bloq` files) in the `CustomNotes` folder found in your game's directory. If this folder doesn't exist, make sure to run the game with the mod installed so it can be automatically generated.

To change which note model is used, simply select a different note in the CustomNotes mod tab in-game.

## Notice

While a custom note is being used AND you are either playing with the "Ghost Notes" or "Disappearing Arrows" modifier turned on, score submission will be temporarily disabled.

By switching to the default notes, enabling "Auto Disable Custom Notes" or turning off these modifiers, score submission will be re-enabled. No need for a game restart!

## For modelers

The Unity Project to create custom notes can be found [here](https://github.com/legoandmars/CustomNotesUnityProject)

Documentation on how to use the Unity Project can be found on the [BSMG Wiki](https://bsmg.wiki/models/notes-guide.html)

## For developers

### Contributing to CustomNotes

In order to build this project, please create the file `CustomNotes.csproj.user` and add your Beat Saber directory path to it in the project directory.

This file should not be uploaded to GitHub and is in the .gitignore.

```xml

  

    

    E:\Program Files (x86)\Steam\steamapps\common\Beat Saber

  

```

If you plan on adding any new dependencies which are located in the Beat Saber directory, please edit the paths to use `$(BeatSaberDir)` in `CustomNotes.csproj`

```xml

...

  $(BeatSaberDir)\Plugins\SiraUtil.dll

  $(BeatSaberDir)\Beat Saber_Data\Managed\IPA.Loader.dll

...

```