> For the complete documentation index, see [llms.txt](https://syrows-development.gitbook.io/staffmodlib/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://syrows-development.gitbook.io/staffmodlib/master.md).

# Welcome

### What is StaffModLib ?

**StaffModLib** is an amazing library which allows developers to create **staff mods** very easily in **Minecraft**. By using it, you can create **several** staff mods by writing a more **reusable** and **maintainable** code.

Want to use more than 9 items in your staff mod ? **StaffModLib** has the solution. The library provides to developers a **pagination system** very easy to use and which allows players to **navigate easily** between the different pages of items.

With **StaffModLib**, you can create **advanced staff mods** which can be fully **configured** in a **YAML** file. 

### How to use it ?

#### Without build tool

To use **StaffModLib**, you can download the **jar** on GitHub. When the download is finished, just add it as **dependency** into your project. Now, you're ready to use it !

#### With a build tool

You can also use build tools like **Maven** or **Gradle**.

{% tabs %}
{% tab title="Maven" %}

```markup
<repository>
    <id>jitpack.io</id>
    <url>https://jitpack.io</url>
</repository>

<dependency>
    <groupId>com.github.Syr0ws</groupId>
    <artifactId>StaffModLib</artifactId>
    <version>v1.2.0</version>
    <scope>compile</scope>
</dependency>
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Gradle" %}

```groovy
allprojects {
	repositories {
		...
		maven { url 'https://jitpack.io' }
	}
}
	
dependencies {
	implementation 'com.github.Syr0ws:StaffModLib:v1.2.0'
}
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
Do not forget to include the jar when compiling your project or else, classes will not be found.
{% endhint %}

### Useful links

* [GitHub](https://github.com/Syr0ws/StaffModLib)
* [Spigot](https://www.spigotmc.org/resources/staffmodlib.89180/)
* [Discord](https://discord.gg/sPUSHb2xDK)