From 141d9aaf1dc6d9088788955936102fed755228d5 Mon Sep 17 00:00:00 2001 From: GaetanGrd <40648115+GaetanGrd@users.noreply.github.com> Date: Mon, 9 Oct 2023 19:37:19 +0200 Subject: [PATCH 01/36] adding "BSManager: Your Beat Saber Assistant" --- README.md | 87 ++++++++++++++++++++++++++++++++++++------------------- 1 file changed, 58 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index d4340f5e..b8cac2fe 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,9 @@ *** https://www.markdownguide.org/basic-syntax/#reference-style-links --> - + +
Logo @@ -53,47 +55,74 @@ Table of Contents - +

-

About The Project

+

BSManager: Your Beat Saber Assistant

- 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:

- +

BSManager: Your Beat Saber Assistant

+

What is it?

+

BSManager simplifies your Beat Saber experience by centralizing the management of mods, maps, and game versions in one place.

+

Why use it?

+ +Start your enhanced experience with Beat Saber and explore all the features offered by BSManager! +

- preview + [![Watch the video](https://www.youtube.com/watch?v=m9-WRRSSt3A)](https://www.youtube.com/watch?v=m9-WRRSSt3A)

From bfbf669c091ba2c1878f699574209ad3a5ee6b4f Mon Sep 17 00:00:00 2001 From: GaetanGrd <40648115+GaetanGrd@users.noreply.github.com> Date: Mon, 9 Oct 2023 19:51:58 +0200 Subject: [PATCH 02/36] attempted resolution 01 - use YT video on github readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b8cac2fe..614c6541 100644 --- a/README.md +++ b/README.md @@ -122,7 +122,7 @@

- [![Watch the video](https://www.youtube.com/watch?v=m9-WRRSSt3A)](https://www.youtube.com/watch?v=m9-WRRSSt3A) + https://www.youtube.com/watch?v=m9-WRRSSt3A

From bf9c12c0270e95d543289572c75b8ae870290d7d Mon Sep 17 00:00:00 2001 From: GaetanGrd <40648115+GaetanGrd@users.noreply.github.com> Date: Mon, 9 Oct 2023 19:55:08 +0200 Subject: [PATCH 03/36] attempted resolution 02 - use YT video on github readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 614c6541..0a56c272 100644 --- a/README.md +++ b/README.md @@ -122,7 +122,7 @@
- https://www.youtube.com/watch?v=m9-WRRSSt3A + [![IMAGE ALT TEXT HERE](https://img.youtube.com/vi/m9-WRRSSt3A/0.jpg)](https://www.youtube.com/watch?v=m9-WRRSSt3A)

From c8da0f4a46ae4aad705c521068a606ff41426a2a Mon Sep 17 00:00:00 2001 From: GaetanGrd <40648115+GaetanGrd@users.noreply.github.com> Date: Mon, 9 Oct 2023 20:01:24 +0200 Subject: [PATCH 04/36] attempted resolution 03 - use YT video on github readme --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0a56c272..d8670536 100644 --- a/README.md +++ b/README.md @@ -122,7 +122,8 @@
- [![IMAGE ALT TEXT HERE](https://img.youtube.com/vi/m9-WRRSSt3A/0.jpg)](https://www.youtube.com/watch?v=m9-WRRSSt3A) +

From 52d973c18960cbb196a08ce5cfb2f0f6aa14da7f Mon Sep 17 00:00:00 2001 From: GaetanGrd <40648115+GaetanGrd@users.noreply.github.com> Date: Mon, 9 Oct 2023 20:22:24 +0200 Subject: [PATCH 05/36] attempted resolution 04 - use YT video on github readme --- README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/README.md b/README.md index d8670536..261ef32a 100644 --- a/README.md +++ b/README.md @@ -122,9 +122,7 @@
- -
+[![Miniature de la vidéo](https://img.youtube.com/vi/m9-WRRSSt3A/0.jpg)](https://www.youtube.com/watch?v=m9-WRRSSt3A)
From 5836a0a7d1dfbd541d3903062f65d1a98d0590ea Mon Sep 17 00:00:00 2001 From: GaetanGrd <40648115+GaetanGrd@users.noreply.github.com> Date: Mon, 9 Oct 2023 20:23:27 +0200 Subject: [PATCH 06/36] attempted resolution 05 - use YT video on github readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 261ef32a..401c7d49 100644 --- a/README.md +++ b/README.md @@ -122,7 +122,7 @@
-[![Miniature de la vidéo](https://img.youtube.com/vi/m9-WRRSSt3A/0.jpg)](https://www.youtube.com/watch?v=m9-WRRSSt3A) +[![Miniature de la vidéo]](https://www.youtube.com/watch?v=m9-WRRSSt3A)
From 91f273926219f84bbc8e9e832ced4cec8b9629cf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ga=C3=ABtan=20Gerard?= <40648115+GaetanGrd@users.noreply.github.com> Date: Tue, 10 Oct 2023 21:14:26 +0200 Subject: [PATCH 07/36] attempted resolution 06 - use YT video on github readme --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 401c7d49..f67ac604 100644 --- a/README.md +++ b/README.md @@ -122,7 +122,9 @@

-[![Miniature de la vidéo]](https://www.youtube.com/watch?v=m9-WRRSSt3A) + +`Upload Video Here` +
From 363816fc3ffc2b2bb4ececdc3e88f8bf13ddfd98 Mon Sep 17 00:00:00 2001 From: GaetanGrd <40648115+GaetanGrd@users.noreply.github.com> Date: Thu, 12 Oct 2023 03:36:36 +0200 Subject: [PATCH 08/36] Add Version management --- README.md | 550 ++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 344 insertions(+), 206 deletions(-) diff --git a/README.md b/README.md index f67ac604..d58aac37 100644 --- a/README.md +++ b/README.md @@ -9,271 +9,409 @@ *** 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 -
- [Go to bottom] + +
+ Stargazers + Forks + License + Contributors + GitHub issues +
+ discord + Donation + Twitter +
---- - - -Table of Contents - - - - -
-

-

BSManager: Your Beat Saber Assistant

+ +
+ [Go to bottom] +
+ + + +
+
+

BSManager: Your Beat Saber Assistant

+
+ + +
-

BSManager: Your Beat Saber Assistant

-

What is it?

-

BSManager simplifies your Beat Saber experience by centralizing the management of mods, maps, and game versions in one place.

-

Why use it?

-
    -
  • Easy: Manage and switch between different instances of Beat Saber simply.
  • +

    What is it?

    +

    BSManager simplifies your Beat + Saber experience by centralizing the management of mods, maps, and game versions in one place.

    +
+ + + +
+

Why use it?

+
    +
  • Easy: Manage and switch between different instances of Beat + Saber simply.
  • Accessibility: Access a multitude of content with just a few clicks.
  • -
  • Customization: Adapt BSManager to your tastes without technical hassles.
  • -
-Start your enhanced experience with Beat Saber and explore all the features offered by BSManager! - +
  • Customization: Adapt BSManager to your + tastes without technical hassles.
  • + + Start your enhanced experience with Beat Saber and explore all the features + offered by BSManager!
    -
    +
    - -`Upload Video Here` - -
    - - -
    -

    Built With

    -
      -
    • - Electron React Boilerplate -
    • -
    • - Depot Downloader -
    • -
    • - RxJs -
    • -
    • - TailWind CSS -
    • -
    +
    + Upload Video Here +
    + + + +
    +

    Built With

    +
      +
    • + Electron React Boilerplate +
    • +
    • + Depot Downloader +
    • +
    • + RxJs +
    • +
    • + TailWind CSS +
    • +
    +
    + + + +
    +

    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!
    • +
    -
    -
    -

    -

    Usage

    + Upload Video Here
    - -
    -

    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!
    • -
    -
    - -
    -

    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 - +
    +

    Version management

    - -
    -

    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! - +

    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:

    +
    +
    - -https://user-images.githubusercontent.com/40648115/213296794-74a1e20b-12dc-44ec-a67f-e25d7010bd3d.mov - + Insert Screen connexion choice here
    -
    -

    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. - +
      +
    • via Steam: Use either your credentials, which will not be stored by BSManager or + DepotDownloader, or opt for a quick and secure authentication via QR with the Steam Guard app.
    • +
    -
    +
    - -https://user-images.githubusercontent.com/40648115/213296816-bdaafc90-da76-4835-8d83-9ac6a4e1c549.mov - + Insert steam connexion interface
    -
    -

    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. - +
      +
    • via Oculus: For Oculus users, BSManager uses authentication directly via the META website + to retrieve the connection token, ensuring reliable and secure access to your account data.
    • +
    -
    +
    - -https://user-images.githubusercontent.com/40648115/213296838-f775fe83-866d-4764-a7d0-648dbb8ec983.mov - + Insert oculus connexion interface
    - + +
    -

    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. - +

    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/213435051-7feb815d-f32b-4135-b095-ef49726a836c.mov - + Upload Video Here
    - + +
    -

    Having problems?

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

    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.

    -


    +
    + Upload Video / screen Here +
    + + + +
    +

    Launch Arguments

    +

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

    +
      +
    • Oculus Mode: Launches the game directly in Oculus mode, avoiding the use of STEAM VR.
    • +
    • FPFC Mode: Enables "FPFC" mode, allowing you to control the game without using a VR + headset.
    • +
    • Debug Mode: Activates debugging mode, generating Windows log outputs for IPA.
    • +
    +

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

    +
    + +
    + Insert launch arguments interface here +
    + + + +
    +

    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.

    +
    + +
    + Upload Video Here +
    + + + + + + + + + + + + + + + + + + + + +
    -

    Credits

    -
      -
    • Zagrios - Founder & Lead Developer
    • -
    • Iluhadesu - Project Team & Developpement help
    • -
    • GaetanGrd - Project Team & Developpement help
    • -
    • cheddZy - Icon creator
    • -
    +

    Credits

    +
      +
    • Zagrios - Founder & Lead Developer
    • +
    • Iluhadesu - Project Team & Developpement help
    • +
    • GaetanGrd - Project Team & Developpement help
    • +
    • cheddZy - Icon creator
    • +

    -

    Contributing

    -

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

    -

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

    -
    - - - -
    +

    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]

    From a03f50eac32730a55cbd89bb598d1c20498a14de Mon Sep 17 00:00:00 2001 From: GaetanGrd <40648115+GaetanGrd@users.noreply.github.com> Date: Thu, 12 Oct 2023 03:51:22 +0200 Subject: [PATCH 09/36] add others sections --- README.md | 195 ++++++++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 159 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index d58aac37..5b3f436e 100644 --- a/README.md +++ b/README.md @@ -138,7 +138,7 @@ -
    +
    [Go to bottom]
    @@ -361,58 +361,181 @@
    - - - - - - - - - - - - - - - - - - - - - + +
    +
    +

    Download and Installation

    +
    -

    Credits

    +

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

    +
    + + +
    +

    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".

    +
    + +
    + Insert VIDEO INSTALL MAP +
    + + +
    +

    Playlists

    +

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

    +
    + +
    + Insert VIDEO INSTALL playlist +
    + + +
    +

    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.

    +
    + +
    + Insert VIDEO INSTALL MOD +
    + + +
    +

    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.

    +
    + +
    + Insert VIDEO INSTALL MODEL +
    + + + +
    +
    +

    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:

    +
      +
    • Theme: Choose between light, dark themes or follow system settings for seamless integration into your work environment.
    • +
    • Color: Select your preferred primary and secondary colors using hexadecimal codes, allowing you to customize the visual appearance of the tool to your liking.
    • +
    +
    + +
    + Insert screen or video if interesting +
    + + +
    +

    Beat Saber Instance

    +

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

    +
      +
    • Color: Customize the appearance of your instances by choosing a specific color for each of them.
    • +
    • Name: Name your instances in a way that distinguishes and identifies them easily when switching from one to another.
    • +
    +
    + +
    + Insert screen or video if interesting +
    + + + +
    +
    +

    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 -

    +

    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] +
    -

    From 22a7333dbc57ae65deff3adac67e1b05749ca880 Mon Sep 17 00:00:00 2001 From: GaetanGrd <40648115+GaetanGrd@users.noreply.github.com> Date: Thu, 12 Oct 2023 04:04:22 +0200 Subject: [PATCH 10/36] add links --- README.md | 44 ++++++++++++++++++++++---------------------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 5b3f436e..4ba0ba6a 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@

    BSManager

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

    @@ -228,7 +228,7 @@
    • Download the latest release from Releases.
    • -
    • Execute the installer and BSManager will start itself.
    • +
    • 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!
    @@ -249,7 +249,7 @@

    Version management

    -

    With BSManager, manage your Beat Saber versions with ease, allowing the download of new versions and preserving +

    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.

    @@ -260,7 +260,7 @@ -->

    Downloading Multiple Versions

    -

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

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

    @@ -281,7 +281,7 @@
      -
    • via Oculus: For Oculus users, BSManager uses authentication directly via the META website +
    • via Oculus: For Oculus users, BSManager uses authentication directly via the META website to retrieve the connection token, ensuring reliable and secure access to your account data.
    @@ -297,7 +297,7 @@ -->

    Multi-Version Sharing

    -

    BSManager facilitates the sharing of your maps, models, and custom files between different versions of Beat +

    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.

    @@ -313,8 +313,8 @@ -->

    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.

    +

    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.

    @@ -328,7 +328,7 @@ -->

    Launch Arguments

    -

    BSManager provides efficient management of Beat Saber launch arguments, including three predefined ones to +

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