Make installation instructions clearer in readme

This commit is contained in:
pizzaboxer 2022-08-12 16:03:06 +01:00 committed by GitHub
parent d804ad1e8a
commit fbe1ea090d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,28 +1,28 @@
# ![Bloxstrap](https://github.com/pizzaboxer/bloxstrap/raw/main/Bloxstrap/Resources/IconBloxstrap-png.png) Bloxstrap
# <img src="https://github.com/pizzaboxer/bloxstrap/raw/main/Bloxstrap/Resources/IconBloxstrap-png.png" width="48"/> Bloxstrap
An open, customizable, feature-packed alternative bootstrapper for Roblox.
## Usage
This is intended to be a seamless replacement for the stock Roblox bootstrapper, working more or less how you'd expect it to.
When you first run it, you'll see the preferences menu. If you want to configure preferences again after you've already installed it, open up Apps and Features, look for Bloxstrap and select Modify.
Bloxstrap can be uninstalled, and reverts to the stock boostrapper when uninstalled, so it's relatively harmless.
## What is this?
This is intended to be a seamless replacement for the stock Roblox bootstrapper, working more or less how you'd expect it to, while providing new and useful features.
Please keep in mind that **Bloxstrap is in very early development**, and you'll no doubt encounter some bugs. If you do, please submit an issue!
As of right now, Bloxstrap is only supported for Windows. Mac support is possible, but I don't currently have a Mac to test this on.
## Installing
Download the [latest release of Bloxstrap](https://github.com/pizzaboxer/bloxstrap/releases/latest), and run it. Configure your preferences if needed, and install. That's about it!
Bloxstrap requires the [x86 .NET 6 Desktop Runtime](https://dotnet.microsoft.com/en-us/download/dotnet/thank-you/runtime-desktop-6.0.8-windows-x86-installer). If you don't already have it installed, you'll be prompted to install it when trying to run Bloxstrap.
It's not unlikely that Windows Smartscreen will show a popup when you run Bloxstrap for the first time. This happens because it's an unknown program, not because it's actually detected as being malicious. To dismiss it, just click on "More info" and then "Run anyway".
## Features
Here's some of the features that Bloxstrap provides over the stock Roblox bootstrapper:
* Bootstrapper style can be customized (including being able to emulate older version looks)
* Ability to choose where to install Roblox to
* Old death sound can be re-enabled permanently
* Support for Discord Rich Presence
## Installing
Bloxstrap requires the [x86 .NET 6 Desktop Runtime](https://dotnet.microsoft.com/en-us/download/dotnet/thank-you/runtime-desktop-6.0.8-windows-x86-installer). If you don't already have it installed, you'll be prompted to install it when running Bloxstrap.
As of right now, Bloxstrap is only supported for Windows. Mac support is possible, but I don't currently have a Mac to test this on.
* You can choose where Roblox should be installed to
* Old death sound can be re-enabled
* Integration with Discord Rich Presence
* Bootstrapper style can emulate older version looks
## Contributions
* [Roblox Studio Mod Manager](https://github.com/MaximumADHD/Roblox-Studio-Mod-Manager) by [MaximumADHD](https://www.roblox.com/users/2032622/profile) - some utility code was borrowed to help with Bloxstrap's bootstrapper functionality. They're all under Bloxstrap.Helpers.RSMM, with some having slight modifications. Besides, it's a great project.