[Docs] Meta-tags, fixes, more config options

- Added meta-tags, so Google and other's will parse our wiki - Moved myself in the list of developers because duuh - Added some config parameters in "edit_config.md" - Added description to every page - it's gonna be in meta-tags - Translated navigations to russian - Changed API versions to 3.3.3, but i dont really know if that's necessary - Just ate a bowl of pasta with ground beef, yummers
BreweryTeam · Oct 26, 2024 · 37a7021 · 37a7021
1 parent 7d446b6
commit 37a7021
Show file tree

Hide file tree

Showing 18 changed files with 235 additions and 53 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,3 @@
+{
+    "editor.wordBasedSuggestions": "off"
+}
diff --git a/docs/en/api/api.md b/docs/en/api/api.md
@@ -14,7 +14,7 @@ For Java developers, use any release jar locally or get any release from [Jitpac
 <dependency>
    <groupId>com.github.Jsinco</groupId>
    <artifactId>BreweryX</artifactId>
-   <version>3.2.5</version>
+   <version>3.3.3</version>
    <scope>provided</scope>
 </dependency>
 ```
@@ -27,6 +27,6 @@ repositories {
 }
 
 dependencies {
-    implementation 'com.github.Jsinco:BreweryX:3.2.5'
+    implementation 'com.github.Jsinco:BreweryX:3.3.3'
 }
 ```
diff --git a/docs/en/guide/brewing_guide.md b/docs/en/guide/brewing_guide.md
@@ -1,3 +1,7 @@
+---
+description: Brewing guide in BreweryX
+---
+
 
 # How to brew?
 

diff --git a/docs/en/guide/custom_items.md b/docs/en/guide/custom_items.md
@@ -1,3 +1,6 @@
+---
+description: How custom items work in BreweryX
+---
 
 # Using custom items
 

diff --git a/docs/en/guide/default_config.md b/docs/en/guide/default_config.md
@@ -1,3 +1,7 @@
+---
+description: Default config of BreweryX
+---
+
 # Default config
 
 This is default config in `en` language

diff --git a/docs/en/guide/edit_config.md b/docs/en/guide/edit_config.md
@@ -1,3 +1,7 @@
+---
+description: How to edit config.yml in BreweryX
+---
+
 # Configuring the config
 
 The Brewery<span class="neon">X</span> config has a lot of its own jokes, which we will now analyze.yze.
@@ -12,6 +16,32 @@ Current languages: `en`, `ru`, `de`, `es`, `fr`, `it`, `tw` and `zh`
 
 ***
 
+## Data storage: `storage`
+
+How to store every BreweryX's data.
+
+`type` - type of data storage, could be:
+
+- `FlatFile` - like in OG Brewery - just an `.yml` file.
+
+- `SQLite` - simple database within a `.db` file
+
+- `MySQL` - big database
+
+Next parameters will work only if `MySQL` is choosen:
+
+- `database` - da name of database
+
+- `tablePrefix` - prefix of tables
+
+- `address` - ip address of mysql databse
+
+- `username` - database access login
+
+- `password` - database access password
+
+***
+
 ## Plugin prefix: `pluginPrefix`
 
 This is what will be written before the plugin message. 
@@ -76,6 +106,17 @@ How many seconds will vomit items disappear.
 
 Default value: `pukeDespawntime: 60`
 
+***
+
+## How much is a year for BreweryX: `agingYearDuration`
+
+ow many days the Brewery will count for an year.
+
+Default value: 20
+
+***
+
+
 ***
 
 ## Difficulty walking: `stumblePercent`
@@ -190,7 +231,9 @@ This setting (if set to `true`) allows you to encode the components (NBT) of the
 
 ## Encoding type: `encodeKey`
 
-Not sure, we need to ask the developer...
+Like a minecraft seed, but for `enableEncode`.
+
+If you want to use same drinks on multiple server connected via Bungee or Velocity, this parameter have to be the same on every server.
 
 ***
 

diff --git a/docs/en/guide/recipies.md b/docs/en/guide/recipies.md
@@ -1,3 +1,6 @@
+---
+description: How to create new recipe in BreweryX
+---
 
 # Creating new recipe
 

diff --git a/docs/en/index.md b/docs/en/index.md
@@ -60,7 +60,7 @@ Our awesome team!
 
     <figure markdown="span">
         ![Jsinco](https://avatars.githubusercontent.com/u/67713846?v=4){ align=right width="150" }
-        <figcaption style="text-align: center;" markdown="1">**Jsinco** Lead Developer</figcaption>
+        <figcaption style="text-align: center;" markdown="1">**Jsinco** - Lead Developer</figcaption>
     </figure>
 
 </div>
@@ -71,35 +71,35 @@ Our awesome team!
 
     <figure markdown="span">
         ![Mitality](https://avatars.githubusercontent.com/u/96748385?v=4){ width="150" }
-        <figcaption>**Mitality** Developer</figcaption>
+        <figcaption>**Mitality** - Developer</figcaption>
     </figure>
 
--  
+- 
 
     <figure markdown="span">
-        ![TTTheKing](https://avatars.githubusercontent.com/u/2845957?v=4){ width="150" }
-        <figcaption>**TTTheKing** Original Author</figcaption>
+        ![Szarkan](https://avatars.githubusercontent.com/u/150809885?v=4){ width="150" }
+        <figcaption>**szarkan** - I made this wiki!</figcaption>
     </figure>
 
 -  
 
     <figure markdown="span">
-        ![Sn0wStorm](https://avatars.githubusercontent.com/u/4077108?v=4){ width="150" }
-        <figcaption>**Sn0wStorm** Original Author</figcaption>
+        ![TTTheKing](https://avatars.githubusercontent.com/u/2845957?v=4){ width="150" }
+        <figcaption>**TTTheKing** - Original Author</figcaption>
     </figure>
 
 -  
 
     <figure markdown="span">
-        ![Grafe](https://avatars.githubusercontent.com/u/2846040?v=4){ width="150" }
-        <figcaption>**Grafe** Original Author</figcaption>
+        ![Sn0wStorm](https://avatars.githubusercontent.com/u/4077108?v=4){ width="150" }
+        <figcaption>**Sn0wStorm** - Original Author</figcaption>
     </figure>
 
-- 
+-  
 
     <figure markdown="span">
-        ![Szarkan](https://avatars.githubusercontent.com/u/150809885?v=4){ width="150" }
-        <figcaption>**szarkan** I made this wiki!</figcaption>
+        ![Grafe](https://avatars.githubusercontent.com/u/2846040?v=4){ width="150" }
+        <figcaption>**Grafe** - Original Author</figcaption>
     </figure>
 
 - 

diff --git a/docs/ru/api/api.md b/docs/ru/api/api.md
@@ -14,7 +14,7 @@
 <dependency>
    <groupId>com.github.Jsinco</groupId>
    <artifactId>BreweryX</artifactId>
-   <version>3.2.5</version>
+   <version>3.3.3</version>
    <scope>provided</scope>
 </dependency>
 ```
@@ -27,6 +27,6 @@ repositories {
 }
 
 dependencies {
-    implementation 'com.github.Jsinco:BreweryX:3.2.5'
+    implementation 'com.github.Jsinco:BreweryX:3.3.3'
 }
 ```
diff --git a/docs/ru/guide/brewing_guide.md b/docs/ru/guide/brewing_guide.md
@@ -1,3 +1,6 @@
+---
+description: Гайд по созданию напитков в BreweryX
+---
 
 # Как варить?
 

diff --git a/docs/ru/guide/custom_items.md b/docs/ru/guide/custom_items.md
@@ -1,3 +1,7 @@
+---
+description: Конфигурация кастомных предметов в BreweryX
+---
+
 # Кастомные предметы 
 
 Ты можешь определить кастомные предметы, которые могут использоваться для варки напитков.

diff --git a/docs/ru/guide/default_config.md b/docs/ru/guide/default_config.md
@@ -1,5 +1,9 @@
+---
+description: Конфигурация по-умолчанию в BreweryX
+---
 
-# Дефолтный конфиг
+
+# Конфигурация по-умолчанию
 
 Это - дефолтный конфиг на Английском языке:
 

diff --git a/docs/ru/guide/default_recipes.md b/docs/ru/guide/default_recipes.md
@@ -0,0 +1,26 @@
+
+# Рецепты из коробки
+
+BreweryX предлагает начальные рецепты - они уже добавлены в `config.yml`.
+
+| Рецепт       | Инградиенты                | Время кипения   | Дистилляция | Выдержка/Дерево | Уровень алкоголя | Эффекты |
+|-------------|-------------|-----|-----|-------|-----|---|
+| Пиво             | 6 Пшеницы                                      | 8 Минут               | Нет  | 3 Года<br>Любое          | I      |    |
+| Пшеничное пиво   | 3 Пшеницы                                      | 8 Минут               | Нет  | 2 Года<br>Береза         | I      |    |
+| Темное пиво      | 6 Пшеницы                                      | 8 Минут               | Нет  | В 3 раза дольше чем пиво<br>Темный дуб| I' |    |
+| Красное вино     | 5 Сладких ягод                                 | 5 Минут               | Нет  | Коротко<br>Any           | I'     |    |
+| Медовуха         | 6 Сахарный тростник                            | 3 Минуты              | Нет  | 4 Года<br>Дуб            | I'     |    |
+| Яблочный Мид     | 6 Сахарный тростник<br>Яблоко                  | Одникаово с медовухой | Нет  | 4 Года<br>Дуб            | II     | +  |
+| Яблочный Сидр    | Много яблок                                    | 7/8 Минут             | Нет  | 3 Года<br>Любое          | I'     |    |
+| Яблочный Ликер   | Много яблок                                    | Долго                 | Да   | 6 Лет<br>Акация          | II'    |    |
+| Виски            | Пшеница                                        | 1 мин./Пшеница        | Да   | Очень долго<br>Темное    | III'   |    |
+| Ром              | Куча сахарного тростника                       | Коротко               | Да   | Долго<br>Дуб             | IIII   | +  |
+| Водка            | Одна шестая стака картошки                     | Долго                 | Да   | Нет                      | III    | -  |
+| Грибная водка    | Картошка, Грибы                                | Очень долго           | Да   | Нет                      | II'    | +- |
+| Джин             | 9 Пшеницы<br>Несколько синих цветов<br>Яблоко  | Коротко               | Да   | Нет                      | III    |    |
+| Текила           | Несколько кактусов                             | Долго                 | Да   | Долго<br>Береза          | III    |    |
+| Абсент           | Много травы                                    | Коротко               | Да   | Нет                      | IIIII' | -  |
+| Зеленый Абсент   | Много травы<br>Другие зеленые штуки            | Нормально             | Да   | Нет                      | IIIIII | +- |
+| Картофельный суп | 5 Картошки<br>Немного травы                    | Коротко               | Нет  | Нет                      |        | +  |
+| Кофе             | Много какао бобов<br>2 Ведра молока            | Коротко               | Нет  | Нет                      |        | ++ |
+| Эгг-ног          | 5 Яиц<br>Немного сахара<br>1 Ведро молока      | Коротко               | Нет  | Коротко<br>Любое         | I'     |    |
diff --git a/docs/ru/guide/edit_config.md b/docs/ru/guide/edit_config.md
@@ -1,10 +1,39 @@
+---
+description: Настройка конфига плагина BreweryX
+---
 
 # Настройка конфига
 
 В конфиге Brewery<span class="neon">X</span> есть много своих приколюх, которые мы сейчас разберём.
 
 ***
 
+## Хранение данных: `storage`
+
+Как хранить все данные BreweryX - напитки, котлы, опьянения и прочее.
+
+`type` - тип хранения, может быть:
+
+- `FlatFile` - как и в оригинальном Brewery, простой `.yml` файлик
+
+- `SQLite` - лёгкая база данных SQLite в виде файла
+
+- `MySQL` - большая база данных
+
+Если выбран `MySQL`, то можно ввести данные твоей базы данных:
+
+- `database` - название базы данных
+
+- `tablePrefix` - префикс названий
+
+- `address` - домен базы данных
+
+- `username` - логин базы данных
+
+- `password` - пароль от логина
+
+***
+
 ## Язык: `language`
 
 Язык сообщений BreweryX. Может быть любым из папки `BreweryX/languages/`.
@@ -69,6 +98,10 @@
 
 Дефолтное значение: pukeItem: [Soul_Sand]
 
+Пример: `pukeItem: [Soul_Sand, Slime_block, Dirt]`
+
+Игроки не могут подбирать данные предметы.
+
 ***
 
 ## Время исчезания блевотни: `pukeDespawnTime`
@@ -181,6 +214,14 @@ drainItems:
 
 ***
 
+## Сколько длится виртуальный год: `agingYearDuration`
+
+Сколько внутриигровый дней считаются за год для напитков
+
+Дефолтное значение: 20
+
+***
+
 ## Кодировка напитков: `enableEncode`
 
 Эта настройка (если в `true`) позволяет закодировать компоненты (NBT) напитка, чтобы читеры не смогли узнать что это за напиток, кто его сварил и какой у него точный рецепт.
@@ -191,13 +232,15 @@ drainItems:
 
 ## Тип кодировки: `encodeKey`
 
-Надо узнать у разработчика...
+Число по аналогии с сидом, нужно для `enableEncode`.
+
+Чтобы использовать одинаковые напитки на связках серверов (через BungeeCord или Velocity), на всех серверах должен быть один `encodeKey`.
 
 ***
 
 ## Проверка обновлений: `updateCheck`
 
-Проверять ли на обновление BreweryX
+Проверять ли на наличие обновлений для BreweryX
 
 ***