Merge pull request #20 from szarkans/master

Dosc | Fixes, russian version
BreweryTeam · Aug 12, 2024 · fc2111f · fc2111f
2 parents 6217765 + 805e1a6
commit fc2111f
Show file tree

Hide file tree

Showing 119 changed files with 15,781 additions and 161 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -32,7 +32,7 @@ jobs:
           python-version: "3.12"
 
       - name: Install mkdocs
-        run: pip install mkdocs mkdocs-material mkdocs-open-in-new-tab mkdocs-minify-plugin
+        run: pip install mkdocs mkdocs-material mkdocs-open-in-new-tab mkdocs-minify-plugin mkdocs-static-i18n
 
       - name: Build docs
         run: mkdocs build

diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,3 @@
+{
+    "editor.wordBasedSuggestions": "off"
+}
diff --git a/config/ru/mkdocs.yml b/config/ru/mkdocs.yml
@@ -0,0 +1,98 @@
+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
diff --git a/docs/guide/brewing_guide.md → docs/en/guide/brewing_guide.md b/docs/guide/brewing_guide.md → docs/en/guide/brewing_guide.md
diff --git a/docs/guide/custom_items.md → docs/en/guide/custom_items.md b/docs/guide/custom_items.md → docs/en/guide/custom_items.md
@@ -17,24 +17,64 @@ customItems:
 
 ### `matchAny`
 
-`true`/`false` - if you need to match only one param of custom item.
+`true` or `false` - if you need to match only one param or every param of custom item.
+
+In this example it will count as custom item only if name is `Gycha` or it is one of a list.
+
+```yaml
+customItems:
+  ex-item:
+    matchAny: false
+    material: 
+      - Barrier
+      - Bedrock
+    name: 'Gycha'
+```
 
 ### `material`
 
 Material or list of material that should be counted as custom item
 
+```yaml
+customItems:
+  ex-item:
+    material: 
+      - Barrier
+      - Bedrock
+      - Gycha
+```
+
 ### `name`
 
 Custom name that item has to have to be counted as custom item
 
+```yaml
+customItems:
+  ex-item:
+    name: '&8Some name'
+```
+
 ### `lore`
 
-Custom lore that item has to have to be counted as custom item
+Custom lore that item has to have to be counted as custom item.
+
+```yaml
+customItems:
+  ex-item:
+    lore:
+    - '&7Dont end my edge streak.'
+```
 
 ### `customModelData`
 
 Custom model data that item has to have to be counted as custom item
 
+```yaml
+customItems:
+  ex-item:
+    customModelData: 1337
+```
+
 ## Example of usage
 
 ```yaml

diff --git a/docs/guide/recipies.md → docs/en/guide/recipies.md b/docs/guide/recipies.md → docs/en/guide/recipies.md
@@ -195,7 +195,7 @@ TestBrew:
     - "This text will always be present"
     - + "This text will be present if brew has bad quality"
     - ++ "This text will be present if brew has normal quality"
-    - ++ "This text will be present if brew has good quality"
+    - +++ "This text will be present if brew has good quality"
 ```
 
 ## Executing server commands on drink: `servercommands`

diff --git a/docs/index.md → docs/en/index.md b/docs/index.md → docs/en/index.md
@@ -10,7 +10,9 @@ hide:
 icon: fontawesome/solid/house
 ---
 
-# BreweryX
+<h1 class="white">  
+    Brewery<span class="neon">X</span>
+</h1>
 
 !!! warning "Warning"
     This docs under very heavy construction!
@@ -52,7 +54,7 @@ Original Brewery is **decade** old with no support, so we took this plugin into
 
 - Constantly adding new things, fixing bugs, and giving life to this old plugin!
 
-<div class="grid cards" markdown>
+<!-- <div class="grid cards" markdown>
 
 - :fontawesome-solid-wine-bottle: Brewing!
 
@@ -68,4 +70,4 @@ Original Brewery is **decade** old with no support, so we took this plugin into
 
 - :material-unfold-more-vertical: And so much more!
 
