diff --git a/README.md b/README.md index fc43a10b..9233ebe8 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,23 @@ # BreweryX ![License: GPLv3](https://img.shields.io/badge/license-GPLv3-blue) [![Releases](https://img.shields.io/github/v/release/Jsinco/BreweryX)](https://github.com/Jsinco/BreweryX/releases/latest) ---- -# A note from me (Jsinco): -BreweryX is based off of an over decade old plugin called Brewery. A lot of this code is old and awful to look at. If you see poorly written code, don't assume the worst because chances are, I didn't even write it. Thanks ---- - -## Need help, have a feature request, or found a bug? Join the discord [here](https://discord.gg/aV5Am7uxWr)! +#### BreweryX is an actively maintained fork of Brewery which includes many new features and gives support to the inactive plugin. Find more info below. -
+Help, feature requests, bug reports? Join our [Discord](https://discord.gg/aV5Am7uxWr) -#### BreweryX is an actively maintained fork of Brewery which includes many new features and gives support to the inactive plugin. Find more info below. +--- -##### Brewery is a Plugin for an alternate brewing process, including alcoholic Potions. +> [!IMPORTANT] +> Brewery**X** is based off of an over **decade** old plugin called Brewery. A lot of this code is old and awful to look at. If you see poorly written code, don't assume the worst because chances are, I didn't even write it. Thanks -###### This Plugin works with Spigot, Paper, and Folia 1.21, 1.20, 1.19, 1.18, 1.17, 1.16, 1.15, 1.14,, ... 1.8.x. +### Brewery is a Plugin for an alternate brewing process, including alcoholic Potions. +Works with Spigot, Paper, and Folia from `1.21.1` to `1.8.x`! -The somewhat difficult brewing process rewards you with a diversity of Potions, which, through their effects, create a drunkeness that has never existed in Minecraft before. +The somewhat difficult brewing process rewards you with a diversity of Potions, which, through their effects, create a drunkenness that has never existed in Minecraft before. --- -

Features

+

Original Brewery Features

- Brew alcoholic Drinks, that actually can make you drunk - Drunk people will stagger, the chat is influenced, effects and more @@ -34,13 +31,13 @@ The somewhat difficult brewing process rewards you with a diversity of Potions, --- -

BreweryX is an actively maintained, support given, and addon supported fork of Brewery with tons of extra features such as:

+

BreweryX features

- Customizable plugin prefix - Full RGB support for 1.16+ - Multi-puke items - Ability to specify custom ingredients by CustomModelData -- Support for BreweryX addons (Things like **[Recipes](https://www.spigotmc.org/resources/breweryrecipes-breweryx-addon.114897/)** and **[IAOraxenAddon](https://www.spigotmc.org/resources/iaoraxenaddon-breweryx-addon.114778/)**) +- Addons! (Things like **[Recipes](https://www.spigotmc.org/resources/breweryrecipes-breweryx-addon.114897/)** and **[IAOraxenAddon](https://www.spigotmc.org/resources/iaoraxenaddon-breweryx-addon.114778/)**) - Patches like **[this](https://github.com/DieReicheErethons/Brewery/issues/541)** - Support for Brewery and BreweryX in our **[discord](https://discord.gg/6VzjPSNRex)** - **[Folia](https://github.com/PaperMC/Folia)** support @@ -55,7 +52,9 @@ The somewhat difficult brewing process rewards you with a diversity of Potions, # API -### Coming soon - [Depenizen support](https://github.com/DenizenScript/Depenizen/pull/430) for Denizen Scripters +### Coming soon: + +- [Depenizen support](https://github.com/DenizenScript/Depenizen/pull/430) for Denizen Scripters ### For Java developers, use any release jar locally or get any release from [Jitpack](https://jitpack.io/#Jsinco/BreweryX)