Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
legoandmars committed Jan 22, 2021
1 parent b5648e8 commit 439e2d4
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,14 @@
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.
Download the latest version of CustomNotes from any current mod manager or the [Github releases page](https://github.com/legoandmars/BeatSaberCustomNotes/releases/).

To change which note model is used, simply select a different note in the Mod settings for CustomNotes in-game.
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, high-score submission will be temporarily disabled.
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 or turning off these modifiers, score submission will be re-enabled. No need for a game restart!

Expand All @@ -27,7 +29,7 @@ This file should not be uploaded to GitHub and is in the .gitignore.
</Project>
```

If you plan on adding any new dependencies which are located in the Beat Saber directory, it would be nice if you edited the paths to use `$(BeatSaberDir)` in `CustomNotes.csproj`
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
...
Expand Down

0 comments on commit 439e2d4

Please # to comment.