Update README.md

Add workflow status badge and elaborate on features
This commit is contained in:
pizzaboxer 2022-12-03 17:40:34 +00:00 committed by GitHub
parent 43f733c5de
commit 9df34c785e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,7 +1,10 @@
# <img src="https://github.com/pizzaboxer/bloxstrap/raw/main/Bloxstrap/Resources/IconBloxstrap-png.png" width="48"/> Bloxstrap # <img src="https://github.com/pizzaboxer/bloxstrap/raw/main/Bloxstrap/Resources/IconBloxstrap-png.png" width="48"/> Bloxstrap
![License](https://img.shields.io/github/license/pizzaboxer/bloxstrap) ![Downloads](https://img.shields.io/github/downloads/pizzaboxer/bloxstrap/total) ![Star](https://img.shields.io/github/stars/pizzaboxer/bloxstrap?style=social) ![License](https://img.shields.io/github/license/pizzaboxer/bloxstrap)
![GitHub Workflow Status](https://img.shields.io/github/workflow/status/pizzaboxer/bloxstrap/CI)
![Downloads](https://img.shields.io/github/downloads/pizzaboxer/bloxstrap/total)
![Star](https://img.shields.io/github/stars/pizzaboxer/bloxstrap?style=social)
An open, customizable, feature-packed alternative bootstrapper for Roblox. An open-source, feature-packed alternative bootstrapper for Roblox.
This a drop-in replacement for the stock Roblox bootstrapper, working more or less how you'd expect it to, while providing additional useful features. Keep in mind - this does not touch or modify the game client itself, it's just a launcher! This a drop-in replacement for the stock Roblox bootstrapper, working more or less how you'd expect it to, while providing additional useful features. Keep in mind - this does not touch or modify the game client itself, it's just a launcher!
@ -12,9 +15,11 @@ Bloxstrap is only supported for PCs running Windows.
## Features ## Features
Here's some of the features that Bloxstrap provides over the stock Roblox bootstrapper: Here's some of the features that Bloxstrap provides over the stock Roblox bootstrapper:
* Support for persistent file modifications (e.g. re-adding the old death sound) * A customizable launcher (including dark theme!)
* Gives you the ability to opt-in to pre-release testing channels * Persistent file modifications (re-adds the old death sound!)
* Integration with Discord Rich Presence and [rbxfpsunlocker](https://github.com/axstin/rbxfpsunlocker) * Support for opting in to pre-release testing channels
* Painless Discord Rich Presence support
* Support for silent automatic FPS unlocking with [rbxfpsunlocker](https://github.com/axstin/rbxfpsunlocker)
## Installing ## 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! 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!
@ -26,7 +31,7 @@ It's not unlikely that Windows Smartscreen will show a popup when you run Bloxst
Once installed, Bloxstrap is added to your Start Menu, where you can change your preferences if needed. Once installed, Bloxstrap is added to your Start Menu, where you can change your preferences if needed.
## Contributions ## Contributions
* [Roblox Studio Mod Manager](https://github.com/MaximumADHD/Roblox-Studio-Mod-Manager) - some slightly modified utility code was borrowed to help with Bloxstrap's bootstrapper functionality (Bloxstrap.Helpers.RSMM). Besides, it's a great project. * [Roblox Studio Mod Manager](https://github.com/MaximumADHD/Roblox-Studio-Mod-Manager) - some utilities was borrowed to help with Bloxstrap's bootstrapper functionality. Besides, it's a great project.
* [skulyire](https://www.roblox.com/users/2485612194/profile) - Making the Bloxstrap logo. * [skulyire](https://www.roblox.com/users/2485612194/profile) - Making the Bloxstrap logo.
* [rbxfpsunlocker](https://github.com/axstin/rbxfpsunlocker) - Added as a Bloxstrap integration. * [rbxfpsunlocker](https://github.com/axstin/rbxfpsunlocker) - Used for Bloxstrap's FPS unlocking.
* [WPFDarkTheme](https://github.com/AngryCarrot789/WPFDarkTheme) - Used for making the Preferences menu. * [WPFDarkTheme](https://github.com/AngryCarrot789/WPFDarkTheme) - Used for making the Preferences menu.