diff --git a/README.md b/README.md index 2f56045..6bee4f4 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,10 @@ # 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! @@ -12,9 +15,11 @@ Bloxstrap is only supported for PCs running Windows. ## Features 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) -* Gives you the ability to opt-in to pre-release testing channels -* Integration with Discord Rich Presence and [rbxfpsunlocker](https://github.com/axstin/rbxfpsunlocker) +* A customizable launcher (including dark theme!) +* Persistent file modifications (re-adds the old death sound!) +* 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 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. ## 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. -* [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.