From 439e2d4bc2a5373053c0ef7e966e373b63f7d154 Mon Sep 17 00:00:00 2001 From: leogandmars Date: Thu, 21 Jan 2021 22:05:20 -0800 Subject: [PATCH] update README.md --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 58cf70a..abfea29 100644 --- a/README.md +++ b/README.md @@ -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! @@ -27,7 +29,7 @@ This file should not be uploaded to GitHub and is in the .gitignore. ``` -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 ...