Skip to content

Commit

Permalink
Merge pull request #26 from szarkans/master
Browse files Browse the repository at this point in the history
Updated README.md
  • Loading branch information
Jsinco authored Aug 20, 2024
2 parents 3503eb5 + 3114706 commit 84dd9a3
Showing 1 changed file with 14 additions and 15 deletions.
29 changes: 14 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.

<br>
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.

---
<h3 style="text-align: center;">Features</h3>
<h3 style="text-align: center;">Original Brewery Features</h3>

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


---
<h3 style="text-align: center;">BreweryX is an actively maintained, support given, and addon supported fork of Brewery with tons of extra features such as:</h3>
<h3 style="text-align: center;">Brewery<ins>X</ins> features</h3>

- 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
Expand All @@ -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)

Expand Down

0 comments on commit 84dd9a3

Please sign in to comment.