From c92a32a5032280f22cd85b58127db526fac6d4f7 Mon Sep 17 00:00:00 2001 From: Shido Date: Wed, 18 Jan 2023 22:14:18 +0100 Subject: [PATCH] Improve readme --- README.md | 179 +++++++++++++++++++++++++----------------------------- 1 file changed, 83 insertions(+), 96 deletions(-) diff --git a/README.md b/README.md index 2888b80a..b333b616 100644 --- a/README.md +++ b/README.md @@ -72,7 +72,7 @@
-

+

About The Project

@@ -91,6 +91,7 @@ (WIP) home interface with multiple instance dl and steam & oculus.

+

Built With

@@ -109,131 +110,117 @@
+
-## Contributing + +
+

Contributing

+

Main Developer


- stats graph - languages graph -

+

Support Developer


- stats graph - languages graph -

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

- -#
Usage
- -## How to install? - -- 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)] +
+ +
+

+

Usage

-## Manage Versions + +
+

How to install?

+
    +
  • Download the latest release from 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 options, launch the version, and more!
    • +
+
-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. + +
+

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. + +
+
+
+ +https://user-images.githubusercontent.com/40648115/213008824-25cfdda3-6350-42dc-aa53-2132b4b8e838.mov +
+ + +
+

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! + +
+
+ +https://user-images.githubusercontent.com/40648115/213008824-25cfdda3-6350-42dc-aa53-2132b4b8e838.mov +
+ + +
+

Install Mods

+ + BSManager allows you to manage Beat Saber mods in a quick and easy way. It uses the BeatMod API to allow you to install, update or uninstall mods for each version of your collection. So the tool can help you manage them efficiently. + +
https://user-images.githubusercontent.com/40648115/213008824-25cfdda3-6350-42dc-aa53-2132b4b8e838.mov - -
-
- -[[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! - + +
+

Install Maps

+ + In addition to managing mods, the tool that allows you to manage and organize custom beatmaps existing on Beat Saver, a popular site for sharing custom beatmaps for beat Saber. The tool allows you to view and organize your beatmaps, as well as link different versions of the game to share all your maps together. + +
-gif with show how to custom your version :) -
-
- -[[Return to top](#readme-top)] +https://user-images.githubusercontent.com/40648115/213008824-25cfdda3-6350-42dc-aa53-2132b4b8e838.mov
-## Install Mods -
-

BSManager allows you to manage Beat Saber mods in a quick and easy way. It uses the BeatMod API to allow you to install, update or uninstall mods for each version of your collection. So the tool can help you manage them efficiently.

-
- + +
+

One Click

+ + The "One-Click" feature of BSManager is an incredibly convenient tool for Beat Saber users. It allows for easy and quick installation of models for all existing versions of Beat Saber. With this system, you will no longer need to spend hours manually installing models for each specific version of Beat Saber. All you need is one simple click to install models on all versions of Beat Saber you own. + +
-gif with show how to dl and update mods + +https://user-images.githubusercontent.com/40648115/213008824-25cfdda3-6350-42dc-aa53-2132b4b8e838.mov
+ + +
+

Having problems?

+ + 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](#readme-top)] - -
- - -## Install Maps -
-

In addition to managing mods, the tool that allows you to manage and organize custom beatmaps existing on Beat Saver, a popular site for sharing custom beatmaps for beat Saber. The tool allows you to view and organize your beatmaps, as well as link different versions of the game to share all your maps together.

-
- -
-gif with show how to dl map :D -
- -
- -[[Return to top](#readme-top)] - -
- -## One Click -

-The "One-Click" feature of BSManager is an incredibly convenient tool for Beat Saber users. It allows for easy and quick installation of models for all existing versions of Beat Saber. With this system, you will no longer need to spend hours manually installing models for each specific version of Beat Saber. All you need is one simple click to install models on all versions of Beat Saber you own. -

- -
-(WIP) gif with oneclick interface an use it -
- -
- -[[Return to top](#readme-top)] - -
- -## Having problems? -
-

-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](#readme-top)] - + [Return to top]

-