diff --git a/config/ru/mkdocs.yml b/config/ru/mkdocs.yml deleted file mode 100644 index 57210e52..00000000 --- a/config/ru/mkdocs.yml +++ /dev/null @@ -1,98 +0,0 @@ -site_name: BreweryX -site_author: Jsinco, szarkan - -repo_url: https://github.com/Jsinco/BreweryX - -theme: - name: material - palette: - scheme: slate - primary: indigo - features: - - content.tabs.link - # - navigation.instant - # - navigation.instant.progress - - navigation.tabs - - navigation.tabs.sticky - - navigation.sections - - navigation.tracking - - navigation.prune - - navigation.top - - navigation.indexes - - search.suggest - - search.highlight - - toc.follow - - content.action.edit - logo: assets/favicon.jpg - favicon: assets/favicon.jpg - font: - text: Inter - code: Fira Code -markdown_extensions: - - pymdownx.caret - - pymdownx.mark - - pymdownx.tilde - - admonition - - pymdownx.details - - pymdownx.superfences - - pymdownx.keys - - tables - - pymdownx.critic - - pymdownx.snippets: - auto_append: - - includes/links.md - - toc: - permalink: "#" - separator: "_" - - pymdownx.tabbed: - alternate_style: true - - abbr - - def_list - - md_in_html - - attr_list - - pymdownx.tasklist: - custom_checkbox: true - - pymdownx.emoji: - emoji_index: !!python/name:material.extensions.emoji.twemoji - emoji_generator: !!python/name:material.extensions.emoji.to_svg - - pymdownx.superfences: - custom_fences: - - name: mermaid - class: mermaid - format: !!python/name:pymdownx.superfences.fence_code_format -extra_css: - - stylesheets/extra.css - - stylesheets/my.css -plugins: - - open-in-new-tab - - search - - i18n: - docs_structure: folder - languages: - - locale: en - default: true - name: English - build: true - - locale: ru - default: false - name: Русский - build: true - - minify: - minify_html: true -extra: - alternate: - - name: English - link: /en/ - lang: en - - name: Русский - link: /ru/ - lang: ru - status: - new: Недавно обновлено! - inprogress: В процессе написания -nav: - - '': index.md - - Guides: - - guide/recipies.md - - guide/brewing_guide.md - - guide/custom_items.md \ No newline at end of file diff --git a/docs/en/guide/default_config.md b/docs/en/guide/default_config.md new file mode 100644 index 00000000..cda76e99 --- /dev/null +++ b/docs/en/guide/default_config.md @@ -0,0 +1,1224 @@ +# Default config + +This is default config in `en` language + +```yaml title="config.yml" +# config for Brewery.jar + + +# -- Settings -- +# Defaults are written in [] + +# Languagefile to be used (found in plugins/Brewery/languages) +language: en + +# Prefix used on messages +pluginPrefix: '&2[Brewery]&f ' + +# If the player wakes up at /home when logging in after excessive drinking (/home plugin must be installed!) [true] +enableHome: true + +# Type of the home-teleport: ['cmd: home'] +# bed = Player will be teleported to his spawn bed +# 'cmd: home' = /home will be executed by the player. He has to have permissions for it without any delay! +# 'cmd: spawn' = /spawn will be executed by the player. +# 'cmd: whatever' = /whatever will be executed by the player. +homeType: 'cmd: home' + +# If the player "wakes up" at a random place when offline for some time while drinking (the places have to be defined with '/brew Wakeup add' through an admin) +# The Player wakes at the nearest of two random places of his world [true] +enableWake: true + +# If the Player may have to try multiple times when logging in while extremely drunk [true] +enableLoginDisallow: true + +# If the Player faints shortly (gets kicked from the server) if he drinks the max amount of alcohol possible [false] +enableKickOnOverdrink: false + +# If the Player vomits on high drunkenness (drops item defined below) [true] +# The item can not be collected and stays on the ground until it despawns. +enablePuke: true + +# Item that is dropped multiple times uncollectable when puking [Soul_Sand] +pukeItem: [Soul_Sand] + +# Time in seconds until the pukeitems despawn, (mc default is 300 = 5 min) [60] +# If the item despawn time was changed in the spigot.yml, the pukeDespawntime changes as well. +pukeDespawntime: 60 + +# How much the Player stumbles depending on the amount of alcohol he drank. Can be set to 0 and higher than 100 [100] +stumblePercent: 100 + +# Display his drunkenness to the player when he drinks a brew or eats a drainItem [true] +showStatusOnDrink: true + +# Consumable Item/strength. Decreases the alcohol level by when consumed. (list) +drainItems: + - Bread/4 + - Milk_Bucket/2 + +# Show Particles over Cauldrons when they have ingredients and a heat source. [true] +# The changing color of the particles can help with timing some recipes +enableCauldronParticles: true +# If Cauldron Particles should be reduced to the bare minimum [false] +minimalParticles: false + +# If crafting and using of the Brew Sealing Table is enabled (2 Bottles over 4 Planks) [true, true] +craftSealingTable: true +enableSealingTable: true + +# Always show the 1-5 stars on the item depending on the quality. If false, they will only appear when brewing [true] +alwaysShowQuality: true + +# Always show the alcohol content on the item. If false, it will only show in the brewing stand [false] +alwaysShowAlc: false + +# If we should show who brewed the drink [false] +showBrewer: false + +# If aging in -Minecraft- Barrels in enabled [true] and how many Brewery drinks can be put into them [6] +ageInMCBarrels: true +maxBrewsInMCBarrels: 6 + +# The used Ingredients and other brewing-data is saved to all Brewery Items. To prevent +# hacked clients from reading what exactly was used to brew an item, the data can be encoded/scrambled. +# This is a fast process to stop players from hacking out recipes, once they get hold of a brew. +# Only drawback: brew items can only be used on another server with the same encodeKey. +# When using Brews on multiple (BungeeCord) Servers, define a shared Database below at 'multiServerDB' +# So enable this if you want to make recipe cheating harder, but don't share any brews by world download, schematics, or other means. [false] +enableEncode: false +encodeKey: 0 + +# Enable checking for Updates, Checks the curseforge api for updates to Brewery [true] +# If an Update is found a Message is logged on Server-start and displayed to OPs joining the game +updateCheck: true + +# Autosave interval in minutes [3] +autosave: 3 + +# Show debug messages in log [false] +debug: false + +# Config Version +version: '3.1' + + + +# -- Define custom items -- +# The defined id can then be used in recipes + +# matchAny: true if it is already enough if one of the info matches +# material: Which type the item has to be +# name: Which name the item has to be (Formatting codes possible: such as &6) +# lore: What has to be in the lore of the item +# customModelData: Custom Model Data Int. Whatever Model data number the item has to have in a list format +customItems: + # Three Example Items + ex-item: + # A Barrier item called Wall and has the given line in its lore + material: Barrier + name: 'Wall' + lore: + - '&7Very well protected' + + ex-item2: + # Using matchAny only one of the following has to match. + # In this case on of the door types, or an item called Beechwood Door, or an item with 'A door' in its lore + matchAny: true + material: + - Acacia_Door + - Oak_Door + - Spruce_Door + name: + - 'Beechwood Door' + lore: + - 'A door' + + rasp: + name: '&cRaspberry' + + modelitem: + material: paper + customModelData: + - 10234 + - 30334 + + blue-flowers: + matchAny: true + material: + - cornflower + - blue_orchid + + +# -- Ingredients in the Cauldron -- +# Which Ingredients are accepted by the Cauldron and the base potion resulting from them +# You only need to add something here if you want to specify a custom name or color for the base potion + + # name: Name of the base potion coming out of the Cauldron (Formatting codes possible: such as &6) + # ingredients: List of 'material/amount' + # With an item in your hand, use /brew ItemName to get its material for use in a recipe + # (Item-ids instead of material are not supported by bukkit anymore and will not work) + # A list of materials can be found here: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Material.html + # color: Color of the base potion from a cauldron. Defaults to CYAN + # Usable Colors: DARK_RED, RED, BRIGHT_RED, ORANGE, YELLOW, PINK, PURPLE, BLUE, CYAN, WATER, TEAL, OLIVE, GREEN, LIME, BLACK, GREY, BRIGHT_GREY, WHITE + # Or RGB colors (hex: for example '99FF33') (with '') (search for "HTML color" on the internet) + # cookParticles: + # Color of the Particles above the cauldron at different cooking-times + # Color and minute during which each color should appear, i.e. one color at 8 minutes fading to another at 18 minutes. + # As List, each Color as name or RGB, see above. Written as 'Color/Minute' + # It will fade to the last color in the end, if there is only one color in the list, it will fade to grey + # lore: List of additional text on the base potion. (Formatting codes possible: such as &6) + # customModelData: Custom Model Data Tag. This is a number that can be used to add custom textures to the item. + +cauldron: + # Example with all possible entries + ex: + name: Example + ingredients: + - Bedrock/2 + - Diamond + color: BLACK + cookParticles: + - 'RED/5' + - 'WHITE/10' + - '800000/25' # maroon + lore: + - An example for a Base Potion + - This is how it comes out of a Cauldron + customModelData: 545 + + # -- One Ingredient: -- + wheat: + name: Fermented wheat + ingredients: Wheat + cookParticles: + - '2d8686/8' # Dark Aqua + + sugarcane: + name: Sugar brew + ingredients: Sugar_Cane + color: 'f1ffad' # yellowish green + cookParticles: + - 'f1ffad/4' + - '858547/10' # dark olive + + sugar: + name: Sugarwater + ingredients: Sugar + cookParticles: + - 'WHITE/4' + - 'BRIGHT_GREY/25' + + apple: + name: Apple must + ingredients: Apple + + berries: + name: Grape must + ingredients: Sweet_Berries + color: RED + cookParticles: + - 'ff6666/2' # bright red + - 'RED/7' + - 'ac6553/13' # brown-red + + potato: + name: Potatomash + ingredients: Potato + + grass: + name: Boiled herbs + ingredients: Short_Grass + color: '99ff66' # bright green + cookParticles: + - 'GREEN/2' + - '99ff99/20' # faded green + + rmushroom: + name: Mushroom brew + ingredients: Red_Mushroom + color: 'ff5c33' # amber red + cookParticles: + - 'fab09e/15' # faded red + + bmushroom: + name: Mushroom brew + ingredients: Brown_Mushroom + color: 'c68c53' # brighter brown + cookParticles: + - 'c68c53/15' + + cocoa: + name: Chocolately brew + ingredients: Cocoa_Beans + color: '804600' # mocca + cookParticles: + - 'a26011/1' + - '5c370a/3' + - '4d4133/8' # Gray-brown + + milk: + name: Milky water + ingredients: Milk_Bucket + color: BRIGHT_GREY + cookParticles: + - 'fbfbd0/1' # yellow-white + - 'WHITE/6' + + bl_flow: + name: Blueish brew + ingredients: blue-flowers + color: '0099ff' # sky blue + cookParticles: + - '0099ff' + + cactus: + name: Agave brew + ingredients: cactus + color: '00b300' # cactus green + cookParticles: + - '00b300/16' + + poi_potato: + name: Poisonous Broth + ingredients: Poisonous_Potato + + egg: + name: Sticky brew + ingredients: Egg + + + oak_sapling: + name: Stringy hebry broth + ingredients: Oak_Sapling + + vine: + name: Boiled herbs + ingredients: vine + color: '99ff66' # bright green + cookParticles: + - 'GREEN/2' + - '99ff99/20' # faded green + + rot_flesh: + name: Foul pest + ingredients: Rotten_Flesh + color: '263300' # brown green + cookParticles: + - '263300/8' + - 'BLACK/20' + + melon: + name: Melon juice + ingredients: melon_slice + + wheat_seeds: + name: Bitter brew + ingredients: Wheat_Seeds + + melon_seeds: + name: Bitter brew + ingredients: Melon_Seeds + + pumpkin_seeds: + name: Bitter brew + ingredients: Pumpkin_Seeds + + bone_meal: + name: Bony Brew + ingredients: bone_meal + color: BRIGHT_GREY + + cookie: + name: Chocolately sap + ingredients: Cookie + color: '804600' # mocca + cookParticles: + - 'a26011/1' + - '5c370a/3' + - '4d4133/8' # Gray-brown + + fer_spid_eye: + name: Fermented Eye + ingredients: Fermented_Spider_Eye + + ghast_tear: + name: Sad brew + ingredients: ghast_tear + + snowball: + name: Icewater + ingredients: Snowball + + Gold_Nugget: + name: Glistering brew + ingredients: Gold_Nugget + color: 'ffd11a' # gold + cookParticles: + - 'ffd11a' + + glowstone_dust: + name: Glowing brew + ingredients: Glowstone_Dust + color: 'ffff33' # bright yellow + cookParticles: + - 'ffff99/3' + - 'd9d926/15' # faded yellow + + # -- Multiple Ingredients: -- + applemead_base: + name: Apple-Sugar brew + ingredients: + - Sugar_Cane/3 + - Apple + color: 'e1ff4d' # greenish yellow + cookParticles: + - 'e1ff4d/4' + + poi_grass: + name: Boiled acidy herbs + ingredients: + - Short_Grass + - Poisonous_Potato + color: '99ff66' # bright green + cookParticles: + - 'GREEN/2' + - '99ff99/20' # faded green + + juniper: + name: Juniper brew + ingredients: + - blue-flowers + - wheat + color: '00ccff' # aqua + cookParticles: + - '00ccff/8' + + gin_base: + name: Fruity juniper brew + ingredients: + - blue-flowers + - wheat + - apple + color: '66e0ff' # lighter aqua + cookParticles: + - '00ccff/5' + + eggnog_base: + name: Smooth egg mixture + ingredients: + - egg + - sugar + - milk_bucket + color: 'ffecb3' # yellow-orange + cookParticles: + - 'ffecb3/2' + + + +# -- Recipes for Potions -- + +# name: Different names for bad/normal/good (Formatting codes possible: such as &6) +# ingredients: List of 'material/amount' +# With an item in your hand, use /brew ItemName to get its material for use in a recipe +# (Item-ids instead of material are not supported by bukkit anymore and will not work) +# A list of materials can be found here: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Material.html +# Plugin items with 'plugin:id' (Currently supporting ExoticGarden, Slimefun, MMOItems, Brewery) +# Or a custom item defined above +# cookingtime: Time in real minutes ingredients have to boil +# distillruns: How often it has to be distilled for full alcohol (0=without distilling) +# distilltime: How long (in seconds) one distill-run takes (0=Default time of 40 sec) MC Default would be 20 sec +# wood: Wood of the barrel 0=any 1=Birch 2=Oak 3=Jungle 4=Spruce 5=Acacia 6=Dark Oak 7=Crimson 8=Warped 9=Mangrove 10=Cherry 11=Bamboo +# The Minecraft barrel is made of oak +# age: Time in Minecraft-days, the potion has to age in a barrel 0=no aging +# color: Color of the potion after distilling/aging. +# Usable Colors: DARK_RED, RED, BRIGHT_RED, ORANGE, YELLOW, PINK, PURPLE, BLUE, CYAN, WATER, TEAL, OLIVE, GREEN, LIME, BLACK, GREY, BRIGHT_GREY, WHITE +# Or RGB colors (hex: for example '99FF33') (with '') (search for "HTML color" on the internet) +# difficulty: 1-10 accuracy needed to get good quality (1 = unaccurate/easy, 10 = very precise/hard) +# alcohol: Absolute amount of alcohol 0-100 in a perfect potion (will be added directly to the player, where 100 means fainting) +# lore: List of additional text on the finished brew. (Formatting codes possible: such as &6) +# Specific lore for quality possible, using + bad, ++ normal, +++ good, added to the front of the line. +# servercommands: List of Commands executed by the -Server- when drinking the brew (Can use %player_name% %quality%) +# playercommands: List of Commands executed by the -Player- when drinking the brew (Can use %player_name% %quality%) +# Specific Commands for quality possible, using + bad, ++ normal, +++ good, added to the front of the line. +# drinkmessage: Chat-message to the Player when drinking the Brew +# drinktitle: Title on Screen to the Player when drinking the Brew +# glint: Boolean if the item should have a glint (enchant glint) +# customModelData: Custom Model Data Tag. This is a number that can be used to add custom textures to the item. +# Can specify one for all, or one for each quality, separated by / +# effects: List of effect/level/duration Special potion-effect when drinking, duration in sek. +# Possible Effects: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/potion/PotionEffectType.html +# Level or Duration ranges may be specified with a "-", ex. 'SPEED/1-2/30-40' = lvl 1 and 30 sec at worst and lvl 2 and 40 sec at best +# Ranges also work high-low, ex. 'POISON/3-1/20-5' for weaker effects at good quality. +# Highest possible Duration: 1638 sec. Instant Effects dont need any duration specified. + +recipes: + # Example Recipe with every possible entry first: + ex: + name: Bad Example/Example/Good Example + ingredients: + - Diamond/1 + - Spruce_Planks/8 + - Bedrock/1 + - Brewery:Wheatbeer/2 +# - ExoticGarden:Grape/3 + - ex-item/4 + cookingtime: 3 + distillruns: 2 + distilltime: 60 + wood: 4 + age: 11 + color: DARK_RED + difficulty: 3 + alcohol: 14 + lore: + - This is an examble brew + - ++Just a normal Example + - This text would be on the brew + - + Smells disgusting + - ++ Smells alright + - +++ Smells really good + servercommands: + - +++ weather clear + - + weather rain + playercommands: + - homes + drinkmessage: Tastes good + drinktitle: Warms you from inside + glint: true + customModelData: 556/557/557 + effects: + - FIRE_RESISTANCE/20 + - HEAL/1 + - WEAKNESS/2-3/50-60 + - POISON/1-0/20-0 + + wheatbeer: + name: Skunky Wheatbeer/Wheatbeer/Fine Wheatbeer + ingredients: + - Wheat/3 + cookingtime: 8 + distillruns: 0 + wood: 1 + age: 2 + color: 'ffb84d' # Orange + difficulty: 1 + alcohol: 5 + lore: +++ &8Refreshing + + beer: + name: Skunky Beer/Beer/Fine Beer + ingredients: + - Wheat/6 + cookingtime: 8 + distillruns: 0 + wood: 0 + age: 3 + color: 'ffd333' # Bright Orange + difficulty: 1 + lore: + - +++ &8Crisp taste + alcohol: 6 + + darkbeer: + name: Skunky Darkbeer/Darkbeer/Fine Darkbeer + ingredients: + - Wheat/6 + cookingtime: 8 + distillruns: 0 + wood: 6 + age: 8 + color: '650013' # Dark Red-Brown + difficulty: 2 + lore: + - +++ &8Roasted taste + alcohol: 7 + + wine: + name: Red Wine + ingredients: + - Sweet_Berries/5 + cookingtime: 5 + distillruns: 0 + wood: 0 + age: 20 + color: RED + difficulty: 4 + alcohol: 8 + lore: + - '+ &8Harsh' + - '+ &8Corked' + - '++ &8Mellow' + - '+++ &8Full-Bodied' + + mead: + name: Awkward Mead/Mead/&6Golden Mead + ingredients: + - Sugar_Cane/6 + cookingtime: 3 + distillruns: 0 + wood: 2 + age: 4 + color: ORANGE + difficulty: 2 + lore: + - +++ Has a golden shine + alcohol: 9 + + ap_mead: + name: Apple Mead/Sweet Apple Mead/&6Sweet Golden Apple Mead + ingredients: + - Sugar_Cane/6 + - Apple/2 + cookingtime: 4 + distillruns: 0 + wood: 2 + age: 4 + color: ORANGE + difficulty: 4 + alcohol: 11 + lore: + - +Is there any Apple in this? + - ++Refreshing taste of Apple + - +++Sweetest hint of Apple + effects: + - WATER_BREATHING/1-2/150 + + cidre: + name: Poor Cidre/Apple Cider/Great Apple Cider + ingredients: + - Apple/14 + cookingtime: 7 + distillruns: 0 + wood: 0 + age: 3 + color: 'f86820' # Red-Orange + difficulty: 4 + alcohol: 7 + + apple_liquor: + name: Sour Apple Liquor/Apple Liquor/Calvados + ingredients: + - Apple/12 + cookingtime: 16 + distillruns: 3 + wood: 5 + age: 6 + color: BRIGHT_RED + difficulty: 5 + alcohol: 14 + lore: + - +Sour like Acid + - +++ Good Apple Liquor + + whiskey: + name: Unsightly Whiskey/Whiskey/Scotch Whiskey + ingredients: + - Wheat/10 + cookingtime: 10 + distillruns: 2 + distilltime: 50 + wood: 4 + age: 18 + color: ORANGE + difficulty: 7 + alcohol: 26 + lore: '&7Single Malt' + + rum: + name: Bitter Rum/Spicy Rum/&6Golden Rum + ingredients: + - Sugar_Cane/18 + cookingtime: 6 + distillruns: 2 + distilltime: 30 + wood: 2 + age: 14 + color: DARK_RED + difficulty: 6 + alcohol: 30 + effects: + - FIRE_RESISTANCE/1/20-100 + - POISON/1-0/30-0 + lore: + - +&8Too bitter to drink + - ++&8Spiced by the barrel + - +++&eSpiced Gold + + vodka: + name: Lousy Vodka/Vodka/Russian Vodka + ingredients: + - Potato/10 + cookingtime: 15 + distillruns: 3 + age: 0 + color: WHITE + difficulty: 4 + alcohol: 20 + lore: + &8Almost undrinkable + effects: + - WEAKNESS/15 + - POISON/10 + + shroom_vodka: + name: Mushroom Vodka/Mushroom Vodka/Glowing Mushroom Vodka + ingredients: + - Potato/10 + - Red_Mushroom/3 + - Brown_Mushroom/3 + cookingtime: 18 + distillruns: 5 + age: 0 + color: 'ff9999' # Pink-Red + difficulty: 7 + alcohol: 18 + lore: +++&aGlows in the dark + effects: + - WEAKNESS/80 + - CONFUSION/27 + - NIGHT_VISION/50-80 + - BLINDNESS/12-2 + - SLOW/10-3 + + gin: + name: Pale Gin/Gin/Old Tom Gin + ingredients: + - Wheat/9 + - blue-flowers/6 # Custom-Item: Blue Orchids or Cornflowers + - Apple/1 + cookingtime: 6 + distillruns: 2 + color: '99ddff' # Very light blue + difficulty: 6 + alcohol: 20 + lore: + - ++ With the + - ++ taste of juniper + - +++ Perfectly finished off + - +++ with juniper + + tequila: + name: Mezcal/Tequila/Tequila anejo + ingredients: + - cactus/8 + cookingtime: 15 + distillruns: 2 + color: 'f5f07e' # Green-Orange + difficulty: 5 + wood: 1 + age: 12 + alcohol: 20 + lore: Desert spirit + + absinthe: + name: Poor Absinthe/Absinthe/Strong Absinthe + ingredients: + - Short_Grass/15 + cookingtime: 3 + distillruns: 6 + distilltime: 80 + color: GREEN + difficulty: 8 + alcohol: 42 + effects: + - POISON/15-25 + lore: '+++&8High proof liquor' + + gr_absinthe: + name: Poor Absinthe/Green Absinthe/Bright Green Absinthe + ingredients: + - Short_Grass/17 + - Poisonous_Potato/2 + cookingtime: 5 + distillruns: 6 + distilltime: 85 + color: LIME + difficulty: 9 + alcohol: 46 + effects: + - POISON/25-40 + - HARM/2 + - NIGHT_VISION/40-60 + lore: '&aLooks poisonous' + + potato_soup: + name: Potato soup + ingredients: + - Potato/5 + - Short_Grass/3 + cookingtime: 3 + color: ORANGE + difficulty: 1 + effects: + - HEAL/0-1 + + coffee: + name: Stale Coffee/Coffee/Strong Coffee + ingredients: + - Cocoa_Beans/12 + - Milk_Bucket/2 + cookingtime: 2 + color: BLACK + difficulty: 3 + alcohol: -6 + lore: + &8Probably a week old + effects: + - REGENERATION/1/2-5 + - SPEED/1/30-140 + + eggnog: + name: Egg Liquor/Eggnog/Advocaat + ingredients: + - Egg/5 + - Sugar/2 + - Milk_Bucket/1 + cookingtime: 2 + color: 'ffe680' + difficulty: 4 + alcohol: 10 + wood: 0 + age: 3 + lore: Made with raw egg + + + + +# I don't want to add more Recipes to the default config, as they would be public and viewable by users to cheat. +# It is up to the Serveradmin to change and add Recipes, so players cannot cheat from the default config. +# Some suggestions for recipes you could use: + + # g_vodka: + # name: 'Rancid Vodka/&6Golden Vodka/&6Shimmering Golden Vodka' + # ingredients: + # - Potato/10 + # - Gold_Nugget/2 + # cookingtime: 18 + # distillruns: 3 + # age: 0 + # color: ORANGE + # difficulty: 6 + # alcohol: 20 + # effects: + # - WEAKNESS/28 + # - POISON/4 + + # fire_whiskey: + # name: Powdery Whiskey/Burning Whiskey/Blazing Whiskey + # ingredients: + # - Wheat/10 + # - Blaze_Powder/2 + # cookingtime: 12 + # distillruns: 3 + # distilltime: 55 + # wood: 4 + # age: 18 + # color: ORANGE + # difficulty: 7 + # alcohol: 28 + # drinkmessage: 'You get a burning feeling in your mouth' + +# Without Alcohol: + + # hot_choc: + # name: Hot Chocolate + # ingredients: + # - cookie/3 + # cookingtime: 2 + # color: DARK_RED + # difficulty: 2 + # effects: + # - FAST_DIGGING/40 + + # iced_coffee: + # name: Watery Coffee/Iced Coffee/Strong Iced Coffee + # ingredients: + # - cookie/8 + # - snowball/4 + # - milk_bucket/1 + # cookingtime: 1 + # color: BLACK + # difficulty: 4 + # alcohol: -8 + # effects: + # - REGENERATION/30 + # - SPEED/10 + + +# More Recipe ideas: +# Dandelion Liquor +# Beetroot Spirit, +# Poppy Liquor: Macum/Grand Poppy, +# Bamboo Liquor: Chu Yeh Ching, +# Cachaca, +# Cognac, +# Sake, +# Buorbon, +# Moonshine, +# Different Wines, +# Brandy, +# Amaretto, +# etc. as well as variations like, +# Pumpkin Spice Beer, +# Melon Vodka + +# There are a lot of items in Minecraft like Vines, Milk and items added by plugins that would make great ingredients. + + +# -- Plugin Compatibility -- + +# Enable checking of other Plugins (if installed) for Barrel Permissions [true] +# Plugins 'Landlord' and 'Protection Stones' use the WorldGuard Flag. 'ClaimChunk' is natively supported. +useWorldGuard: true +useLWC: true +useGriefPrevention: true +useTowny: true +useBlockLocker: true +useGMInventories: true + +# Use a virtual chest when opening a Barrel to check with all other protection plugins +# This could confuse Anti-Cheat plugins, but is otherwise good to use +# use this for 'Residence' Plugin and any others that don't check all cases in the PlayerInteractEvent +useVirtualChestPerms: false + + +# Enable the Logging of Barrel Inventories to LogBlock [true] +useLogBlock: true + + +# -- MultiServer/BungeeCord -- +# If Brewery is running on multiple connected Servers (via BungeeCord) +# a shared Database can be used here to synchronise drunkenness and to be able to use encoded brews between them. + +multiServerDB: + # If using the Database is enabled + enabled: false + # If the drunkenness of players should be synchronised between Servers + syncDrunkeness: true + host: localhost + port: '3306' + user: minec + password: xyz + database: base + + +# -- Various Other Settings -- + +# If items in Offhand should be added to the cauldron as well [false] +useOffhandForCauldron: false + +# If Barrel and Cauldron data can be loaded Async/in the Background [true] +loadDataAsync: true + +# Time (in days) that drunkenness-data stays in memory after a player goes offline, to apply hangover etc. [7] +hangoverDays: 7 + +# Color the Item information (lore) depending on quality while it is 1. in a barrel and/or 2. in a brewing stand [true, true] +colorInBarrels: true +colorInBrewer: true + +# If a Large Barrel can be opened by clicking on any of its blocks, not just Spigot or Sign. This is always true for Small Barrels. [true] +openLargeBarrelEverywhere: true + +# Allow emptying brews into hoppers to discard brews while keeping the glass bottle [true] +brewHopperDump: true + + +# -- Chat Distortion Settings -- + +# If written Chat is distorted when the Player is Drunk, so that it looks like drunk writing +# How much the chat is distorted depends on how drunk the Player is +# Below are settings for what and how changes in chat occur +enableChatDistortion: true + +# Log to the Serverlog what the player actually wrote, before his words were altered [false] +logRealChat: false + +# Text after specified commands will be distorted when drunk (list) [- /gl] +distortCommands: +- /gl +- /global +- /fl +- /s +- /letter +- /g +- /l +- /lokal +- /local +- /mail send +- /m +- /msg +- /w +- /whisper +- /reply +- /r +- /t +- /tell + +# Distort the Text written on a Sign while drunk [false] +distortSignText: false + +# Enclose a Chat text with these Letters to bypass Chat Distortion (Use "," as Separator) (list) [- '[,]'] +# Chat Example: Hello i am drunk *I am testing Brewery* +distortBypass: +- '*,*' +- '[,]' + +# words: Words and letters that will be altered when chatting while being drunk. +# Will be processed from first to last and a written sentece is altered in that order. + +# replace: Word or letter to be replaced. (Special: "-space": replaces space, "-random": insert into random position, "-all": everything, "-start": At Beginning, "-end": At the End.) +# to: What to replace it with. +# pre: Words and Letters before the wanted word (split with ",") +# match: true = one of the "pre"-Words has to be before the wanted Word, false = none of the "pre" Words is allowed before the wanted Word +# alcohol: 1-100 minimum drunkenness after which this word ist replaced +# percentage: Probability of replacing a Word in percent + +words: +words: +- replace: s + to: sh + percentage: 90 + alcohol: 30 + +- replace: ch + to: sh + pre: u,s,o,a + match: false + alcohol: 10 + percentage: 70 + +- replace: h + to: hh + pre: sch,h,t + match: false + percentage: 60 + alcohol: 20 + +- replace: th + to: thl + percentage: 40 + alcohol: 30 + +- replace: sch + to: shk + percentage: 60 + alcohol: 40 + +- replace: u + to: uuh + percentage: 20 + +- replace: y + to: yy + percentage: 60 + alcohol: 15 + +- replace: e + to: ee + percentage: 40 + alcohol: 15 + +- replace: you + to: u + percentage: 40 + +- replace: u + to: uo + pre: u + match: false + percentage: 60 + +- replace: that + to: taht + percentage: 20 + alcohol: 40 + +- replace: p + to: b + percentage: 30 + +- replace: p + to: b + percentage: 70 + alcohol: 60 + +- replace: up + to: ubb + percentage: 80 + alcohol: 25 + +- replace: o + to: oh + percentage: 20 + +- replace: ei + to: i + percentage: 30 + alcohol: 15 + +- replace: b + to: bb + percentage: 80 + alcohol: 40 + +- replace: '!!!' + to: '!!!111!!!eleven!1!' + pre: '!' + match: false + percentage: 20 + alcohol: 70 + +- replace: '!' + to: '!!' + pre: '!' + match: false + percentage: 90 + +- replace: drunk + to: dhrkunn + pre: are + match: false + percentage: 70 + alcohol: 65 + +- replace: walk + to: whhealhk + pre: you can, you can still, you can not + match: false + percentage: 80 + alcohol: 30 + +- replace: wtf + to: wft + percentage: 20 + alcohol: 40 + +- replace: lol + to: loool + percentage: 80 + alcohol: 10 + +- replace: afk + to: aafkayyy + percentage: 30 + alcohol: 30 + +- replace: write + to: wreitt + pre: you can,you can still,you can not + match: false + percentage: 80 + alcohol: 50 + +- replace: drink + to: booze + percentage: 80 + alcohol: 70 + +- replace: '?' + to: '????' + pre: '?' + match: false + percentage: 80 + alcohol: 40 + +- replace: -space + to: '' + pre: h,g,w + match: true + alcohol: 10 + +- replace: -space + to: '' + percentage: 30 + alcohol: 35 + +- replace: -space + to: '' + percentage: 10 + +- replace: -start + to: dho + percentage: 15 + alcohol: 50 + +- replace: -start + to: hhn + percentage: 10 + alcohol: 50 + +- replace: -random + to: lu + percentage: 10 + +- replace: -random + to: lug + percentage: 10 + alcohol: 50 + +- replace: -random + to: blub + percentage: 20 + alcohol: 80 + +- replace: -random + to: lerg + percentage: 40 + alcohol: 85 + +- replace: -random + to: gul + percentage: 40 + alcohol: 80 + +- replace: -random + to: ' ' + percentage: 100 + alcohol: 70 + +- replace: -random + to: ' ' + percentage: 60 + alcohol: 40 + +- replace: -random + to: ' ' + percentage: 50 + alcohol: 30 + +- replace: -end + to: '!' + percentage: 40 + alcohol: 30 + +- replace: -random + to: ' *hic* ' + percentage: 80 + alcohol: 70 + +- replace: -random + to: ' *hic* ' + percentage: 15 + alcohol: 40 + +- replace: -space + to: ' *hic* ' + percentage: 5 + alcohol: 20 + +- replace: -end + to: ' *hic*' + percentage: 70 + alcohol: 50 + +- replace: -all + to: '*burp*' + percentage: 3 + alcohol: 60 + +- replace: -all + to: '*burp*' + percentage: 6 + alcohol: 80 + +``` \ No newline at end of file diff --git a/docs/en/guide/edit_config.md b/docs/en/guide/edit_config.md new file mode 100644 index 00000000..555c2424 --- /dev/null +++ b/docs/en/guide/edit_config.md @@ -0,0 +1,186 @@ +# Configuring the config + +The BreweryX config has a lot of its own jokes, which we will now analyze.yze. + +## Language: `language` + +The BreweryX message language. It can be any of the `BreweryX/languages/` folder. + +Current languages: `en`, `ru`, `de`, `es`, `fr`, `it`, `tw` and `zh` + +## Plugin prefix: `pluginPrefix` + +This is what will be written before the plugin message. + +Default value: `pluginPrefix: '&2[Brewery]&f "` + +## Home type: `homeType` + +This is the command that will be registered on behalf of the player when he gets drunk and logs back on the server. + +Default value: `homeType: 'cmd: home"` + +## Consequences of drinking: `enableWake` + +`true` - the player will wake up at random points that were set by the `/brew Wakeup add` command by the admin after a hard drinking session and some time offline + +`false` - disables this feature + +Default value: `enableWake: true` + +## Difficulty logging in: `enableLoginDisallow` + +`true` - the player will need to log in to the server several times if he is extremely drunk + +`false` - disables this feature + +## Consequences of Drinking 2.0: `enableKickOnOverdrink` + +`true` - kicks the player if he ** got too** fast + +`false` - disables this feature + +## Vomit: `enablePuke` + +`true` - if the player is very drunk, he will "vomit" items defined in `pukeItem` + +`false` - disables this feature + +## Type of vomit: `pukeItem` + +A comma-separated list of items that the player will burp with if `enablePuke` is enabled + +Default value: `pukeItem: [Soul_Sand]` + +## Vomit disappearing time: `pukeDespawnTime' + +How many seconds will vomit items disappear. + +Default value: `pukeDespawntime: 60` + +## Difficulty walking: `stumblePercent` + +The number of how difficult it is for a player to walk when heavily intoxicated, from `0` to `1000` + +Default value: `stumblePercent: 100` + +## Alcohol level when drinking: `showStatusOnDrink` + +`true` - to show the player how drunk he is when drinking + +`false` - do not show + +## Withdrawal of intoxication: `drainItems` + +A list of vanilla items that remove intoxication in the format `Item Name/How many intoxication points does it take off` + +Default values: + +```yaml +drainItems: + - Bread/4 + - Milk_Bucket/2 +``` + +## Cauldron Effects: `enableCauldronParticles` + +`true` - the Cauldronhas effects + +`false` - no + +## Number of Cauldron particles: `minimalParticles` + +`true` - reduce the number of Cauldron particles to a minimum + +`false` - leave everything as it is + +## Craft Sealing Table: `craftSealingTable` + +`true` - sealing table crafting is enabled + +`false` - disabled + +## Is the Sealing table enabled: `enableSealingTable` + +`true` - the sealing table can be used + +`false` - not allowed + +## Show the quality of the drink: `alwaysShowQuality` + +`true` - always show the quality of the drink in the lore of the drink + +`false` - only during fermentation/distillation + +## Show the alcohol level of the drink: `alwaysShowAlc` + +`true` - always show the alcohol level of the drink in the lore of the drink + +`false` - only during distillation + +## Show who brewed the drink: `showBrewer` + +`true` - show who brewed the drink in the lore of the drink + +`false` - do not show + +## Is it possible to ferment in Minecraft barrels: `ageInMCBarrels` + +`true` - drinks can be fermented in a regular barrel + +`false` - not allowed + +## How many slots are in a regular barrel: `maxBrewsInMCBarrels` + +The number is how many slots are available in a regular barrel. + +Default value: `maxBrewsInMCBarrels: 6` + +## Encoding of drinks: `enableEncode` + +This setting (if set to `true`) allows you to encode the components (NBT) of the drink so that cheaters cannot find out what kind of drink it is, who brewed it and what its exact recipe is. + +**Important**! With the setting enabled, drinks can only be stored on one server. All encoded drinks will not be able to be transmitted through worlds, their downloads, schematics, etc. + +## Encoding type: `encodeKey` + +Not sure, we need to ask the developer... + +## Checking for updates: `updateCheck` + +Whether to check for BreweryX updates + +## Autosave: `autosave` + +The number in minutes, once in how many minutes to save BreweryX data + +## Debug: `debug` + +Whether to enable the plugin's debug + +## Config version: `version` + +NEVER TOUCH. + +## Confusing chat: `words` + +This setting is located at the very end of the config, it allows you to change chat messages from drunk players. + +An example of the setup looks like this: + +```yaml +words: +- replace: e # Replace all letters "e" +to: EEE # with "EEE" +percentage: 90 # Chance that the letter "e" will be replaced +alcohol: 30 # What alcohol level will this setting work on? + +- replace: y # Replace all letters "y" + to: YY # On "YY" + pre: y # If there was a letter "y" before it + match: false # Should the letter "y" be before "y" for this setting to work + alcohol: 10 # What alcohol level will this setting work on? + percentage: 70 # Chance that the letter "y" will be replaced +``` + +## To be continued... \ No newline at end of file diff --git a/docs/en/guide/recipies.md b/docs/en/guide/recipies.md index 9cbb19f6..4b470ac9 100644 --- a/docs/en/guide/recipies.md +++ b/docs/en/guide/recipies.md @@ -5,8 +5,9 @@ Creating new recipe is somewhat easy with BreweryX. All you need is to follow th ## Name*s* of a drink: `name` -!!! warning "" - Required at all time +| Required? | Value | Default Value | +| --------- | ----- | ------------- | +| Yes | `Name of bad brew/Name of normal brew/Name of good brew`|None| The name of the drink. Can contain three variations, each for different quality of a drink. It'll look like that: @@ -24,6 +25,10 @@ ColorfulBrew: ## Ingredients: `ingredients` +| Required? | Value | Default Value | +| --------- | ----- | ------------- | +| Yes |- ItemName/Amount|None| + !!! warning "" Required at all time @@ -54,6 +59,10 @@ TestBrew: ## Time to brew: `cookingtime` +| Required? | Value | Default Value | +| --------- | ----- | ------------- | +|Yes|Number in minutes|None| + How much in minutes player need to brew. Can be checked with right clicking Clock on Cauldron. ```yaml @@ -64,8 +73,9 @@ TestBrew: ## How much distilling: `distillruns` -!!! warning "" - Not required, unless `distilltime` present +| Required? | Value | Default Value | +| --------- | ----- | ------------- | +|No, unless `distilltime` present|Number|0| How much times player need to distill brew @@ -77,8 +87,9 @@ TestBrew: ## Distill time: `distilltime` -!!! warning "" - Not required, unless `distillruns` present +| Required? | Value | Default Value | +| --------- | ----- | ------------- | +|No|Number in seconds|0| How much it will take to distill brew one time @@ -90,8 +101,9 @@ TestBrew: ## Type of barrel wood: `wood` -!!! warning "" - Not required, default value - `0` +| Required? | Value | Default Value | +| --------- | ----- | ------------- | +|No|Wood type's number|None| Type of barrel wood needed to age brew properly. Posible values: @@ -127,8 +139,9 @@ TestBrew: ## Aging time: `age` -!!! warning "" - Not required +| Required? | Value | Default Value | +| --------- | ----- | ------------- | +|No|Number in MC days|0| How many MC days brew have to be in barrel for best quality. @@ -140,8 +153,10 @@ TestBrew: ## Color of a drink: `color` -!!! warning "" - Not required, default value - `WHITE` +| Required? | Value | Default Value | +| --------- | ----- | ------------- | +|No|HEX without `#` or color's name|`WHITE`| + Color of a potion. Can be HEX color or `DARK_RED`, `RED`, `BRIGHT_RED`, `ORANGE`, `YELLOW`, `PINK`, `PURPLE`, `BLUE`, `CYAN`, `WATER`, `TEAL`, `OLIVE`, `GREEN`, `LIME`, `BLACK`, `GREY`, `BRIGHT_GREY`, `WHITE` @@ -155,8 +170,9 @@ TestBrew: ## Difficulty of brewing: `difficulty` -!!! warning "" - Required at all time +| Required? | Value | Default Value | +| --------- | ----- | ------------- | +|Yes|Number 1 - 10|None| Accuracy needed to get good quality, from `1` to `10`, where `1` is very unaccurate and `10` is very precise. @@ -170,10 +186,11 @@ TestBrew: ## Alcohol level: `alcohol` -!!! warning "" - Not required, default value - `0` +| Required? | Value | Default Value | +| --------- | ----- | ------------- | +|No|Number 0 - 100|0| -How much alcohol "points" player will get after drinking, from `1` to `100`, where `1` is almost nothing and `100` player will most likely faint +How much alcohol "points" player will get after drinking, from `0` to `100`, where `0` is no alcohol and `100` player will most likely faint ```yaml TestBrew: @@ -183,8 +200,9 @@ TestBrew: ## Lore of brew: `lore` -!!! warning "" - Not required +| Required? | Value | Default Value | +| --------- | ----- | ------------- | +|No|List|None| Lore of a potion. It may vary depending on the quality of the drink. @@ -200,8 +218,9 @@ TestBrew: ## Executing server commands on drink: `servercommands` -!!! warning "" - Not required +| Required? | Value | Default Value | +| --------- | ----- | ------------- | +|No|List|None| Commands that will execute as server. They can be executed depending on the quality of the drink. @@ -220,8 +239,9 @@ TestBrew: ## Executing commands as player: `playercommands` -!!! warning "" - Not required +| Required? | Value | Default Value | +| --------- | ----- | ------------- | +|No|List|None| Commands that will execute as player. They can be executed depending on the quality of the drink. @@ -240,8 +260,9 @@ TestBrew: ## Message after drinking: `drinkmessage` -!!! warning "" - Not required +| Required? | Value | Default Value | +| --------- | ----- | ------------- | +|No|String|None| Message that will be sent to a player after drinking brew. @@ -253,8 +274,9 @@ TestBrew: ## Title after drinking: `drinktitle` -!!! warning "" - Not required +| Required? | Value | Default Value | +| --------- | ----- | ------------- | +|No|String|None| Title message that will be sent to a player after drinking brew. @@ -266,8 +288,9 @@ TestBrew: ## Glint effect: `glint` -!!! warning "" - Not required, default value `false` +| Required? | Value | Default Value | +| --------- | ----- | ------------- | +|No|bool `true` or `false`|`false`| Whether brew will have glint effect (as it were enchanted) @@ -279,8 +302,9 @@ TestBrew: ## CMD of item: `customModelData` -!!! warning "" - Not required +| Required? | Value | Default Value | +| --------- | ----- | ------------- | +|No|Numbers `CMD of bad brew`/`CMD of normal brew`/`CMD of good brew`|None| Custom model data of a brew, can vary based on quality of a brew. @@ -292,8 +316,9 @@ TestBrew: ## Potion effects: `effects` -!!! warning "" - Not required +| Required? | Value | Default Value | +| --------- | ----- | ------------- | +|No|`EffectName/level/duration`|None| Effects that will be given to a player after drinking. diff --git a/docs/ru/guide/default_config.md b/docs/ru/guide/default_config.md new file mode 100644 index 00000000..afcf4e98 --- /dev/null +++ b/docs/ru/guide/default_config.md @@ -0,0 +1,1224 @@ + +# Дефолтный конфиг + +Это - дефолтный конфиг на Английском языке: + +```yaml title="config.yml" +# config for Brewery.jar + + +# -- Settings -- +# Defaults are written in [] + +# Languagefile to be used (found in plugins/Brewery/languages) +language: en + +# Prefix used on messages +pluginPrefix: '&2[Brewery]&f ' + +# If the player wakes up at /home when logging in after excessive drinking (/home plugin must be installed!) [true] +enableHome: true + +# Type of the home-teleport: ['cmd: home'] +# bed = Player will be teleported to his spawn bed +# 'cmd: home' = /home will be executed by the player. He has to have permissions for it without any delay! +# 'cmd: spawn' = /spawn will be executed by the player. +# 'cmd: whatever' = /whatever will be executed by the player. +homeType: 'cmd: home' + +# If the player "wakes up" at a random place when offline for some time while drinking (the places have to be defined with '/brew Wakeup add' through an admin) +# The Player wakes at the nearest of two random places of his world [true] +enableWake: true + +# If the Player may have to try multiple times when logging in while extremely drunk [true] +enableLoginDisallow: true + +# If the Player faints shortly (gets kicked from the server) if he drinks the max amount of alcohol possible [false] +enableKickOnOverdrink: false + +# If the Player vomits on high drunkenness (drops item defined below) [true] +# The item can not be collected and stays on the ground until it despawns. +enablePuke: true + +# Item that is dropped multiple times uncollectable when puking [Soul_Sand] +pukeItem: [Soul_Sand] + +# Time in seconds until the pukeitems despawn, (mc default is 300 = 5 min) [60] +# If the item despawn time was changed in the spigot.yml, the pukeDespawntime changes as well. +pukeDespawntime: 60 + +# How much the Player stumbles depending on the amount of alcohol he drank. Can be set to 0 and higher than 100 [100] +stumblePercent: 100 + +# Display his drunkenness to the player when he drinks a brew or eats a drainItem [true] +showStatusOnDrink: true + +# Consumable Item/strength. Decreases the alcohol level by when consumed. (list) +drainItems: + - Bread/4 + - Milk_Bucket/2 + +# Show Particles over Cauldrons when they have ingredients and a heat source. [true] +# The changing color of the particles can help with timing some recipes +enableCauldronParticles: true +# If Cauldron Particles should be reduced to the bare minimum [false] +minimalParticles: false + +# If crafting and using of the Brew Sealing Table is enabled (2 Bottles over 4 Planks) [true, true] +craftSealingTable: true +enableSealingTable: true + +# Always show the 1-5 stars on the item depending on the quality. If false, they will only appear when brewing [true] +alwaysShowQuality: true + +# Always show the alcohol content on the item. If false, it will only show in the brewing stand [false] +alwaysShowAlc: false + +# If we should show who brewed the drink [false] +showBrewer: false + +# If aging in -Minecraft- Barrels in enabled [true] and how many Brewery drinks can be put into them [6] +ageInMCBarrels: true +maxBrewsInMCBarrels: 6 + +# The used Ingredients and other brewing-data is saved to all Brewery Items. To prevent +# hacked clients from reading what exactly was used to brew an item, the data can be encoded/scrambled. +# This is a fast process to stop players from hacking out recipes, once they get hold of a brew. +# Only drawback: brew items can only be used on another server with the same encodeKey. +# When using Brews on multiple (BungeeCord) Servers, define a shared Database below at 'multiServerDB' +# So enable this if you want to make recipe cheating harder, but don't share any brews by world download, schematics, or other means. [false] +enableEncode: false +encodeKey: 0 + +# Enable checking for Updates, Checks the curseforge api for updates to Brewery [true] +# If an Update is found a Message is logged on Server-start and displayed to OPs joining the game +updateCheck: true + +# Autosave interval in minutes [3] +autosave: 3 + +# Show debug messages in log [false] +debug: false + +# Config Version +version: '3.1' + + + +# -- Define custom items -- +# The defined id can then be used in recipes + +# matchAny: true if it is already enough if one of the info matches +# material: Which type the item has to be +# name: Which name the item has to be (Formatting codes possible: such as &6) +# lore: What has to be in the lore of the item +# customModelData: Custom Model Data Int. Whatever Model data number the item has to have in a list format +customItems: + # Three Example Items + ex-item: + # A Barrier item called Wall and has the given line in its lore + material: Barrier + name: 'Wall' + lore: + - '&7Very well protected' + + ex-item2: + # Using matchAny only one of the following has to match. + # In this case on of the door types, or an item called Beechwood Door, or an item with 'A door' in its lore + matchAny: true + material: + - Acacia_Door + - Oak_Door + - Spruce_Door + name: + - 'Beechwood Door' + lore: + - 'A door' + + rasp: + name: '&cRaspberry' + + modelitem: + material: paper + customModelData: + - 10234 + - 30334 + + blue-flowers: + matchAny: true + material: + - cornflower + - blue_orchid + + +# -- Ingredients in the Cauldron -- +# Which Ingredients are accepted by the Cauldron and the base potion resulting from them +# You only need to add something here if you want to specify a custom name or color for the base potion + + # name: Name of the base potion coming out of the Cauldron (Formatting codes possible: such as &6) + # ingredients: List of 'material/amount' + # With an item in your hand, use /brew ItemName to get its material for use in a recipe + # (Item-ids instead of material are not supported by bukkit anymore and will not work) + # A list of materials can be found here: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Material.html + # color: Color of the base potion from a cauldron. Defaults to CYAN + # Usable Colors: DARK_RED, RED, BRIGHT_RED, ORANGE, YELLOW, PINK, PURPLE, BLUE, CYAN, WATER, TEAL, OLIVE, GREEN, LIME, BLACK, GREY, BRIGHT_GREY, WHITE + # Or RGB colors (hex: for example '99FF33') (with '') (search for "HTML color" on the internet) + # cookParticles: + # Color of the Particles above the cauldron at different cooking-times + # Color and minute during which each color should appear, i.e. one color at 8 minutes fading to another at 18 minutes. + # As List, each Color as name or RGB, see above. Written as 'Color/Minute' + # It will fade to the last color in the end, if there is only one color in the list, it will fade to grey + # lore: List of additional text on the base potion. (Formatting codes possible: such as &6) + # customModelData: Custom Model Data Tag. This is a number that can be used to add custom textures to the item. + +cauldron: + # Example with all possible entries + ex: + name: Example + ingredients: + - Bedrock/2 + - Diamond + color: BLACK + cookParticles: + - 'RED/5' + - 'WHITE/10' + - '800000/25' # maroon + lore: + - An example for a Base Potion + - This is how it comes out of a Cauldron + customModelData: 545 + + # -- One Ingredient: -- + wheat: + name: Fermented wheat + ingredients: Wheat + cookParticles: + - '2d8686/8' # Dark Aqua + + sugarcane: + name: Sugar brew + ingredients: Sugar_Cane + color: 'f1ffad' # yellowish green + cookParticles: + - 'f1ffad/4' + - '858547/10' # dark olive + + sugar: + name: Sugarwater + ingredients: Sugar + cookParticles: + - 'WHITE/4' + - 'BRIGHT_GREY/25' + + apple: + name: Apple must + ingredients: Apple + + berries: + name: Grape must + ingredients: Sweet_Berries + color: RED + cookParticles: + - 'ff6666/2' # bright red + - 'RED/7' + - 'ac6553/13' # brown-red + + potato: + name: Potatomash + ingredients: Potato + + grass: + name: Boiled herbs + ingredients: Short_Grass + color: '99ff66' # bright green + cookParticles: + - 'GREEN/2' + - '99ff99/20' # faded green + + rmushroom: + name: Mushroom brew + ingredients: Red_Mushroom + color: 'ff5c33' # amber red + cookParticles: + - 'fab09e/15' # faded red + + bmushroom: + name: Mushroom brew + ingredients: Brown_Mushroom + color: 'c68c53' # brighter brown + cookParticles: + - 'c68c53/15' + + cocoa: + name: Chocolately brew + ingredients: Cocoa_Beans + color: '804600' # mocca + cookParticles: + - 'a26011/1' + - '5c370a/3' + - '4d4133/8' # Gray-brown + + milk: + name: Milky water + ingredients: Milk_Bucket + color: BRIGHT_GREY + cookParticles: + - 'fbfbd0/1' # yellow-white + - 'WHITE/6' + + bl_flow: + name: Blueish brew + ingredients: blue-flowers + color: '0099ff' # sky blue + cookParticles: + - '0099ff' + + cactus: + name: Agave brew + ingredients: cactus + color: '00b300' # cactus green + cookParticles: + - '00b300/16' + + poi_potato: + name: Poisonous Broth + ingredients: Poisonous_Potato + + egg: + name: Sticky brew + ingredients: Egg + + + oak_sapling: + name: Stringy hebry broth + ingredients: Oak_Sapling + + vine: + name: Boiled herbs + ingredients: vine + color: '99ff66' # bright green + cookParticles: + - 'GREEN/2' + - '99ff99/20' # faded green + + rot_flesh: + name: Foul pest + ingredients: Rotten_Flesh + color: '263300' # brown green + cookParticles: + - '263300/8' + - 'BLACK/20' + + melon: + name: Melon juice + ingredients: melon_slice + + wheat_seeds: + name: Bitter brew + ingredients: Wheat_Seeds + + melon_seeds: + name: Bitter brew + ingredients: Melon_Seeds + + pumpkin_seeds: + name: Bitter brew + ingredients: Pumpkin_Seeds + + bone_meal: + name: Bony Brew + ingredients: bone_meal + color: BRIGHT_GREY + + cookie: + name: Chocolately sap + ingredients: Cookie + color: '804600' # mocca + cookParticles: + - 'a26011/1' + - '5c370a/3' + - '4d4133/8' # Gray-brown + + fer_spid_eye: + name: Fermented Eye + ingredients: Fermented_Spider_Eye + + ghast_tear: + name: Sad brew + ingredients: ghast_tear + + snowball: + name: Icewater + ingredients: Snowball + + Gold_Nugget: + name: Glistering brew + ingredients: Gold_Nugget + color: 'ffd11a' # gold + cookParticles: + - 'ffd11a' + + glowstone_dust: + name: Glowing brew + ingredients: Glowstone_Dust + color: 'ffff33' # bright yellow + cookParticles: + - 'ffff99/3' + - 'd9d926/15' # faded yellow + + # -- Multiple Ingredients: -- + applemead_base: + name: Apple-Sugar brew + ingredients: + - Sugar_Cane/3 + - Apple + color: 'e1ff4d' # greenish yellow + cookParticles: + - 'e1ff4d/4' + + poi_grass: + name: Boiled acidy herbs + ingredients: + - Short_Grass + - Poisonous_Potato + color: '99ff66' # bright green + cookParticles: + - 'GREEN/2' + - '99ff99/20' # faded green + + juniper: + name: Juniper brew + ingredients: + - blue-flowers + - wheat + color: '00ccff' # aqua + cookParticles: + - '00ccff/8' + + gin_base: + name: Fruity juniper brew + ingredients: + - blue-flowers + - wheat + - apple + color: '66e0ff' # lighter aqua + cookParticles: + - '00ccff/5' + + eggnog_base: + name: Smooth egg mixture + ingredients: + - egg + - sugar + - milk_bucket + color: 'ffecb3' # yellow-orange + cookParticles: + - 'ffecb3/2' + + + +# -- Recipes for Potions -- + +# name: Different names for bad/normal/good (Formatting codes possible: such as &6) +# ingredients: List of 'material/amount' +# With an item in your hand, use /brew ItemName to get its material for use in a recipe +# (Item-ids instead of material are not supported by bukkit anymore and will not work) +# A list of materials can be found here: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Material.html +# Plugin items with 'plugin:id' (Currently supporting ExoticGarden, Slimefun, MMOItems, Brewery) +# Or a custom item defined above +# cookingtime: Time in real minutes ingredients have to boil +# distillruns: How often it has to be distilled for full alcohol (0=without distilling) +# distilltime: How long (in seconds) one distill-run takes (0=Default time of 40 sec) MC Default would be 20 sec +# wood: Wood of the barrel 0=any 1=Birch 2=Oak 3=Jungle 4=Spruce 5=Acacia 6=Dark Oak 7=Crimson 8=Warped 9=Mangrove 10=Cherry 11=Bamboo +# The Minecraft barrel is made of oak +# age: Time in Minecraft-days, the potion has to age in a barrel 0=no aging +# color: Color of the potion after distilling/aging. +# Usable Colors: DARK_RED, RED, BRIGHT_RED, ORANGE, YELLOW, PINK, PURPLE, BLUE, CYAN, WATER, TEAL, OLIVE, GREEN, LIME, BLACK, GREY, BRIGHT_GREY, WHITE +# Or RGB colors (hex: for example '99FF33') (with '') (search for "HTML color" on the internet) +# difficulty: 1-10 accuracy needed to get good quality (1 = unaccurate/easy, 10 = very precise/hard) +# alcohol: Absolute amount of alcohol 0-100 in a perfect potion (will be added directly to the player, where 100 means fainting) +# lore: List of additional text on the finished brew. (Formatting codes possible: such as &6) +# Specific lore for quality possible, using + bad, ++ normal, +++ good, added to the front of the line. +# servercommands: List of Commands executed by the -Server- when drinking the brew (Can use %player_name% %quality%) +# playercommands: List of Commands executed by the -Player- when drinking the brew (Can use %player_name% %quality%) +# Specific Commands for quality possible, using + bad, ++ normal, +++ good, added to the front of the line. +# drinkmessage: Chat-message to the Player when drinking the Brew +# drinktitle: Title on Screen to the Player when drinking the Brew +# glint: Boolean if the item should have a glint (enchant glint) +# customModelData: Custom Model Data Tag. This is a number that can be used to add custom textures to the item. +# Can specify one for all, or one for each quality, separated by / +# effects: List of effect/level/duration Special potion-effect when drinking, duration in sek. +# Possible Effects: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/potion/PotionEffectType.html +# Level or Duration ranges may be specified with a "-", ex. 'SPEED/1-2/30-40' = lvl 1 and 30 sec at worst and lvl 2 and 40 sec at best +# Ranges also work high-low, ex. 'POISON/3-1/20-5' for weaker effects at good quality. +# Highest possible Duration: 1638 sec. Instant Effects dont need any duration specified. + +recipes: + # Example Recipe with every possible entry first: + ex: + name: Bad Example/Example/Good Example + ingredients: + - Diamond/1 + - Spruce_Planks/8 + - Bedrock/1 + - Brewery:Wheatbeer/2 +# - ExoticGarden:Grape/3 + - ex-item/4 + cookingtime: 3 + distillruns: 2 + distilltime: 60 + wood: 4 + age: 11 + color: DARK_RED + difficulty: 3 + alcohol: 14 + lore: + - This is an examble brew + - ++Just a normal Example + - This text would be on the brew + - + Smells disgusting + - ++ Smells alright + - +++ Smells really good + servercommands: + - +++ weather clear + - + weather rain + playercommands: + - homes + drinkmessage: Tastes good + drinktitle: Warms you from inside + glint: true + customModelData: 556/557/557 + effects: + - FIRE_RESISTANCE/20 + - HEAL/1 + - WEAKNESS/2-3/50-60 + - POISON/1-0/20-0 + + wheatbeer: + name: Skunky Wheatbeer/Wheatbeer/Fine Wheatbeer + ingredients: + - Wheat/3 + cookingtime: 8 + distillruns: 0 + wood: 1 + age: 2 + color: 'ffb84d' # Orange + difficulty: 1 + alcohol: 5 + lore: +++ &8Refreshing + + beer: + name: Skunky Beer/Beer/Fine Beer + ingredients: + - Wheat/6 + cookingtime: 8 + distillruns: 0 + wood: 0 + age: 3 + color: 'ffd333' # Bright Orange + difficulty: 1 + lore: + - +++ &8Crisp taste + alcohol: 6 + + darkbeer: + name: Skunky Darkbeer/Darkbeer/Fine Darkbeer + ingredients: + - Wheat/6 + cookingtime: 8 + distillruns: 0 + wood: 6 + age: 8 + color: '650013' # Dark Red-Brown + difficulty: 2 + lore: + - +++ &8Roasted taste + alcohol: 7 + + wine: + name: Red Wine + ingredients: + - Sweet_Berries/5 + cookingtime: 5 + distillruns: 0 + wood: 0 + age: 20 + color: RED + difficulty: 4 + alcohol: 8 + lore: + - '+ &8Harsh' + - '+ &8Corked' + - '++ &8Mellow' + - '+++ &8Full-Bodied' + + mead: + name: Awkward Mead/Mead/&6Golden Mead + ingredients: + - Sugar_Cane/6 + cookingtime: 3 + distillruns: 0 + wood: 2 + age: 4 + color: ORANGE + difficulty: 2 + lore: + - +++ Has a golden shine + alcohol: 9 + + ap_mead: + name: Apple Mead/Sweet Apple Mead/&6Sweet Golden Apple Mead + ingredients: + - Sugar_Cane/6 + - Apple/2 + cookingtime: 4 + distillruns: 0 + wood: 2 + age: 4 + color: ORANGE + difficulty: 4 + alcohol: 11 + lore: + - +Is there any Apple in this? + - ++Refreshing taste of Apple + - +++Sweetest hint of Apple + effects: + - WATER_BREATHING/1-2/150 + + cidre: + name: Poor Cidre/Apple Cider/Great Apple Cider + ingredients: + - Apple/14 + cookingtime: 7 + distillruns: 0 + wood: 0 + age: 3 + color: 'f86820' # Red-Orange + difficulty: 4 + alcohol: 7 + + apple_liquor: + name: Sour Apple Liquor/Apple Liquor/Calvados + ingredients: + - Apple/12 + cookingtime: 16 + distillruns: 3 + wood: 5 + age: 6 + color: BRIGHT_RED + difficulty: 5 + alcohol: 14 + lore: + - +Sour like Acid + - +++ Good Apple Liquor + + whiskey: + name: Unsightly Whiskey/Whiskey/Scotch Whiskey + ingredients: + - Wheat/10 + cookingtime: 10 + distillruns: 2 + distilltime: 50 + wood: 4 + age: 18 + color: ORANGE + difficulty: 7 + alcohol: 26 + lore: '&7Single Malt' + + rum: + name: Bitter Rum/Spicy Rum/&6Golden Rum + ingredients: + - Sugar_Cane/18 + cookingtime: 6 + distillruns: 2 + distilltime: 30 + wood: 2 + age: 14 + color: DARK_RED + difficulty: 6 + alcohol: 30 + effects: + - FIRE_RESISTANCE/1/20-100 + - POISON/1-0/30-0 + lore: + - +&8Too bitter to drink + - ++&8Spiced by the barrel + - +++&eSpiced Gold + + vodka: + name: Lousy Vodka/Vodka/Russian Vodka + ingredients: + - Potato/10 + cookingtime: 15 + distillruns: 3 + age: 0 + color: WHITE + difficulty: 4 + alcohol: 20 + lore: + &8Almost undrinkable + effects: + - WEAKNESS/15 + - POISON/10 + + shroom_vodka: + name: Mushroom Vodka/Mushroom Vodka/Glowing Mushroom Vodka + ingredients: + - Potato/10 + - Red_Mushroom/3 + - Brown_Mushroom/3 + cookingtime: 18 + distillruns: 5 + age: 0 + color: 'ff9999' # Pink-Red + difficulty: 7 + alcohol: 18 + lore: +++&aGlows in the dark + effects: + - WEAKNESS/80 + - CONFUSION/27 + - NIGHT_VISION/50-80 + - BLINDNESS/12-2 + - SLOW/10-3 + + gin: + name: Pale Gin/Gin/Old Tom Gin + ingredients: + - Wheat/9 + - blue-flowers/6 # Custom-Item: Blue Orchids or Cornflowers + - Apple/1 + cookingtime: 6 + distillruns: 2 + color: '99ddff' # Very light blue + difficulty: 6 + alcohol: 20 + lore: + - ++ With the + - ++ taste of juniper + - +++ Perfectly finished off + - +++ with juniper + + tequila: + name: Mezcal/Tequila/Tequila anejo + ingredients: + - cactus/8 + cookingtime: 15 + distillruns: 2 + color: 'f5f07e' # Green-Orange + difficulty: 5 + wood: 1 + age: 12 + alcohol: 20 + lore: Desert spirit + + absinthe: + name: Poor Absinthe/Absinthe/Strong Absinthe + ingredients: + - Short_Grass/15 + cookingtime: 3 + distillruns: 6 + distilltime: 80 + color: GREEN + difficulty: 8 + alcohol: 42 + effects: + - POISON/15-25 + lore: '+++&8High proof liquor' + + gr_absinthe: + name: Poor Absinthe/Green Absinthe/Bright Green Absinthe + ingredients: + - Short_Grass/17 + - Poisonous_Potato/2 + cookingtime: 5 + distillruns: 6 + distilltime: 85 + color: LIME + difficulty: 9 + alcohol: 46 + effects: + - POISON/25-40 + - HARM/2 + - NIGHT_VISION/40-60 + lore: '&aLooks poisonous' + + potato_soup: + name: Potato soup + ingredients: + - Potato/5 + - Short_Grass/3 + cookingtime: 3 + color: ORANGE + difficulty: 1 + effects: + - HEAL/0-1 + + coffee: + name: Stale Coffee/Coffee/Strong Coffee + ingredients: + - Cocoa_Beans/12 + - Milk_Bucket/2 + cookingtime: 2 + color: BLACK + difficulty: 3 + alcohol: -6 + lore: + &8Probably a week old + effects: + - REGENERATION/1/2-5 + - SPEED/1/30-140 + + eggnog: + name: Egg Liquor/Eggnog/Advocaat + ingredients: + - Egg/5 + - Sugar/2 + - Milk_Bucket/1 + cookingtime: 2 + color: 'ffe680' + difficulty: 4 + alcohol: 10 + wood: 0 + age: 3 + lore: Made with raw egg + + + + +# I don't want to add more Recipes to the default config, as they would be public and viewable by users to cheat. +# It is up to the Serveradmin to change and add Recipes, so players cannot cheat from the default config. +# Some suggestions for recipes you could use: + + # g_vodka: + # name: 'Rancid Vodka/&6Golden Vodka/&6Shimmering Golden Vodka' + # ingredients: + # - Potato/10 + # - Gold_Nugget/2 + # cookingtime: 18 + # distillruns: 3 + # age: 0 + # color: ORANGE + # difficulty: 6 + # alcohol: 20 + # effects: + # - WEAKNESS/28 + # - POISON/4 + + # fire_whiskey: + # name: Powdery Whiskey/Burning Whiskey/Blazing Whiskey + # ingredients: + # - Wheat/10 + # - Blaze_Powder/2 + # cookingtime: 12 + # distillruns: 3 + # distilltime: 55 + # wood: 4 + # age: 18 + # color: ORANGE + # difficulty: 7 + # alcohol: 28 + # drinkmessage: 'You get a burning feeling in your mouth' + +# Without Alcohol: + + # hot_choc: + # name: Hot Chocolate + # ingredients: + # - cookie/3 + # cookingtime: 2 + # color: DARK_RED + # difficulty: 2 + # effects: + # - FAST_DIGGING/40 + + # iced_coffee: + # name: Watery Coffee/Iced Coffee/Strong Iced Coffee + # ingredients: + # - cookie/8 + # - snowball/4 + # - milk_bucket/1 + # cookingtime: 1 + # color: BLACK + # difficulty: 4 + # alcohol: -8 + # effects: + # - REGENERATION/30 + # - SPEED/10 + + +# More Recipe ideas: +# Dandelion Liquor +# Beetroot Spirit, +# Poppy Liquor: Macum/Grand Poppy, +# Bamboo Liquor: Chu Yeh Ching, +# Cachaca, +# Cognac, +# Sake, +# Buorbon, +# Moonshine, +# Different Wines, +# Brandy, +# Amaretto, +# etc. as well as variations like, +# Pumpkin Spice Beer, +# Melon Vodka + +# There are a lot of items in Minecraft like Vines, Milk and items added by plugins that would make great ingredients. + + +# -- Plugin Compatibility -- + +# Enable checking of other Plugins (if installed) for Barrel Permissions [true] +# Plugins 'Landlord' and 'Protection Stones' use the WorldGuard Flag. 'ClaimChunk' is natively supported. +useWorldGuard: true +useLWC: true +useGriefPrevention: true +useTowny: true +useBlockLocker: true +useGMInventories: true + +# Use a virtual chest when opening a Barrel to check with all other protection plugins +# This could confuse Anti-Cheat plugins, but is otherwise good to use +# use this for 'Residence' Plugin and any others that don't check all cases in the PlayerInteractEvent +useVirtualChestPerms: false + + +# Enable the Logging of Barrel Inventories to LogBlock [true] +useLogBlock: true + + +# -- MultiServer/BungeeCord -- +# If Brewery is running on multiple connected Servers (via BungeeCord) +# a shared Database can be used here to synchronise drunkenness and to be able to use encoded brews between them. + +multiServerDB: + # If using the Database is enabled + enabled: false + # If the drunkenness of players should be synchronised between Servers + syncDrunkeness: true + host: localhost + port: '3306' + user: minec + password: xyz + database: base + + +# -- Various Other Settings -- + +# If items in Offhand should be added to the cauldron as well [false] +useOffhandForCauldron: false + +# If Barrel and Cauldron data can be loaded Async/in the Background [true] +loadDataAsync: true + +# Time (in days) that drunkenness-data stays in memory after a player goes offline, to apply hangover etc. [7] +hangoverDays: 7 + +# Color the Item information (lore) depending on quality while it is 1. in a barrel and/or 2. in a brewing stand [true, true] +colorInBarrels: true +colorInBrewer: true + +# If a Large Barrel can be opened by clicking on any of its blocks, not just Spigot or Sign. This is always true for Small Barrels. [true] +openLargeBarrelEverywhere: true + +# Allow emptying brews into hoppers to discard brews while keeping the glass bottle [true] +brewHopperDump: true + + +# -- Chat Distortion Settings -- + +# If written Chat is distorted when the Player is Drunk, so that it looks like drunk writing +# How much the chat is distorted depends on how drunk the Player is +# Below are settings for what and how changes in chat occur +enableChatDistortion: true + +# Log to the Serverlog what the player actually wrote, before his words were altered [false] +logRealChat: false + +# Text after specified commands will be distorted when drunk (list) [- /gl] +distortCommands: +- /gl +- /global +- /fl +- /s +- /letter +- /g +- /l +- /lokal +- /local +- /mail send +- /m +- /msg +- /w +- /whisper +- /reply +- /r +- /t +- /tell + +# Distort the Text written on a Sign while drunk [false] +distortSignText: false + +# Enclose a Chat text with these Letters to bypass Chat Distortion (Use "," as Separator) (list) [- '[,]'] +# Chat Example: Hello i am drunk *I am testing Brewery* +distortBypass: +- '*,*' +- '[,]' + +# words: Words and letters that will be altered when chatting while being drunk. +# Will be processed from first to last and a written sentece is altered in that order. + +# replace: Word or letter to be replaced. (Special: "-space": replaces space, "-random": insert into random position, "-all": everything, "-start": At Beginning, "-end": At the End.) +# to: What to replace it with. +# pre: Words and Letters before the wanted word (split with ",") +# match: true = one of the "pre"-Words has to be before the wanted Word, false = none of the "pre" Words is allowed before the wanted Word +# alcohol: 1-100 minimum drunkenness after which this word ist replaced +# percentage: Probability of replacing a Word in percent + +words: +- replace: s + to: sh + percentage: 90 + alcohol: 30 + +- replace: ch + to: sh + pre: u,s,o,a + match: false + alcohol: 10 + percentage: 70 + +- replace: h + to: hh + pre: sch,h,t + match: false + percentage: 60 + alcohol: 20 + +- replace: th + to: thl + percentage: 40 + alcohol: 30 + +- replace: sch + to: shk + percentage: 60 + alcohol: 40 + +- replace: u + to: uuh + percentage: 20 + +- replace: y + to: yy + percentage: 60 + alcohol: 15 + +- replace: e + to: ee + percentage: 40 + alcohol: 15 + +- replace: you + to: u + percentage: 40 + +- replace: u + to: uo + pre: u + match: false + percentage: 60 + +- replace: that + to: taht + percentage: 20 + alcohol: 40 + +- replace: p + to: b + percentage: 30 + +- replace: p + to: b + percentage: 70 + alcohol: 60 + +- replace: up + to: ubb + percentage: 80 + alcohol: 25 + +- replace: o + to: oh + percentage: 20 + +- replace: ei + to: i + percentage: 30 + alcohol: 15 + +- replace: b + to: bb + percentage: 80 + alcohol: 40 + +- replace: '!!!' + to: '!!!111!!!eleven!1!' + pre: '!' + match: false + percentage: 20 + alcohol: 70 + +- replace: '!' + to: '!!' + pre: '!' + match: false + percentage: 90 + +- replace: drunk + to: dhrkunn + pre: are + match: false + percentage: 70 + alcohol: 65 + +- replace: walk + to: whhealhk + pre: you can, you can still, you can not + match: false + percentage: 80 + alcohol: 30 + +- replace: wtf + to: wft + percentage: 20 + alcohol: 40 + +- replace: lol + to: loool + percentage: 80 + alcohol: 10 + +- replace: afk + to: aafkayyy + percentage: 30 + alcohol: 30 + +- replace: write + to: wreitt + pre: you can,you can still,you can not + match: false + percentage: 80 + alcohol: 50 + +- replace: drink + to: booze + percentage: 80 + alcohol: 70 + +- replace: '?' + to: '????' + pre: '?' + match: false + percentage: 80 + alcohol: 40 + +- replace: -space + to: '' + pre: h,g,w + match: true + alcohol: 10 + +- replace: -space + to: '' + percentage: 30 + alcohol: 35 + +- replace: -space + to: '' + percentage: 10 + +- replace: -start + to: dho + percentage: 15 + alcohol: 50 + +- replace: -start + to: hhn + percentage: 10 + alcohol: 50 + +- replace: -random + to: lu + percentage: 10 + +- replace: -random + to: lug + percentage: 10 + alcohol: 50 + +- replace: -random + to: blub + percentage: 20 + alcohol: 80 + +- replace: -random + to: lerg + percentage: 40 + alcohol: 85 + +- replace: -random + to: gul + percentage: 40 + alcohol: 80 + +- replace: -random + to: ' ' + percentage: 100 + alcohol: 70 + +- replace: -random + to: ' ' + percentage: 60 + alcohol: 40 + +- replace: -random + to: ' ' + percentage: 50 + alcohol: 30 + +- replace: -end + to: '!' + percentage: 40 + alcohol: 30 + +- replace: -random + to: ' *hic* ' + percentage: 80 + alcohol: 70 + +- replace: -random + to: ' *hic* ' + percentage: 15 + alcohol: 40 + +- replace: -space + to: ' *hic* ' + percentage: 5 + alcohol: 20 + +- replace: -end + to: ' *hic*' + percentage: 70 + alcohol: 50 + +- replace: -all + to: '*burp*' + percentage: 3 + alcohol: 60 + +- replace: -all + to: '*burp*' + percentage: 6 + alcohol: 80 + +``` \ No newline at end of file diff --git a/docs/ru/guide/edit_config.md b/docs/ru/guide/edit_config.md new file mode 100644 index 00000000..b8a03116 --- /dev/null +++ b/docs/ru/guide/edit_config.md @@ -0,0 +1,187 @@ + +# Настройка конфига + +В конфиге BreweryX есть много своих приколюх, которые мы сейчас разберём. + +## Язык: `language` + +Язык сообщений BreweryX. Может быть любым из папки `BreweryX/languages/`. + +Текущие языки: `en`, `ru`, `de`, `es`, `fr`, `it`, `tw`, `zh` + +## Префикс плагина: `pluginPrefix` + +Это то, что будет написано перед сообщением плагина. + +Дефолтное значение: `pluginPrefix: '&2[Brewery]&f'` + +## Тип home: `homeType` + +Это та команда, которая будет прописываться от лица игрока когда он нажрётся в сопли и зайдёт снова на сервер. + +Дефолтное значение: `homeType: 'cmd: home'` + +## Последствия пьянки: `enableWake` + +`true` - игрок будет просыпаться в случайных точках, которые были установлены командой `/brew Wakeup add` админом после жёсткой пьянки и некоторого времени в оффлайне + +`false` - отключает эту фичу + +Дефолтное значение: `enableWake: true` + +## Трудности со входом: `enableLoginDisallow` + +`true` - игроку потребуется несколько раз перезайти на сервер, если он чрезвычайно пьян + +`false` - отключает эту фичу + +## Последствия пьянки 2.0: `enableKickOnOverdrink` + +`true` - кикает игрока, если он **очень быстро** ужрался + +`false` - отключает эту фичу + +## Блевотня: `enablePuke` + +`true` - если игрок очень пьян, то он будет "блевать" предметами, определенными в `pukeItem` + +`false` - отключает эту фичу + +## Тип блевотни: `pukeItem` + +Список предметов через запятую, которыми игрок будет рыгать, если включено `enablePuke` + +Дефолтное значение: pukeItem: [Soul_Sand] + +## Время исчезания блевотни: `pukeDespawnTime` + +Сколько в секундах будет исчезать предмет блевотни. + +Дефолтное значение: `pukeDespawntime: 60` + +## Трудности в ходьбе: `stumblePercent` + +Число, насколько сложно игроку ходить при сильном опьянении, от `0` до `1000` + +Дефолтное значение: `stumblePercent: 100` + +## Уровень алкоголя при выпивании: `showStatusOnDrink` + +`true` - показывать игроку насколько он пьян при выпивании + +`false` - не показывать + +## Снятие опьянения: `drainItems` + +Список ванильных предметов, которые убирают опьянение в формате `Название Предмета/Сколько очков опьянения снимает` + +Дефолтные значения: + +```yaml +drainItems: + - Bread/4 + - Milk_Bucket/2 +``` + +## Эффекты котла: `enableCauldronParticles` + +`true` - у котла есть эффекты + +`false` - нет + +## Количество партиклов котла: `minimalParticles` + +`true` - снизить количество партиклов котла до минимума + +`false` - оставить всё как есть + +## Крафт стола закупоривания: `craftSealingTable` + +`true` - крафт стола закупоривания включен + +`false` - отключен + +## Включен ли стол закупоривания: `enableSealingTable` + +`true` - столом закупоривания можно пользоваться + +`false` - нельзя + +## Показывать качество напитка: `alwaysShowQuality` + +`true` - всегда показывать качества напитка в описании напитка + +`false` - только во время брожжения/дистиляции + +## Показывать уровень алкоголя напитка: `alwaysShowAlc` + +`true` - всегда показывать уровень алкоголя напитка в описании напитка + +`false` - только во время дистиляции + +## Показывать кто сварил напиток: `showBrewer` + +`true` - показывать кто сварил напиток в описании напитка + +`false` - не показывать + +## Можно ли бродить в майнкрафтовских бочках: `ageInMCBarrels` + +`true` - напитки можно бродить в обычной бочке + +`false` - нельзя + +## Сколько слотов в обычной бочке: `maxBrewsInMCBarrels` + +Число - сколько слотов доступно в обычной бочке. + +Дефолтное значение: `maxBrewsInMCBarrels: 6` + +## Кодировка напитков: `enableEncode` + +Эта настройка (если в `true`) позволяет закодировать компоненты (NBT) напитка, чтобы читеры не смогли узнать что это за напиток, кто его сварил и какой у него точный рецепт. + +**Важно**! С включенной настройкой напитки можно хранить только на одном сервере. Все закодированные напитки не смогут передаваться через миры, их скачивание, схематики и т.п. + +## Тип кодировки: `encodeKey` + +Надо узнать у разработчика... + +## Проверка обновлений: `updateCheck` + +Проверять ли на обновление BreweryX + +## Автосохранение: `autosave` + +Число в минутах, раз в сколько сохранять все данные BreweryX + +## Дебаг: `debug` + +Включить ли дебаг плагина + +## Версия конфига: `version` + +НЕ ТРОГАТЬ НИКОГДА. + +## Запутанный чат: `words` + +Эта настройка находится в самом конце конфига, она позволяет изменять сообщения в чате от пьяных игроков. + +Пример настройки выглядит так: + +```yaml +words: +- replace: е # Заменять все буквы "е" + to: ЕЕЕ # на "ЕЕЕ" + percentage: 90 # Шанс того, что буква "е" заменится + alcohol: 30 # От какого уровня алкоголя будет работать эта настройка + +- replace: й # Заменять все буквы "й" + to: ЙЙ # На "ЙЙ" + pre: у # Если перед этим была буква "у" + match: false # Должна ли буква "y" быть перед "й" для работы этой настройки + alcohol: 10 # От какого уровня алкоголя будет работать эта настройка + percentage: 70 # Шанс того, что буква "й" заменится +``` + +## To be continued... \ No newline at end of file diff --git a/docs/ru/guide/recipies.md b/docs/ru/guide/recipies.md index 05d67c51..87d3c8e1 100644 --- a/docs/ru/guide/recipies.md +++ b/docs/ru/guide/recipies.md @@ -5,8 +5,9 @@ ## Название напитка: `name` -!!! warning "" - Обязательное значение +| Обязательно? | Значение | Дефолтное значение | +| --------- | ----- | ------------- | +|Да|`Название плохого напитка/Название нормального напитка/Название хорошего напитка`|Нет| Название напитка. Может отличаться в зависимости от качества напитка, если установлено вот так: @@ -25,8 +26,9 @@ ## Ингредиенты: `ingredients` -!!! warning "" - Обязательное значение +| Обязательно? | Значение | Дефолтное значение | +| --------- | ----- | ------------- | +|Да|`- НазваниеПредмета/ЕгоКоличество`|Нет| Это ингредиенты, нужные для варки. Принимаются такие значения: @@ -55,8 +57,9 @@ ## Время варки: `cookingtime` -!!! warning "" - Обязательное значение +| Обязательно? | Значение | Дефолтное значение | +| --------- | ----- | ------------- | +|Да|Число|Нет| Сколько (в минутах) нужно варить напиток до идеального состояния. @@ -68,8 +71,9 @@ ## Сколько раз дистиллировать: `distillruns` -!!! warning "" - Не нужно, если нет `distilltime` +| Обязательно? | Значение | Дефолтное значение | +| --------- | ----- | ------------- | +|Нет, если нет `distillruns`|Число|0| How much times player need to distill brew @@ -81,8 +85,9 @@ How much times player need to distill brew ## Время дистилляции: `distilltime` -!!! warning "" - Не нужно, если нет `distillruns` +| Обязательно? | Значение | Дефолтное значение | +| --------- | ----- | ------------- | +|Нет|Время в секундах|0| Сколько (по времени,в секундах) будет идти одна дистилляция @@ -94,8 +99,9 @@ How much times player need to distill brew ## Тип дерева бочки: `wood` -!!! warning "" - Необязательное значение, по дефолту - `0` +| Обязательно? | Значение | Дефолтное значение | +| --------- | ----- | ------------- | +|Нет|Цифра типа дерева|Нет| Тип дерева, в котором нужно бродить напитку. Принимает такие значения: @@ -131,8 +137,9 @@ How much times player need to distill brew ## Время брожения: `age` -!!! warning "" - Необязательное значение +| Обязательно? | Значение | Дефолтное значение | +| --------- | ----- | ------------- | +|Нет|Число в игровых днях|0| Сколько внутриигровых дней напитку нужно побродить для идеального качества. @@ -144,8 +151,9 @@ How much times player need to distill brew ## Цвет напитка: `color` -!!! warning "" - Необязательное значение, дефолтное значение - `WHITE` +| Обязательно? | Значение | Дефолтное значение | +| --------- | ----- | ------------- | +|Нет|HEX цвет или название цвета|`WHITE`| Цвет напитка. Может быть HEX цветом или одним из `DARK_RED`, `RED`, `BRIGHT_RED`, `ORANGE`, `YELLOW`, `PINK`, `PURPLE`, `BLUE`, `CYAN`, `WATER`, `TEAL`, `OLIVE`, `GREEN`, `LIME`, `BLACK`, `GREY`, `BRIGHT_GREY`, `WHITE` @@ -159,8 +167,9 @@ How much times player need to distill brew ## Сложность напитка: `difficulty` -!!! warning "" - Обязательное значение +| Обязательно? | Значение | Дефолтное значение | +| --------- | ----- | ------------- | +|Да|Число `1` - `10`|Нет| Насколько сильно нужно следовать рецепту, от `1` до `10`, где `1` - можно ошибаться, а `10` - ошибаться нельзя вообще. @@ -174,8 +183,9 @@ How much times player need to distill brew ## Уровень алкоголя: `alcohol` -!!! warning "" - Необязательное значение, дефолтное значение - `0` +| Обязательно? | Значение | Дефолтное значение | +| --------- | ----- | ------------- | +|Нет|Число `0` - `100`|`0`| Сколько алкоголя находится в напитке, от `0` до `100`, где `0` - отсутствие алкоголя, а `100` - пьяный угар @@ -187,8 +197,9 @@ How much times player need to distill brew ## Описание напитка: `lore` -!!! warning "" - Необязательное значение +| Обязательно? | Значение | Дефолтное значение | +| --------- | ----- | ------------- | +|Нет|Список|Нет| Просто описание напитка. Может варьироваться в зависимости от качества напитка. @@ -204,8 +215,9 @@ How much times player need to distill brew ## Серверные команды: `servercommands` -!!! warning "" - Необязательное значение +| Обязательно? | Значение | Дефолтное значение | +| --------- | ----- | ------------- | +|Нет|Список|Нет| Команды, которые будут прописаны от лица сервера при выпивании напитка. Может варьироваться в зависимости от качества напитка. @@ -224,8 +236,9 @@ How much times player need to distill brew ## Команды игрока: `playercommands` -!!! warning "" - Необязательное значение +| Обязательно? | Значение | Дефолтное значение | +| --------- | ----- | ------------- | +|Нет|Список|Нет| Команды, которые будут прописаны от лица игрока. Может варьироваться в зависимости от качества напитка. @@ -244,8 +257,9 @@ How much times player need to distill brew ## Сообщение при выпивании: `drinkmessage` -!!! warning "" - Необязательное значение +| Обязательно? | Значение | Дефолтное значение | +| --------- | ----- | ------------- | +|Нет|Строка|Нет| Сообщение, которое напишется игроку в чат после выпивания напитка. @@ -257,8 +271,9 @@ How much times player need to distill brew ## Title после выпивания: `drinktitle` -!!! warning "" - Необязательное значение +| Обязательно? | Значение | Дефолтное значение | +| --------- | ----- | ------------- | +|Нет|Строка|Нет| "Title" сообщение, которое покажется игроку после выпивания напитка. @@ -270,8 +285,9 @@ How much times player need to distill brew ## Эффект зачарования: `glint` -!!! warning "" - Необязательное значение, дефолтное значение - `false` +| Обязательно? | Значение | Дефолтное значение | +| --------- | ----- | ------------- | +|Нет|Булевое значение `true` или `false`|Нет| Добавлять ли напитку эффект зачарования. @@ -283,8 +299,9 @@ How much times player need to distill brew ## CMD предмета: `customModelData` -!!! warning "" - Необязательное значение. +| Обязательно? | Значение | Дефолтное значение | +| --------- | ----- | ------------- | +|Нет|Аналогия с названием - `CMD плохого напитка/CMD нормального напитка/CMD хорошего напитка`|Нет| Custom model data напитка. Может варьироваться в зависимости от качества напитка - Плохое/Нормальное/Хорошее @@ -296,8 +313,9 @@ Custom model data напитка. Может варьироваться в за ## Эффекты: `effects` -!!! warning "" - Необязательное значение +| Обязательно? | Значение | Дефолтное значение | +| --------- | ----- | ------------- | +|Нет|`НАЗВАНИЕ_ЭФФЕКТА/УРОВЕНЬ/ПРОДОЛЖИТЕЛЬНОСТЬ`|Нет| Эффекты, которые будут даны игроку после употребления алкоголя. diff --git a/mkdocs.yml b/mkdocs.yml index 3f32fc69..605c0b08 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -94,7 +94,9 @@ extra: inprogress: Article is in progress nav: - '': index.md - - Guides: + - Documentation: - en/guide/recipies.md - en/guide/brewing_guide.md - - en/guide/custom_items.md \ No newline at end of file + - en/guide/custom_items.md + - en/guide/edit_config.md + - en/guide/default_config.md \ No newline at end of file