Skip to content

Commit

Permalink
Updated Documentation
Browse files Browse the repository at this point in the history
- Guides folder is back with GettingStarted.md
- Readme update for version bump
  • Loading branch information
rithik-b committed May 30, 2021
1 parent c98a07b commit be479db
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 1 deletion.
31 changes: 31 additions & 0 deletions Guides/GettingStarted.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
## Features & How to access them
- Add custom songs and OST songs to playlists
- Create playlists

![Add song to playlist](https://github.com/rithik-b/PlaylistManager/blob/master/img/add.gif?raw=true)
- Remove songs from playlists

![Remove song from playlist](https://github.com/rithik-b/PlaylistManager/blob/master/img/remove.gif?raw=true)
- Edit the title, author and cover image

![Edit the title, author and cover image](https://github.com/rithik-b/PlaylistManager/blob/master/img/details.gif?raw=true)
- Delete playlists
- Download missing songs in playlists

![Delete and Download](https://github.com/rithik-b/PlaylistManager/blob/master/img/view.png?raw=true)
- View playlists in 4 categories
- All playlists and music packs: This shows the custom levels and WIP levels folders that you've made in addition to all playlists you have
- All music packs: This only shows any custom levels and WIP levels folders that you've made which is how the game would show without PlaylistManager installed
- All playlists: This only shows all playlists
- Folders: All your playlists organized in folders

![Categories](https://github.com/rithik-b/PlaylistManager/blob/master/img/categories.gif?raw=true)
- Create folders to store playlists in
- Delete folders

![Folders](https://github.com/rithik-b/PlaylistManager/blob/master/img/folders.gif?raw=true)
- Settings Menu: There is a settings menu under "Mod Settings" with various settings such as changing your playlist author name or turning off the categories menu. The settings are listed in-game and explained if you hover over the setting.
- Refresh Playlists and Custom Songs Button: On the "Mods" menu on the left of the title screen when you start the game.
## Directory Information
To load playlists, store all playlists in the "Playlists" folder in your Beat Saber install. You may also create folders inside the Playlists folder to further organize your playlists. Supported formats are `.json`, `.bplist` and `.blist`
Cover images go into the "Playlists\CoverImages" folder and the supported formats are `.jpg` and `.png`
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,13 @@ Load, Create, Edit, Organize Playlists and Download their Songs in Beat Saber.
- Sync some playlists with the internet (example map pools)

## Download
Download the latest version of the mod (v1.0.0) [here](https://github.com/rithik-b/PlaylistManager/releases/tag/1.0.0 "here").
Download the latest version of the mod (v1.1.1) [here](https://github.com/rithik-b/PlaylistManager/releases/tag/1.1.1 "here").
To install, move the dll to your Plugins folder.

**SongCore**, **BeatSaverSharp**, **BeatSaberMarkupLanguage (BSML)**, **SiraUtil** and **BeatSaberPlaylistsLib** are required for this mod, so please download the latest version from ModAssistant.

## Usage instructions
To view instructions on how to access all the features of the mod, [click here.](https://github.com/rithik-b/PlaylistManager/blob/master/Guides/GettingStarted.md)
To load playlists, store all playlists in the "Playlists" folder in your Beat Saber install. You may also create folders inside the Playlists folder to further organize your playlists. Supported formats are `.json`, `.bplist` and `.blist`
Cover images go into the "Playlists\CoverImages" folder and the supported formats are `.jpg` and `.png`

Expand Down

0 comments on commit be479db

Please sign in to comment.