From 3292dfa779c92d651e3492e6fe1ef91a3a60ced0 Mon Sep 17 00:00:00 2001 From: Valentine Briese Date: Sat, 2 Sep 2023 16:50:22 -0700 Subject: [PATCH] Add pre-release info to `README.md` --- README.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index fb36a6c..de379c6 100644 --- a/README.md +++ b/README.md @@ -15,9 +15,10 @@ Keeps your installed Bonelab mods synced with your subscribed mod.io mods. - macOS - Linux - Windows -- Quest mod support +- PC and Quest mod support - Parallel downloads - Installs subscribed mod.io mods +- Installs PC mods directly into Bonelab installation - Updates mods - Removes unsubscribed mods - Built with [Rust](http://rust-lang.org) @@ -26,17 +27,18 @@ You can see this project's backlog [here](https://github.com/users/valentinegb/p ## How to Use -1. Download the appropriate file from the [latest release](https://github.com/valentinegb/bonelab_mod_manager/releases/latest) for your OS. +1. Download the appropriate file from the [latest release](https://github.com/valentinegb/bonelab_mod_manager/releases/latest) (or [a pre-release](https://github.com/valentinegb/bonelab_mod_manager/releases)) for your OS. 2. Launch the program, by double clicking or other method. - If you're on Windows, you may be prevented from launching the program by a popup warning you that the program is not safe. It is, and if you don't believe me you can check the code yourself. To launch the program anyway, click "More info" then "Run anyway". 3. On your first time running, you will be prompted to sign in to mod.io. Use the arrow keys to select your method of signing in then press enter. -4. After signing in, the program will do the rest for you! Sit back, relax, and watch as all your mods are downloaded and installed. -5. Next time you want to sync your installed mods, just run the program again. +4. If you are on Windows, you will be prompted whether you would like to install PC mods or Quest mods. +5. After that, the program will do the rest for you! Sit back, relax, and watch as all your mods are downloaded and installed. +6. Next time you want to sync your installed mods, just run the program again. -## Mod Installation Path +## Quest Mod Installation Path -Mods are installed in a directory dependent on your OS. +PC mods are installed directly into a PC Bonelab installation, but Quest mods must be manually put onto your headset. Quest mods are installed in a directory dependent on your OS. macOS: `~/Library/Application Support/com.valentinegb.bonelab_mod_manager/Mods` @@ -44,5 +46,5 @@ Linux: `~/var/lib/bonelab_mod_manager/Mods` Windows: `%AppData%/bonelab_mod_manager/Mods` -I know, it isn't ideal having to move the mods from this folder to your actual Bonelab mods folder, +I know, it isn't ideal having to move the mods from this folder to your headset, but it's on the roadmap for the mod manager to do that for you, it will in the future!