diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 00000000..22eea739 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,3 @@ +{ + "editor.wordBasedSuggestions": "off" +} \ No newline at end of file diff --git a/docs/en/api/api.md b/docs/en/api/api.md index 74964ea9..620b4f77 100644 --- 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 com.github.Jsinco BreweryX - 3.2.5 + 3.3.3 provided ``` @@ -27,6 +27,6 @@ repositories { } dependencies { - implementation 'com.github.Jsinco:BreweryX:3.2.5' + implementation 'com.github.Jsinco:BreweryX:3.3.3' } ``` \ No newline at end of file diff --git a/docs/en/guide/brewing_guide.md b/docs/en/guide/brewing_guide.md index d9c0cc38..d372a54d 100644 --- 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 index 95972752..fc6bf6d1 100644 --- 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 index cda76e99..11d6d291 100644 --- 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 index 973eb76c..7e78221b 100644 --- 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 BreweryX 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 index 4517250a..b9ed446a 100644 --- 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 index 697c2a90..d0f0def5 100644 --- a/docs/en/index.md +++ b/docs/en/index.md @@ -60,7 +60,7 @@ Our awesome team!
![Jsinco](https://avatars.githubusercontent.com/u/67713846?v=4){ align=right width="150" } -
**Jsinco** Lead Developer
+
**Jsinco** - Lead Developer
@@ -71,35 +71,35 @@ Our awesome team!
![Mitality](https://avatars.githubusercontent.com/u/96748385?v=4){ width="150" } -
**Mitality** Developer
+
**Mitality** - Developer
-- +-
- ![TTTheKing](https://avatars.githubusercontent.com/u/2845957?v=4){ width="150" } -
**TTTheKing** Original Author
+ ![Szarkan](https://avatars.githubusercontent.com/u/150809885?v=4){ width="150" } +
**szarkan** - I made this wiki!
-
- ![Sn0wStorm](https://avatars.githubusercontent.com/u/4077108?v=4){ width="150" } -
**Sn0wStorm** Original Author
+ ![TTTheKing](https://avatars.githubusercontent.com/u/2845957?v=4){ width="150" } +
**TTTheKing** - Original Author
-
- ![Grafe](https://avatars.githubusercontent.com/u/2846040?v=4){ width="150" } -
**Grafe** Original Author
+ ![Sn0wStorm](https://avatars.githubusercontent.com/u/4077108?v=4){ width="150" } +
**Sn0wStorm** - Original Author
-- +-
- ![Szarkan](https://avatars.githubusercontent.com/u/150809885?v=4){ width="150" } -
**szarkan** I made this wiki!
+ ![Grafe](https://avatars.githubusercontent.com/u/2846040?v=4){ width="150" } +
**Grafe** - Original Author
- diff --git a/docs/ru/api/api.md b/docs/ru/api/api.md index 34d7e19b..a4365cdc 100644 --- a/docs/ru/api/api.md +++ b/docs/ru/api/api.md @@ -14,7 +14,7 @@ com.github.Jsinco BreweryX - 3.2.5 + 3.3.3 provided ``` @@ -27,6 +27,6 @@ repositories { } dependencies { - implementation 'com.github.Jsinco:BreweryX:3.2.5' + implementation 'com.github.Jsinco:BreweryX:3.3.3' } ``` \ No newline at end of file diff --git a/docs/ru/guide/brewing_guide.md b/docs/ru/guide/brewing_guide.md index d1977f29..57506522 100644 --- 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 index 36849283..4d7bc526 100644 --- 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 index afcf4e98..5c4a3bb4 100644 --- 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 new file mode 100644 index 00000000..a6c8c35f --- /dev/null +++ b/docs/ru/guide/default_recipes.md @@ -0,0 +1,26 @@ + +# Рецепты из коробки + +BreweryX предлагает начальные рецепты - они уже добавлены в `config.yml`. + +| Рецепт | Инградиенты | Время кипения | Дистилляция | Выдержка/Дерево | Уровень алкоголя | Эффекты | +|-------------|-------------|-----|-----|-------|-----|---| +| Пиво | 6 Пшеницы | 8 Минут | Нет | 3 Года
Любое | I | | +| Пшеничное пиво | 3 Пшеницы | 8 Минут | Нет | 2 Года
Береза | I | | +| Темное пиво | 6 Пшеницы | 8 Минут | Нет | В 3 раза дольше чем пиво
Темный дуб| I' | | +| Красное вино | 5 Сладких ягод | 5 Минут | Нет | Коротко
Any | I' | | +| Медовуха | 6 Сахарный тростник | 3 Минуты | Нет | 4 Года
Дуб | I' | | +| Яблочный Мид | 6 Сахарный тростник
Яблоко | Одникаово с медовухой | Нет | 4 Года
Дуб | II | + | +| Яблочный Сидр | Много яблок | 7/8 Минут | Нет | 3 Года
Любое | I' | | +| Яблочный Ликер | Много яблок | Долго | Да | 6 Лет
Акация | II' | | +| Виски | Пшеница | 1 мин./Пшеница | Да | Очень долго
Темное | III' | | +| Ром | Куча сахарного тростника | Коротко | Да | Долго
Дуб | IIII | + | +| Водка | Одна шестая стака картошки | Долго | Да | Нет | III | - | +| Грибная водка | Картошка, Грибы | Очень долго | Да | Нет | II' | +- | +| Джин | 9 Пшеницы
Несколько синих цветов
Яблоко | Коротко | Да | Нет | III | | +| Текила | Несколько кактусов | Долго | Да | Долго
Береза | III | | +| Абсент | Много травы | Коротко | Да | Нет | IIIII' | - | +| Зеленый Абсент | Много травы
Другие зеленые штуки | Нормально | Да | Нет | IIIIII | +- | +| Картофельный суп | 5 Картошки
Немного травы | Коротко | Нет | Нет | | + | +| Кофе | Много какао бобов
2 Ведра молока | Коротко | Нет | Нет | | ++ | +| Эгг-ног | 5 Яиц
Немного сахара
1 Ведро молока | Коротко | Нет | Коротко
Любое | I' | | diff --git a/docs/ru/guide/edit_config.md b/docs/ru/guide/edit_config.md index 6221b240..0b80145b 100644 --- a/docs/ru/guide/edit_config.md +++ b/docs/ru/guide/edit_config.md @@ -1,3 +1,6 @@ +--- +description: Настройка конфига плагина BreweryX +--- # Настройка конфига @@ -5,6 +8,32 @@ *** +## Хранение данных: `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 *** diff --git a/docs/ru/guide/recipies.md b/docs/ru/guide/recipies.md index 9a2d99a2..2f816057 100644 --- a/docs/ru/guide/recipies.md +++ b/docs/ru/guide/recipies.md @@ -1,32 +1,37 @@ +--- +description: Создание рецептов в BreweryX +--- + # Создание нового рецепта -Создание новых рецептов в BreweryX довольно лёгкое. Достаточно заполнить следующие параметры: +Создание новых рецептов в BreweryX довольно лёгкое. Достаточно создать напиток с этими параметрами: *** ## Название напитка: `name` -| Обязательно? | Значение | Дефолтное значение | +| Обязательно? | Значение | Значение по-умолчанию | | --------- | ----- | ------------- | |Да|`Плохое Название/Название/Хорошее название`|Нет| -Название напитка. Может отличаться в зависимости от качества напитка, если установлено вот так: +Название напитка. Может отличаться в зависимости от качества напитка. ```yaml ТестовыйНапиток: name: Плохой напиток/Напиток/Хороший напиток ``` -Названия напитков поддерживают цветовые коды и HEX цвета: +Названия напитков поддерживают цветовые коды и HEX цвета в формате `&#`: ```yaml Разноцветный напиток: name: '&8Плохой напиток/Напиток/&#ffb424Хороший напиток' ``` -Что удивительно - как название так и ID напитка поддерживает русский язык! -Если не хочешь делать вариации названия - поставь одно название +Если не хочешь делать вариации названия - поставь одно название. + +Что удивительно - как название так и ID напитка поддерживает русский язык! ```yaml ТестовыйНапиток: @@ -37,7 +42,7 @@ ## Ингредиенты: `ingredients` -| Обязательно? | Значение | Дефолтное значение | +| Обязательно? | Значение | Значение по-умолчанию | | --------- | ----- | ------------- | |Да|`- НазваниеПредмета/Количество`|Нет| @@ -49,7 +54,7 @@ - Название кастомного предмета BreweryX -- ID предмета из Itemsadder (без namespace) +- ID предмета из ItemsAdder (без namespace) - ID предмета из Oraxen @@ -72,7 +77,7 @@ ## Время варки: `cookingtime` -| Обязательно? | Значение | Дефолтное значение | +| Обязательно? | Значение | Значение по-умолчанию | | --------- | ----- | ------------- | |Да|Число|Нет| @@ -88,7 +93,7 @@ ## Сколько раз дистиллировать: `distillruns` -| Обязательно? | Значение | Дефолтное значение | +| Обязательно? | Значение | Значение по-умолчанию | | --------- | ----- | ------------- | |Нет, если нет `distillruns`|Число|0| @@ -104,7 +109,7 @@ How much times player need to distill brew ## Время дистилляции: `distilltime` -| Обязательно? | Значение | Дефолтное значение | +| Обязательно? | Значение | Значение по-умолчанию | | --------- | ----- | ------------- | |Нет|Время в секундах|0| @@ -120,7 +125,7 @@ How much times player need to distill brew ## Тип дерева бочки: `wood` -| Обязательно? | Значение | Дефолтное значение | +| Обязательно? | Значение | Значение по-умолчанию | | --------- | ----- | ------------- | |Нет|Цифра типа дерева|Нет| @@ -160,11 +165,11 @@ How much times player need to distill brew ## Время брожения: `age` -| Обязательно? | Значение | Дефолтное значение | +| Обязательно? | Значение | Значение по-умолчанию | | --------- | ----- | ------------- | -|Нет|Число в игровых днях|0| +|Нет|Число - внутриигровые дни|0| -Сколько внутриигровых дней напитку нужно побродить для идеального качества. +Сколько нужно побродить напитку внутриигровых дней для идеального качества. ```yaml ТестовыйНапиток: @@ -176,7 +181,7 @@ How much times player need to distill brew ## Цвет напитка: `color` -| Обязательно? | Значение | Дефолтное значение | +| Обязательно? | Значение | Значение по-умолчанию | | --------- | ----- | ------------- | |Нет|HEX цвет или название цвета|`WHITE`| @@ -194,7 +199,7 @@ How much times player need to distill brew ## Сложность напитка: `difficulty` -| Обязательно? | Значение | Дефолтное значение | +| Обязательно? | Значение | Значение по-умолчанию | | --------- | ----- | ------------- | |Да|Число `1` - `10`|Нет| @@ -212,7 +217,7 @@ How much times player need to distill brew ## Уровень алкоголя: `alcohol` -| Обязательно? | Значение | Дефолтное значение | +| Обязательно? | Значение | Значение по-умолчанию | | --------- | ----- | ------------- | |Нет|Число `0` - `100`|`0`| @@ -228,7 +233,7 @@ How much times player need to distill brew ## Описание напитка: `lore` -| Обязательно? | Значение | Дефолтное значение | +| Обязательно? | Значение | Значение по-умолчанию | | --------- | ----- | ------------- | |Нет|Список|Нет| @@ -248,7 +253,7 @@ How much times player need to distill brew ## Серверные команды: `servercommands` -| Обязательно? | Значение | Дефолтное значение | +| Обязательно? | Значение | Значение по-умолчанию | | --------- | ----- | ------------- | |Нет|Список|Нет| @@ -271,7 +276,7 @@ How much times player need to distill brew ## Команды игрока: `playercommands` -| Обязательно? | Значение | Дефолтное значение | +| Обязательно? | Значение | Значение по-умолчанию | | --------- | ----- | ------------- | |Нет|Список|Нет| @@ -294,7 +299,7 @@ How much times player need to distill brew ## Сообщение при выпивании: `drinkmessage` -| Обязательно? | Значение | Дефолтное значение | +| Обязательно? | Значение | Значение по-умолчанию | | --------- | ----- | ------------- | |Нет|Строка|Нет| @@ -310,7 +315,7 @@ How much times player need to distill brew ## Title после выпивания: `drinktitle` -| Обязательно? | Значение | Дефолтное значение | +| Обязательно? | Значение | Значение по-умолчанию | | --------- | ----- | ------------- | |Нет|Строка|Нет| @@ -326,7 +331,7 @@ How much times player need to distill brew ## Эффект зачарования: `glint` -| Обязательно? | Значение | Дефолтное значение | +| Обязательно? | Значение | Значение по-умолчанию | | --------- | ----- | ------------- | |Нет|Булевое значение `true` или `false`|Нет| @@ -342,7 +347,7 @@ How much times player need to distill brew ## CMD предмета: `customModelData` -| Обязательно? | Значение | Дефолтное значение | +| Обязательно? | Значение | Значение по-умолчанию | | --------- | ----- | ------------- | |Нет|`Плохое CMD/CMD/Хорошее CMD`|Нет| @@ -358,7 +363,7 @@ Custom model data напитка. Может варьироваться в за ## Эффекты: `effects` -| Обязательно? | Значение | Дефолтное значение | +| Обязательно? | Значение | Значение по-умолчанию | | --------- | ----- | ------------- | |Нет|`НАЗВАНИЕ_ЭФФЕКТА/УРОВЕНЬ/ПРОДОЛЖИТЕЛЬНОСТЬ`|Нет| diff --git a/docs/ru/index.md b/docs/ru/index.md index c453ec93..af282d6c 100644 --- a/docs/ru/index.md +++ b/docs/ru/index.md @@ -8,6 +8,7 @@ hide: - feedback - actions icon: fontawesome/solid/house +description: Лучший плагин на варку алкоголя ---

@@ -70,6 +71,13 @@ BreweryX это поддерживаемый, активно разрабаты
**Mitality** - разработчик
+- + +
+ ![Szarkan](https://avatars.githubusercontent.com/u/150809885?v=4){ width="150" } +
**szarkan** - я написал эту Вики!
+
+ -
@@ -91,13 +99,6 @@ BreweryX это поддерживаемый, активно разрабаты
**Grafe** - автор оригинального Brewery
-- - -
- ![Szarkan](https://avatars.githubusercontent.com/u/150809885?v=4){ width="150" } -
**szarkan** - я написал эту Вики!
-
- -
diff --git a/mkdocs.yml b/mkdocs.yml index 5a404b3c..2cc80213 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -82,6 +82,10 @@ plugins: default: false name: Русский build: true + nav_translations: + Documentation: Документация + Config: Конфигурации + Other: Прочее extra: # alternate: # - name: English diff --git a/overrides/main.html b/overrides/main.html new file mode 100644 index 00000000..569c2443 --- /dev/null +++ b/overrides/main.html @@ -0,0 +1,32 @@ +{% extends "base.html" %} + +{% block extrahead %} +{% if page %} + {% if page.meta.title %} + + + {% else %} + + + + {% endif %} + {% if page.meta.description %} + + {% endif %} + + + + + + + + +{% else %} + + + + +{% endif %} +{% endblock %}