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

-
+ + + +
+

Why use it?

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