diff --git a/README.md b/README.md index 5aad2cb..dc57caa 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ If you don't know how to send in a pr, just ask return or any of the other autis - [ ] GlobalBasicSettings (@GoingCrazyDude) - [X] Appearance (@Netsoftworks) - [ ] Integrations - - [ ] Bootstrapper Options + - [X] Bootstrapper Options (@Naveandice) - [ ] Joingame stuff (lol) - [X] For Developers (@GoingCrazyDude) - [X] Downloading from source and building @@ -42,4 +42,4 @@ Then, run: bun run dev ``` -For a live preview \ No newline at end of file +For a live preview diff --git a/public/docs_bootstrapper_confirmclosureprompt.png b/public/docs_bootstrapper_confirmclosureprompt.png new file mode 100644 index 0000000..83d2519 Binary files /dev/null and b/public/docs_bootstrapper_confirmclosureprompt.png differ diff --git a/src/content/docs/manual/bootstrapper.mdx b/src/content/docs/manual/bootstrapper.mdx index 3e29403..7b61258 100644 --- a/src/content/docs/manual/bootstrapper.mdx +++ b/src/content/docs/manual/bootstrapper.mdx @@ -6,29 +6,52 @@ description: Configure what Fishstrap should do when launching Roblox. import { Aside } from '@astrojs/starlight/components'; ## Prompt to confirm closure when launching another Roblox instance -Prevents closure of your current existing game from accidentally launching another one. -## Allow use of unsupported Roblox languages -Only applies to games launched from the Roblox website. +Fishstrap will prompt you when launching another instance of Roblox to confirm +whether you want to close the existing instance or cancel the launch of another +one. + +Fishstrap prompting the user to confirm closure of existing instance ## Background updates - + -Update your Roblox in the background instead of waiting. +Allows Fishstrap to download new versions of Roblox in the background while you +are playing. It will switch to a new Roblox version on the next launch. ## Cleaner Fishstrap will automatically remove old data to save on space on your PC. -#### When should the files get deleted -Files older than set amount will be deleted. +### When should the files get deleted + +This option selects the cleaner's threshold for old files. Files older than the +selected threshold will be deleted on the next launch. + +- **Never** disables the cleaner. +- **After 1 day**, **After 1 week**, **After 1 month** and **After 2 months** + will enable the cleaner and set its threshold to 1 day, 1 week, 1 month and 2 + months respectively. + +### Which files the cleaner can delete? + +The cleaner only deletes these files you have enabled the toggle for: -#### Cache -Old downloads will be deleted. +- **Cache**: looks for old downloads. +- **Logs**: looks for old Roblox logs. +- **Fishstrap Logs**: looks for old Fishstrap logs. -#### Logs -Remove Roblox log files. +Toggles and their respective paths are shown in the table below. -#### Fishstrap Logs -Remove Fishstrap logs. \ No newline at end of file +| Toggle | Paths | +|----------------|--------------------------------------------------------------------| +| Cache | `%LOCALAPPDATA%\Fishstrap\Downloads`, `%LOCALAPPDATA%\Temp\Roblox` | +| Logs | `%LOCALAPPDATA%\Roblox\logs` | +| Fishstrap Logs | `%LOCALAPPDATA%\Fishstrap\Logs` |