diff --git a/README.md b/README.md index d4340f5e..d68590a8 100644 --- a/README.md +++ b/README.md @@ -9,242 +9,576 @@ *** 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 - · - Report a security vulnerability - + + Logo + +

BSManager

+

+ Download, manage and customize your versions of Beat Saber with a simple click! +

+

+ Report + Bug + · + Request + Feature + · + Report a security vulnerability +

+
-## -
-
- Stargazers - Forks - License - Contributors - GitHub issues -
- discord - Donation - Twitter -
+ +
+ Stargazers + Forks + License + Contributors + GitHub issues +
+ discord + Donation + Twitter +
+ + +
+
+
+ Table of Contents + +
+
[Go to bottom] +
---- - + +
+
+

BSManager: Your Beat Saber Assistant

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

How to install?

+ +
-
-

-

About The Project

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

-

BSManager will allow you to:

- -
-
+ + +
- preview +
+

Version management

-
- -
-

Built With

- +

With BSManager, manage your Beat Saber versions with ease, allowing the download of new versions and + preserving + existing ones, provided that you own the game on a Steam or Oculus (PC) account.

+
+ + + +
+

Downloading Multiple Versions

+

BSManager provides two authentication methods to access your + Steam account, ensuring safe and flexible access to + different game versions:

-
-
-

-

Usage

+
-
-

How to install?

-
-
- -
-

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 versions

- - BSManager will allow you to completely customize each of your downloaded versions, you can change the color of the icon, choose a name for the version and finally install your mods,maps and other contents according to the Beat Saber version! - +
-
+
- -https://user-images.githubusercontent.com/40648115/213296794-74a1e20b-12dc-44ec-a67f-e25d7010bd3d.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 app can help you manage them efficiently. - +

Multi-Version Sharing

+

BSManager facilitates the sharing of your maps, models, and + custom files between different versions of Beat Saber. Thanks to an intuitive user interface, you can easily share + your files from one version to another, ensuring a consistent and continuous gaming experience across all your + installations.

-
+
- -https://user-images.githubusercontent.com/40648115/213296816-bdaafc90-da76-4835-8d83-9ac6a4e1c549.mov - +
- + +
-

Install Maps

- - In addition to managing mods, BSManager allows you to manage and organize custom beatmaps existing on Beat Saver, a popular site for sharing custom beatmaps for beat Saber. Moreover the app allow you to share your maps across all your versions. - +

Importing an Existing Version of Beat Saber

+

BSManager allows easy importing and organizing of your existing + versions of Beat Saber, enabling you to retain + all your previously downloaded or created data while taking advantage of BSManager's management features.

-
+
- -https://user-images.githubusercontent.com/40648115/213296838-f775fe83-866d-4764-a7d0-648dbb8ec983.mov - +
- + +
-

One Click

- - The "One-Click" feature of BSManager is an incredibly convenient feature for Beat Saber users. It allows easy and quick installation of models, maps and playlists for all versions of Beat Saber you own. - +

Launch Arguments

+

BSManager provides efficient management of Beat Saber launch arguments, including three predefined ones to + enhance your gaming experience:

+ +

You also have the freedom to add your own custom launch arguments by inserting them into "Advanced Launch" and + separating them with a semicolon (;).

-
+
- -https://user-images.githubusercontent.com/40648115/213435051-7feb815d-f32b-4135-b095-ef49726a836c.mov - +
- + +
-

Having problems?

- - See the open issues to show the list of known issues, from there you can create a new issue for your problem! - +

Shortcut Creation

+

Create shortcuts to easily access your different versions of Beat Saber with + BSManager. After selecting your + version, go to the version settings, click on "Create a Shortcut", and then select your launch options. Thus, + you can quickly and easily launch your preferred version of Beat Saber with the + desired settings.

-


+
+
- + + +
+
+

Download and Installation

+
-

Credits

- +

BSManager provides centralized and organized management of + beatmaps, mods, and models, integrating download features and sharing between Beat + Saber versions.

- -
- +
-

Contributing

-

- If you'd like to contribute, check out the contributing guide -

-

Thank you to all the people who already contributed to BSManager!

-
- - - -
+

Maps

+

BSManager integrates the Beat + Saver API to provide you with a comprehensive list of maps downloadable directly from its interface. Moreover, + the OneClick feature allows you to download maps with one click from various sources such as Beat Saver, BeastSaber, ScoreSaber, and Beat Leader. To add + maps, simply select the desired version or the "shared" tab, then click "ADD".

-
+
+
+ + +
+

Playlists

+

Although the playlist management interface is not yet developed, BSManager offers a OneClick feature for playlists from Beat Saver.

+
+ +
+
+ + +
+

Mods

+

Manage your mods easily with BSManager. After downloading a + version, navigate to the "Mods" tab of the selected version to manage and install mods. BSManager operates similarly to Mod Assistant and offers the same + mods as this tool.

+
+ +
+
+ + +
+

Models

+

Add and manage models simply via the corresponding tab on the desired version or by going to the "shared" tab. The + Model Saber API is integrated to provide easy and direct access to models + available for Beat Saber.

+
+ +
+
+ + + +
+
+

Customization

+
+
+

BSManager offers various options to customize both the tool + itself and your Beat Saber instances, allowing you to create a user experience + that is uniquely yours.

+
+ + +
+

Tool

+

Adjust the appearance of BSManager to your preferences with a + variety of customization options available in the tool's settings:

+ +
+ +
+
+ + +
+

Beat Saber Instance

+

For each Beat Saber instance, BSManager offers customization options accessible via the version + settings and by clicking on "Edit":

+ +
+ +
+
+ + + +
+
+

More Information

+
+
+

BSManager has an active community and a support team ready to + assist you with any questions or issues you may encounter.

+
+ + +
+

Support

+

For quick and interactive support, it is recommended to join our Discord + server. For bugs or more complex issues, you can also submit an issue on + GitHub.

+
+ + + +
+

Credits

+ +
+ + +
+

Contributing

+

If you'd like to contribute, check out the contributing guide.

+

Thank you to all the people who already contributed to BSManager!

+
+ + + +
+
+ + +
- [Return to top] + [Return to top] +
-

diff --git a/resources/readme/MOV/BSManager _ All in one tool for BeatSaber.mov b/resources/readme/MOV/BSManager _ All in one tool for BeatSaber.mov new file mode 100644 index 00000000..b4f03173 Binary files /dev/null and b/resources/readme/MOV/BSManager _ All in one tool for BeatSaber.mov differ diff --git a/resources/readme/beat-conflict.png b/resources/readme/PNG/beat-conflict.png similarity index 100% rename from resources/readme/beat-conflict.png rename to resources/readme/PNG/beat-conflict.png diff --git a/resources/readme/beat-running.png b/resources/readme/PNG/beat-running.png similarity index 100% rename from resources/readme/beat-running.png rename to resources/readme/PNG/beat-running.png diff --git a/resources/readme/icon.png b/resources/readme/PNG/icon.png similarity index 100% rename from resources/readme/icon.png rename to resources/readme/PNG/icon.png diff --git a/resources/readme/preview.png b/resources/readme/PNG/preview.png similarity index 100% rename from resources/readme/preview.png rename to resources/readme/PNG/preview.png diff --git a/resources/readme/icon.svg b/resources/readme/SVG/icon.svg similarity index 100% rename from resources/readme/icon.svg rename to resources/readme/SVG/icon.svg