Skip to content

Commit

Permalink
Merge pull request #49 from Nadwey/master
Browse files Browse the repository at this point in the history
Some documentation improvements
  • Loading branch information
szarkans authored Nov 5, 2024
2 parents cdfa703 + 6e153db commit b269334
Show file tree
Hide file tree
Showing 8 changed files with 102 additions and 28 deletions.
File renamed without changes
File renamed without changes
Binary file added docs/assets/brewing_guide/brewing.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/brewing_guide/distilling.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
57 changes: 47 additions & 10 deletions docs/en/api/api.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

# API

For Java developers, use any release jar locally or get any release from [Jitpack](https://jitpack.io/#Jsinco/BreweryX)
For Java developers, use any release jar locally or preferably, use JitPack:

## Maven

Expand All @@ -14,19 +14,56 @@ 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.3.3</version>
<version>VERSION</version>
<scope>provided</scope>
</dependency>
```

## Gradle

```groovy
repositories {
maven { url 'https://jitpack.io' }
}
=== "Gradle (Groovy)"

dependencies {
implementation 'com.github.Jsinco:BreweryX:3.3.3'
}
```
``` groovy
repositories {
maven { url 'https://jitpack.io' }
}

dependencies {
implementation 'com.github.Jsinco:BreweryX:VERSION'
}
```

=== "Gradle (KTS)"

``` kotlin
repositories {
maven("https://jitpack.io")
}

dependencies {
implementation("com.github.Jsinco:BreweryX:VERSION")
}
```

!!! warning

Don't forget to replace `VERSION` with a version [available on JitPack](https://jitpack.io/#Jsinco/BreweryX#releasesLink).

You also need to add a dependency in the `plugin.yml` or `paper-plugin.yml` file. This ensures BreweryX loads before your plugin.

=== "plugin.yml"

``` yaml
depend: [BreweryX]
```

=== "paper-plugin.yml"

``` yaml
dependencies:
server:
BreweryX:
load: BEFORE
required: true
join-classpath: true
```
10 changes: 5 additions & 5 deletions docs/en/guide/brewing_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ Step one consists of Fermenting the fresh Ingredients.

6. ???

7. You're awesome!
7. Profit

![Fermetting](https://camo.githubusercontent.com/c5cb7d3fe6ada1cd5fb1bec17d35774ed16ddee4bb39fbc473ef7b062bf34119/687474703a2f2f692e696d6775722e636f6d2f3144636c6e31392e706e67)
![Fermetting](../../assets/brewing_guide/brewing.png)

## Distilling

Expand All @@ -43,16 +43,16 @@ Some recipes need distilling and it's very easy process!

4. ???

5. You're awesome!
5. Profit

![Distilling](https://camo.githubusercontent.com/ade33c5b2f1ebf5d7d8d9167cd51e10e7d5edead8f2cd1b7b48a70b8b21941a5/687474703a2f2f692e696d6775722e636f6d2f524a4b563958732e706e67)
![Distilling](../../assets/brewing_guide/distilling.png)

## Aging

Most of drinks need **to age** from base potion to drink or to get better quality. Aging is just... waiting!

For that you need a **Barrel**. You can use default Minecraft barrel as **Oak barrel** that can contain up to 6 drinks or build multiblock structure if drink has to age in different type of wood. Structure barrels also can store more brews than default barrel!

![Barrels used in BreweryX](../../assets/barrels.png)
![Barrels used in BreweryX](../../assets/brewing_guide/barrels.png)

After you put your drinks in barrels, you need to just wait! 1 "year" is equals 1 in-game day. If you overdo the drink or use the wrong type of wood, the drink is likely to spoil.
57 changes: 47 additions & 10 deletions docs/ru/api/api.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

# API

Для Java разработчиков - используйте любые релизы локально или получайте их в [Jitpack](https://jitpack.io/#Jsinco/BreweryX)
Для Java-разработчиков: используйте любой выпущенный JAR-файл локально или, что предпочтительнее, используйте JitPack:

## Maven

Expand All @@ -14,19 +14,56 @@
<dependency>
<groupId>com.github.Jsinco</groupId>
<artifactId>BreweryX</artifactId>
<version>3.3.3</version>
<version>VERSION</version>
<scope>provided</scope>
</dependency>
```

## Gradle

```groovy
repositories {
maven { url 'https://jitpack.io' }
}
=== "Gradle (Groovy)"

dependencies {
implementation 'com.github.Jsinco:BreweryX:3.3.3'
}
```
``` groovy
repositories {
maven { url 'https://jitpack.io' }
}

dependencies {
implementation 'com.github.Jsinco:BreweryX:VERSION'
}
```

=== "Gradle (KTS)"

``` kotlin
repositories {
maven("https://jitpack.io")
}

dependencies {
implementation("com.github.Jsinco:BreweryX:VERSION")
}
```

!!! warning

Не забудьте заменить VERSION на версию [доступную на JitPack](https://jitpack.io/#Jsinco/BreweryX#releasesLink).

Вам также нужно добавить зависимость в файл `plugin.yml` или `paper-plugin.yml`. Это гарантирует, что BreweryX загрузится перед вашим плагином.

=== "plugin.yml"

``` yaml
depend: [BreweryX]
```

=== "paper-plugin.yml"

``` yaml
dependencies:
server:
BreweryX:
load: BEFORE
required: true
join-classpath: true
```
6 changes: 3 additions & 3 deletions docs/ru/guide/brewing_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ description: Гайд по созданию напитков в BreweryX

7. ПРОФИТ!

![Fermetting](https://camo.githubusercontent.com/c5cb7d3fe6ada1cd5fb1bec17d35774ed16ddee4bb39fbc473ef7b062bf34119/687474703a2f2f692e696d6775722e636f6d2f3144636c6e31392e706e67)
![Fermetting](../../assets/brewing_guide/brewing.png)

## Дистилляция

Expand All @@ -42,14 +42,14 @@ description: Гайд по созданию напитков в BreweryX

5. ПРОФИТ!

![Distilling](https://camo.githubusercontent.com/ade33c5b2f1ebf5d7d8d9167cd51e10e7d5edead8f2cd1b7b48a70b8b21941a5/687474703a2f2f692e696d6775722e636f6d2f524a4b563958732e706e67)
![Distilling](../../assets/brewing_guide/distilling.png)

## Брожение

Многим напиткам нужно **забродить** из браги в напиток или чтобы улучшить качество напитка. А брожжение это просто... ожидание!

Для этого тебе нужна **Бочка**. Ты можешь использовать обычную бочку из Майнкрафта, она будет работать как бочка **из дуба** и вмещает в себя 6 напитков. Но также ты можешь построить структуру - среднюю или большую бочку. Они нужны, если в рецепте необходимо определенное дерево или просто для увеличения слотов!

![Бочки в BreweryX](../../assets/barrels_ru.png)
![Бочки в BreweryX](../../assets/brewing_guide/barrels_ru.png)

После того, как ты положил напитки в бочки, тебе достаточно просто ждать! 1 "год" в BreweryX равняется 1 внутриигровому дню.

0 comments on commit b269334

Please sign in to comment.