Skip to content

Commit a83f405

Browse files
committed
Refactored spacing
1 parent a1bc00f commit a83f405

File tree

4 files changed

+24
-24
lines changed

4 files changed

+24
-24
lines changed

common/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,12 @@ therefore it is suggested to **not use it**.
1212
| [Serializer](#serializer) |
1313
| [Bukkit](#bukkit) |
1414

15-
1615
## How to import
17-
It can be imported using both **Maven** and **Gradle** and specifying **one of its submodules**.
1816

17+
It can be imported using both **Maven** and **Gradle** and specifying **one of its submodules**.
1918

2019
### Maven
20+
2121
First introduce the **Fulminazzo repository**, from where the artifacts will be downloaded.
2222
```xml
2323
<repository>
@@ -46,8 +46,8 @@ To import **all three submodules together**, use:
4646
</dependency>
4747
```
4848

49-
5049
### Gradle
50+
5151
First introduce the **Fulminazzo repository**, from where the artifacts will be downloaded.
5252
```groovy
5353
repositories {
@@ -71,18 +71,18 @@ dependencies {
7171
}
7272
```
7373

74-
7574
## Submodules
7675

7776
### Base
77+
7878
The `base` submodule contains various **special data structures** and **utility classes**
7979
for **enums**, **objects** and more.
8080

81-
8281
### Serializer
82+
8383
The `serializer` submodule olds few **important classes** for successfully **serializing** and **deserializing**
8484
**YAGL data**.
8585

86-
8786
### Bukkit
87+
8888
At the time of writing, the `bukkit` module does nothing.

gui/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,12 @@ in a **simple yet convenient way** for both **developers and admins**.
1919
| [Serializer](#serializer) |
2020
| [Bukkit](#bukkit) |
2121

22-
2322
## How to import
24-
It can be imported using both **Maven** and **Gradle** and specifying **one of its submodules**.
2523

24+
It can be imported using both **Maven** and **Gradle** and specifying **one of its submodules**.
2625

2726
### Maven
27+
2828
First introduce the **Fulminazzo repository**, from where the artifacts will be downloaded.
2929
```xml
3030
<repository>
@@ -53,8 +53,8 @@ To import **all three submodules together**, use:
5353
</dependency>
5454
```
5555

56-
5756
### Gradle
57+
5858
First introduce the **Fulminazzo repository**, from where the artifacts will be downloaded.
5959
```groovy
6060
repositories {
@@ -78,27 +78,27 @@ dependencies {
7878
}
7979
```
8080

81-
8281
## Submodules
8382

8483
### Base
84+
8585
The `base` submodules introduces all the **components and features** of the module.
8686
It provides all the [types of GUIs](https://github.com/Fulminazzo/YAGL/wiki/GUI-For-Developers#types)
8787
with their associated classes, all the [GUI contents](https://github.com/Fulminazzo/YAGL/wiki/GUI-Contents-For-Developers)
8888
as well as different types of [actions](https://github.com/Fulminazzo/YAGL/wiki/GUI-For-Developers#actions).
8989
All of these and more can be found in the
9090
[detailed documentation in the Wiki](https://github.com/Fulminazzo/YAGL/wiki/GUI-For-Developers).
9191

92-
9392
### Serializer
93+
9494
The `serializer` submodule is entitled to **saving and loading** all the **guis related objects**.
9595
A developer **should not be concerned** with the **contents** of this module as it should **never be used explicitly**.
9696
However, for it to work properly, it is required to execute `GUIYAGLParser#addAllParsers()` **before any serialization operation**.
9797
Note that this **will include calls to `WrappersYAGLParser#addAllParsers()` and `ItemYAGLParser#addAllParsers()`**,
9898
therefore it is **not necessary** to include them later.
9999

100-
101100
### Bukkit
101+
102102
The `bukkit` module contains **Bukkit** related objects and converters.
103103
It provides two main classes:
104104
- [GUIManager](bukkit/src/main/java/it/fulminazzo/yagl/GUIManager.java),

item/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,12 @@ who will encounter no issue into **modifying and customizing it** to fit their n
3030
| [Serializer](#serializer) |
3131
| [Bukkit](#bukkit) |
3232

33-
3433
## How to import
35-
It can be imported using both **Maven** and **Gradle** and specifying **one of its submodules**.
3634

35+
It can be imported using both **Maven** and **Gradle** and specifying **one of its submodules**.
3736

3837
### Maven
38+
3939
First introduce the **Fulminazzo repository**, from where the artifacts will be downloaded.
4040
```xml
4141
<repository>
@@ -64,8 +64,8 @@ To import **all three submodules together**, use:
6464
</dependency>
6565
```
6666

67-
6867
### Gradle
68+
6969
First introduce the **Fulminazzo repository**, from where the artifacts will be downloaded.
7070
```groovy
7171
repositories {
@@ -89,24 +89,24 @@ dependencies {
8989
}
9090
```
9191

92-
9392
## Submodules
9493

9594
### Base
95+
9696
The `base` submodule contains many classes responsible for **creation and customization** of **items**,
9797
but the most important (and useful) ones are [Item](https://github.com/Fulminazzo/YAGL/wiki/Item-For-Developers#items)
9898
and [Recipes](https://github.com/Fulminazzo/YAGL/wiki/Item-For-Developers#recipes).
9999

100-
101100
### Serializer
101+
102102
The `serializer` submodule is entitled to **saving and loading** all the **items related objects**.
103103
A developer **should not be concerned** with the **contents** of this module as it should **never be used explicitly**.
104104
However, for it to work properly, it is required to execute `ItemYAGLParser#addAllParsers()` **before any serialization operation**.
105105
Note that this **will include calls to `WrappersYAGLParser#addAllParsers()`**,
106106
therefore it is **not necessary** to include it later.
107107

108-
109108
### Bukkit
109+
110110
`bukkit` allows the direct **conversion** from a **YAGL `Item`** to a **Bukkit `ItemStack`**.
111111
It does so thanks to
112112
[ItemAdapter](bukkit/src/main/java/it/fulminazzo/yagl/ItemAdapter.java) and

wrappers/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,12 @@ Not only that, but the coder can also **transfer with ease** any object across *
2121
| [Serializer](#serializer) |
2222
| [Bukkit](#bukkit) |
2323

24-
2524
## How to import
26-
It can be imported using both **Maven** and **Gradle** and specifying **one of its submodules**.
2725

26+
It can be imported using both **Maven** and **Gradle** and specifying **one of its submodules**.
2827

2928
### Maven
29+
3030
First introduce the **Fulminazzo repository**, from where the artifacts will be downloaded.
3131
```xml
3232
<repository>
@@ -55,8 +55,8 @@ To import **all three submodules together**, use:
5555
</dependency>
5656
```
5757

58-
5958
### Gradle
59+
6060
First introduce the **Fulminazzo repository**, from where the artifacts will be downloaded.
6161
```groovy
6262
repositories {
@@ -80,25 +80,25 @@ dependencies {
8080
}
8181
```
8282

83-
8483
## Submodules
8584

8685
### Base
86+
8787
`base` contains the **core** of the module.
8888
It holds the most important classes as
8989
[Enchantment](https://github.com/Fulminazzo/YAGL/wiki/Wrappers-For-Developers#enchantment),
9090
[PotionEffect](https://github.com/Fulminazzo/YAGL/wiki/Wrappers-For-Developers#potioneffect),
9191
[Sound](https://github.com/Fulminazzo/YAGL/wiki/Wrappers-For-Developers#sound) and
9292
[Particle](https://github.com/Fulminazzo/YAGL/wiki/Wrappers-For-Developers#particle).
9393

94-
9594
### Serializer
95+
9696
The `serializer` submodule is entitled to **saving and loading** all the **wrappers objects**.
9797
A developer **should not be concerned** with the **contents** of this module as it should **never be used explicitly**.
9898
However, for it to work properly, it is required to execute `WrappersYAGLParser#addAllParsers()` **before any serialization operation**.
9999

100-
101100
### Bukkit
101+
102102
The most useful class introduced by this module is
103103
[WrappersAdapter](bukkit/src/main/java/it/fulminazzo/yagl/WrappersAdapter.java),
104104
which allows a **one to one conversion** for any **Bukkit object** to a **YAGL one** or **viceversa**.

0 commit comments

Comments
 (0)