From 4d42dfb2cb6d57cef15ee60eef8338eb7f7a970f Mon Sep 17 00:00:00 2001 From: shidorien Date: Sun, 1 Dec 2024 20:56:08 +0100 Subject: [PATCH] Add installation guide for mods and update links in Home.md --- .../install-mods-on-your-version.md | 35 +++++++++++++++++++ docs/wiki/Home.md | 2 +- 2 files changed, 36 insertions(+), 1 deletion(-) create mode 100644 docs/wiki/Guides/Content-Management/Mods/Install-mods-on-your-version/install-mods-on-your-version.md diff --git a/docs/wiki/Guides/Content-Management/Mods/Install-mods-on-your-version/install-mods-on-your-version.md b/docs/wiki/Guides/Content-Management/Mods/Install-mods-on-your-version/install-mods-on-your-version.md new file mode 100644 index 00000000..8d787797 --- /dev/null +++ b/docs/wiki/Guides/Content-Management/Mods/Install-mods-on-your-version/install-mods-on-your-version.md @@ -0,0 +1,35 @@ +## Summary + +- [With BSManager](https://discord.com/channels/1049624409276694588/1240969086180003840/1240969127649218592) +- [Manual Installation](https://discord.com/channels/1049624409276694588/1240969086180003840/1240969181340631081) + +## With BSManager + +> 1. Download and install [BSManager](https://www.bsmanager.io) from [GitHub](https://github.com/Zagrios/bs-manager/releases/latest) / [Nexus Mods](https://www.nexusmods.com/beatsaber/mods/18?tab=images) or [Website](https://www.bsmanager.io). +> 2. Launch [BSManager](https://www.bsmanager.io) and select the version of Beat Saber that you want to use from the list at the left of the interface. +> 3. Go to mods by clicking on the __`Mods`__ tab. +> 4. Find the mods that you want to install from the provided list. You can use the search bar at the top of the interface to filter mods by name. +> 5. Check the box next to the name of each mod that you want to install. +> 6. Click __`Install or Update`__ at the bottom right of the interface. +> 7. Wait for the installation to complete. Once it's finished, you can launch Beat Saber directly from [BSManager](https://www.bsmanager.io) to enjoy your new mods! + +## Manual Installation + +> ## 📍 this guide assumes your game already has core mods installed +> +>If it doesn't: open [BSManager](https://www.bsmanager.io), select the game version you want to mod, go to the Mods tab, and click __`Install or Update`__. Then, run your game once, go to the main menu, and then close it. ℹī¸* + +1. Open [BSManager](https://www.bsmanager.io) and select the version of Beat Saber you want to install the mod to. +2. Click on the version options button at the top right, then select __`Open Folder`__. +3. Download the desired mod from a trusted source, often found on community GitHub repositories. Search for the mod's name followed by 'GitHub' in your search engine. +4. Installing Different Types of Mods: + - __For mods that come as a single `.dll` file:__ If the mod consists of a single __`.dll`__ file, simply copy this file into the __`Plugins`__ folder in the directory you opened in step 2. + + > ## 📍 Note + > + > Do __not__ place files in __`Beat Saber_Data\Plugins`__. If you do not see a __`Plugins`__ folder directly in the folder you opened in step 2, make sure you have core mods installed and have run your game at least once after installing mods. + - __For Mods that come as a `.zip` file:__ If the mod includes multiple files or folders, you need to maintain the provided folder structure. Double click the zip file to open it, press __`CTRL+A`__ and then __`CTRL+C`__ to copy all files/folders inside the zip, go to the directory you opened in step 2, and press __`CTRL+V`__ to paste them there. Do __not__ paste them in any subfolder, so do not paste these files in __`Plugins`__ or __`Beat Saber_Data`__. If you are prompted to merge folders or overwrite files, click yes. +5. The mod should now be installed. Run Beat Saber to check if the mod functions correctly. If it doesn't, double check that you: + - Have all required dependencies installed. These are typically listed somewhere on the mod's release page. + - Placed the mod in the correct install folder. + - Downloaded a mod intended for your game version. diff --git a/docs/wiki/Home.md b/docs/wiki/Home.md index 96b3ccbd..b99d865b 100644 --- a/docs/wiki/Home.md +++ b/docs/wiki/Home.md @@ -16,7 +16,7 @@ Our comprehensive guides are crafted to assist you in maximizing BSManager's cap - [Install any maps](install-any-maps) - [Install all playlists you want](install-all-playlists-you-want) - **🧩 Mods**: Discover how to install, update, and manage mods to enhance your gameplay. - - ~~[Install mods on your version](install-mods-on-your-version)~~ + - [Install mods on your version](install-mods-on-your-version) - **đŸ–ŧī¸ Models**: Find out how to integrate custom models into your Beat Saber experience. - ~~[Modify models in your beat Saber](modify-models-in-your-beat-saber)~~ - **🤝 Contribution**: Information on how to contribute to the development and improvement of BSManager.