-    Plugins, IA & Oraxen items support, cocktails support and etc!
+    Plugins, IA & Oraxen items support, cocktails support and etc! -->
diff --git a/docs/ru/guide/brewing_guide.md b/docs/ru/guide/brewing_guide.md
@@ -0,0 +1,64 @@
+
+# Как варить?
+
+Время варки! BreweryX предлагает уникальную систему варки напитков с помощью **Ферментирования**, **Брожения** и **Дистилляции**! В варке напитков самое важное - следовать рецепту, ведь, в зависимости от установленной сложности напитка, брага может получится неудачной.
+
+Для варки подготовь Котёл, Варочную стойку и Бочку.
+
+## Ферментирование
+
+Здесь мы начинаем варить напиток по ингредиентам!
+
+1. Поставь Котёл над любым горящим блоком - Огонь/Лава/Магма/Прочее
+
+2. Наполни котёл водой
+
+3. Добавь необходимые ингредиенты в котёл, нажимая ПКМ
+
+4. ПКМ по котлу **Часами** покажет в чат сколько времени напиток варится
+
+5. Когда нужно - нажми ПКМ по котлу **пустыми колбами**, чтобы наполнить их напитком
+
+6. ???
+
+7. ПРОФИТ!
+
+![Fermetting](https://camo.githubusercontent.com/c5cb7d3fe6ada1cd5fb1bec17d35774ed16ddee4bb39fbc473ef7b062bf34119/687474703a2f2f692e696d6775722e636f6d2f3144636c6e31392e706e67)
+
+## Дистилляция
+
+Некоторым рецептам нужна дистиляция.
+
+1. Положи напиток в зельеварочную стойку
+
+2. Положи **светопыль** в верхний слот
+
+3. Подожди пока дистиляция пройдёт
+
+4. ???
+
+5. ПРОФИТ!
+
+![Distilling](https://camo.githubusercontent.com/ade33c5b2f1ebf5d7d8d9167cd51e10e7d5edead8f2cd1b7b48a70b8b21941a5/687474703a2f2f692e696d6775722e636f6d2f524a4b563958732e706e67)
+
+## Брожение
+
+Многим напиткам нужно **забродить** из браги в напиток или чтобы улучшить качество напитка. А брожжение это просто... ожидание!
+
+Для этого тебе нужна **Бочка**. Ты можешь использовать обычную бочку из Майнкрафта, она будет работать как бочка **из дуба** и вмещает в себя 6 напитков. Но также ты можешь построить структуру - среднюю или большую бочку. Они нужны, если в рецепте необходимо определенное дерево или просто для увеличения слотов!
+
+### Средняя бочка | 9 слотов
+
+Для "активации" бочки нужно поставить табличку с надписью "barrel" (или то, что указал админ сервера в конфиге)
+
+![Small barrel](https://camo.githubusercontent.com/91a5735dcfa7bbf4aba6c26edf3fe911ec620646fb812be94dc8a897b7534f76/68747470733a2f2f696d6775722e636f6d2f426b4e736935342e706e67)
+
+![Small barrel, side look](https://camo.githubusercontent.com/9788dbdd8e96f04a5cd63dabd556efc640816806a0fe38b8c131ed0506e20983/68747470733a2f2f696d6775722e636f6d2f4d73706c356e362e706e67)
+
+### Большая бочка | 27 слотов
+
+![Big barrel](https://camo.githubusercontent.com/5bf4cf08f7f625abe4031cba4da0383dd4f748721b23322da91593072c1043f8/68747470733a2f2f696d6775722e636f6d2f464f72376c4e352e706e67)
+
+![Big barrel, 2 look](https://camo.githubusercontent.com/106931a5179693500c3f9614bcc2290aa299458b2bb9a10354572d9695dab75f/68747470733a2f2f696d6775722e636f6d2f6b336834716a302e706e67)
+
+После того, как ты положил напитки в бочки, тебе достаточно просто ждать! 1 "год" в BreweryX равняется 1 внутриигровому дню.
diff --git a/docs/ru/guide/custom_items.md b/docs/ru/guide/custom_items.md
@@ -0,0 +1,74 @@
+# Кастомные предметы 
+
+Ты можешь определить кастомные предметы, которые могут использоваться для варки напитков.
+
+кастомные предметы будут выглядеть так:
+
+```yaml
+customItems:
+  ex-item:
+    material: Barrier # Один или список материалов, которые могут считаться "ex-item"
+    name: 'Wall' # "ex-item" будет учитываться только если предмет имеет имя "Wall"
+    lore:
+      - '&7Очень хорошо защищён' # "ex-item" будет учитываться только если предмет имеет описание "&7Очень хорошо защищён"
+```
+
+## Соответсвовать всем: `matchAny`
+
+`true` или `false` - если нужно соответствовать всем или только одному параметру.
+
+В примере кастомным предметом будет считаться либо один из списка либо с названием "Гыча"
+
+```yaml
+customItems:
+  ex-item:
+    matchAny: false
+    material: 
+      - Barrier
+      - Bedrock
+    name: 'Gycha'
+```
+
+## Предметы: `material`
+
+Материал или список материалов, которые должны считаться кастомным предметом
+
+```yaml
+customItems:
+  ex-item:
+    material: 
+      - Barrier
+      - Bedrock
+      - Gycha
+```
+
+## Имя предмета: `name`
+
+Кастомное имя, которое предмет должен иметь, чтобы считаться кастомным предметом
+
+```yaml
+customItems:
+  ex-item:
+    name: '&6Гыча'
+```
+
+## Описание предмета: `lore`
+
+Кастомное описание, которое предмет должен иметь, чтобы считаться кастомным предметом
+
+```yaml
+customItems:
+  ex-item:
+    lore:
+    - '&7Ммм... хех)...'
+```
+
+## CMD: `customModelData`
+
+Custom model data, которую предмет должен иметь, чтобы считаться кастомным предметом
+
+```yaml
+customItems:
+  ex-item:
+    customModelData: 228
+```