mirror of
https://github.com/Zagrios/bs-manager.git
synced 2026-07-03 14:08:25 +02:00
133 lines
6.0 KiB
Markdown
133 lines
6.0 KiB
Markdown
<a name="readme-top"></a>
|
|
|
|
<!-- PROJECT SHIELDS -->
|
|
<!--
|
|
*** I'm using markdown "reference style" links for readability.
|
|
*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
|
|
*** See the bottom of this document for the declaration of the reference variables
|
|
*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
|
|
*** https://www.markdownguide.org/basic-syntax/#reference-style-links
|
|
-->
|
|
|
|
<!-- PROJECT LOGO -->
|
|
|
|
<div align="center">
|
|
<a href="https://github.com/Zagrios/bs-manager">
|
|
<img src="https://raw.githubusercontent.com/Zagrios/bs-manager/master/resources/readme/icon.svg" alt="Logo" width="200" height="200">
|
|
</a>
|
|
<h3 align="center">Beat Saber Manager</h3>
|
|
<p align="center">
|
|
Download, manage and customize your versions of Beat Saber with a simple click!
|
|
<br />
|
|
<a href="https://github.com/Zagrios/bs-manager/issues/new?assignees=Zagrios&labels=bug&template=bug_report.md&title=%5BBUG%5D">Report Bug</a>
|
|
·
|
|
<a href="https://github.com/Zagrios/bs-manager/issues/new?assignees=Zagrios&labels=enhancement&template=feature_request.md&title=%5BAME%5D">Request Feature</a>
|
|
<br><img src="https://github.com/Zagrios/bs-manager/blob/master/resources/readme/beat-running.png?raw=true" width="130"/>
|
|
</p>
|
|
</div>
|
|
<div align="center">
|
|
<a href="https://github.com/Zagrios/bs-manager/stargazers"><img src ="https://img.shields.io/github/stars/Zagrios/bs-manager?style=for-the-badge" alt="Stargazers"/></a>
|
|
<a href="https://github.com/Zagrios/bs-manager/network/members"><img src ="https://img.shields.io/github/forks/Zagrios/bs-manager?style=for-the-badge" alt="Forks"/></a>
|
|
<a href="https://github.com/Zagrios/bs-manager/blob/master/LICENSE"><img src ="https://img.shields.io/github/license/Zagrios/bs-manager?style=for-the-badge" alt="License"/></a>
|
|
<a href="https://github.com/Zagrios/bs-manager/graphs/contributors"><img src ="https://img.shields.io/github/contributors/Zagrios/bs-manager?style=for-the-badge" alt="Contributors"/></a>
|
|
<a href="https://github.com/Zagrios/bs-manager/issues"><img alt="GitHub issues" src="https://img.shields.io/github/issues/Zagrios/bs-manager?style=for-the-badge"></a>
|
|
<br><br>
|
|
<a href=""><img src ="https://img.shields.io/badge/-DISCORD%20-grey?style=for-the-badge&logo=Discord" alt="Discord"/></a>
|
|
<a href="https://www.patreon.com/bsmanager"><img src ="https://img.shields.io/badge/-Patreon-052d49?style=for-the-badge&logo=patreon" alt="Patreon"/></a>
|
|
<br>
|
|
<p align="center">[<a href="#readme-bot">go to bot</a>]</p>
|
|
</div>
|
|
|
|
---------------
|
|
|
|
<!-- TABLE OF CONTENTS -->
|
|
<details>
|
|
<summary><h3>Table of Contents<h3></summary>
|
|
<ol>
|
|
<li>
|
|
<a href="#about-the-project">About The Project</a>
|
|
<ul>
|
|
<li><a href="#built-with">Built With</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#usage">Usage</a></li>
|
|
<ul>
|
|
<li><a href="#manage-versions">Manage Versions</a></li>
|
|
<li><a href="#install-mods">Install Mods</a></li>
|
|
<li><a href="#install-maps">Install Maps</a></li>
|
|
</ul>
|
|
<li><a href="#roadmap">Roadmap</a></li>
|
|
<li><a href="#contributing">Contributing</a></li>
|
|
<li><a href="#license">License</a></li>
|
|
<li><a href="#contact">Contact</a></li>
|
|
<li><a href="#acknowledgments">Acknowledgments</a></li>
|
|
</ol>
|
|
</details>
|
|
|
|
---------------
|
|
|
|
## About The Project
|
|
<div align="center">
|
|
<img src ="https://user-images.githubusercontent.com/40648115/194020303-954e298f-4436-4900-9d27-a52162273318.png" width="800" height="533">
|
|
</div>
|
|
<br><br>
|
|
<p>Beat Saber Manager was created to unify and improve the two most used tools in the community (<a href="https://github.com/RiskiVR/BSLegacyLauncher">BS legacy launcher</a> and <a href="https://github.com/Assistant/ModAssistant">Mod Assistant</a>).
|
|
|
|
<h4>BSMangager will allow you to:</h4>
|
|
<ul>
|
|
<li><b>Manage instances of multiple versions</b>, designed for people who need to play on different versions or have multiple profiles for the same version.</li>
|
|
<li><b>Install your mods in one click, just like <a href="https://github.com/Assistant/ModAssistant">Mod Assistant</a></b>, <a href="../../">BSManager<a> will allow you to install your mods quickly and securely depending on the version you choose.</li>
|
|
<li><b>Download your maps in the same way</b>, 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.</li>
|
|
<li><b>Customize your interface</b>, we know that some of you like to customize your interfaces to the maximum. That's why <a href="../../">BSManager<a> 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.</li>
|
|
</ul>
|
|
</p>
|
|
|
|
### Built With
|
|
<ul>
|
|
<li><a href="https://electron-react-boilerplate.js.org/">
|
|
<img src="https://img.shields.io/badge/-Electron%20React%20Boilerplate-black?style=for-the-badge&logo=Electron" alt="Electron React Boilerplate">
|
|
</a></li>
|
|
<li><a href="https://github.com/SteamRE/DepotDownloader">
|
|
<img src="https://img.shields.io/badge/-Depot%20Downloader-2a475e?style=for-the-badge&logo=steam" alt="Depot Downloader">
|
|
</a></li>
|
|
<li><a href="https://rxjs.dev/">
|
|
<img src="https://img.shields.io/badge/-RxJs-purple?style=for-the-badge&logo=ReactiveX" alt="RxJs">
|
|
</a></li>
|
|
<li><a href="https://tailwindcss.com/">
|
|
<img src="https://img.shields.io/badge/-Tailwind%20CSS-white?style=for-the-badge&logo=Tailwind%20CSS" alt="TailWind CSS">
|
|
</a></li>
|
|
</ul>
|
|
<p align="right">[<a href="#readme-top">Return to top</a>]</p>
|
|
|
|
---------------
|
|
|
|
## Usage
|
|
|
|
### Manage Versions
|
|
|
|
<div align="center">
|
|
<img src="/resources/readme/wip.gif">
|
|
</div>
|
|
|
|
### Install Mods
|
|
|
|
<div align="center">
|
|
<h3>Coming soon</h3>
|
|
<img src="/resources/readme/wip.gif" alt="(WIP)">
|
|
</div>
|
|
|
|
### Install Maps
|
|
|
|
<div align="center">
|
|
<h3>Coming soon</h3>
|
|
<img src="/resources/readme/wip.gif" alt="(WIP)">
|
|
</div>
|
|
|
|
<p align="right">[<a href="#readme-top">Return to top</a>]</p>
|
|
|
|
---------------
|
|
|
|
|
|
|
|
<a name="readme-bot"></a>
|