From b2510645e5284a46ca011c690ea4d191ca3e59dd Mon Sep 17 00:00:00 2001 From: Shido Date: Wed, 18 Jan 2023 02:17:32 +0100 Subject: [PATCH] Improve readme --- README.md | 228 ++++++++++++++++++++++++++++++++---------------------- 1 file changed, 137 insertions(+), 91 deletions(-) diff --git a/README.md b/README.md index 8f5be79f..2f1a0f15 100644 --- a/README.md +++ b/README.md @@ -9,45 +9,54 @@ *** https://www.markdownguide.org/basic-syntax/#reference-style-links --> + +
- - Logo - -

-

BSManager

- (Beat Saber Manager) -

- Download, manage and customize your versions of Beat Saber with a simple click! -
- Report Bug - · - Request Feature -
-

+ + Logo + +

+

BSManager

+ (Beat Saber Manager) +

+ + Download, manage and customize your versions of Beat Saber with a simple click! + +
+ + Report Bug + · + Request Feature +
-
-Stargazers -Forks -License -Contributors -GitHub issues + + +---
-discord -Donation -Twitter -

-

[go to bot]

+
+ Stargazers + Forks + License + Contributors + GitHub issues +
+ discord + Donation + Twitter +
+ [go to bot]
-

+ +--- - Table of Contents -
    +Table of Contents +
- + + -

- -#
About The Project
+
-(WIP) home interface with multiple instance dl and steam & oculus. +

+

About The Project

+
+
+ BSManager was created to unify and improve the two most used tools in the community (BS legacy launcher and Mod Assistant). +

+

BSManager will allow you to:

+
    +
  • Manage instances of multiple versions, designed for people who need to play on different versions or have multiple profiles for the same version.
    • +
  • Download your maps in the same way, in addition to that, the maps are not version dependent, so you will be able to find your maps whatever version you are using without having to transfer them.
    • +
  • Install your mods in one click, just like Mod Assistant, BSManager will allow you to install your mods quickly and securely depending on the version you choose.
    • +
  • Customize your interface, we know that some of you like to customize your interfaces to the maximum. That's why BSManager brings you peace of mind on this point, you can change the name of the versions, their color, and you can even change the color of the logo! Of course, a dark theme has been added to protect your eyes at night.
    • +

-

BSManager was created to unify and improve the two most used tools in the community (BS legacy launcher and Mod Assistant). - -

BSManager will allow you to:

- -

+
+ (WIP) home interface with multiple instance dl and steam & oculus. +

- -## Built With - -

[Return to top]

+ +
+

Built With

+
    +
  • + Electron React Boilerplate +
    • +
  • + Depot Downloader +
    • +
  • + RxJs +
    • +
  • + TailWind CSS +
    • +
+
## Contributing @@ -104,48 +116,66 @@

Main Developer


-

+ stats graph + languages graph +

Support Developer


- ‎ ‎ ‎ ‎ ‎ - + stats graph + languages graph +

+ stats graph + languages graph +
+
+ [Return to top]
-

[Return to top]

#
Usage
## How to install? -
- -

[Return to top]

+ +- Download the latest release from [Releases](https://github.com/Zagrios/bs-manager/releases). +- Execute the installer and [BSManager](../..) will start itself. +- Once its done if you want to download a version, select a version and download it! +From the version page you can choose launch options, launch the version, and more from the dropdown menu! + + +
+ +[[Return to top](#readme-top)] + +
## Manage Versions -
-

BSManager allows you to manage your versions of Beat Saber. It gives you the ability to download any version of Beat Saber as long as you have a Steam account that already owns the game. Using BSManager, you can easily manage and update your collection of Beat Saber versions.

-
+ +BSManager allows you to manage your versions of Beat Saber. It gives you the ability to download any version of Beat Saber as long as you have a Steam account that already owns the game. Using BSManager, you can easily manage and update your collection of Beat Saber versions. +
https://github.com/Zagrios/bs-manager/blob/feature/readme-update/resources/readme/manageVersions.mov
-

[Return to top]

+
+ +[[Return to top](#readme-top)] + +
## Customize your instances -

The tool will allow you to completely customize each of your downloadable versions, you can change the color of the icon, choose a name for the instance and finally install your mods and map according to the Beat Saber version!

-
+ +The tool will allow you to completely customize each of your downloadable versions, you can change the color of the icon, choose a name for the instance and finally install your mods and map according to the Beat Saber version! +
gif with show how to custom your version :)
-

[Return to top]

+
+ +[[Return to top](#readme-top)] + +
## Install Mods
@@ -155,7 +185,11 @@ https://github.com/Zagrios/bs-manager/blob/feature/readme-update/resources/readm
gif with show how to dl and update mods
-

[Return to top]

+
+ +[[Return to top](#readme-top)] + +
## Install Maps @@ -167,7 +201,11 @@ https://github.com/Zagrios/bs-manager/blob/feature/readme-update/resources/readm gif with show how to dl map :D -

[Return to top]

+
+ +[[Return to top](#readme-top)] + +
## One Click

@@ -178,7 +216,11 @@ The "One-Click" feature of BSManager is an incredibly conve (WIP) gif with oneclick interface an use it -

[Return to top]

+
+ +[[Return to top](#readme-top)] + +
## Having problems?
@@ -186,7 +228,11 @@ The "One-Click" feature of BSManager is an incredibly conve See the open issues for a list of known issues, from there you can create a new issue for the problem you have! Otherwise you can add on to existing issues if one matches what you're encountering.

-

[Return to top]

+
+ +[[Return to top](#readme-top)] + +