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

# Getting Started

## Installation

**View here:**

{% embed url="<https://jitpack.io/#Manered/Utils/>" %}

After you add the repository to your Gradle/Maven project, you have to do the following:

1. With a JavaPlugin instance

{% code fullWidth="false" %}

```java
package dev.manere.example;

import dev.manere.utils.library.Utils;

public final class ExamplePlugin extends JavaPlugin {
    @Override
    public void onEnable() {
        Utils.init(this);
        
        /* You can now use the library below this Utils initialization */
        /* Let's register a random listener that doesn't of course exist */
        Registrar.events(new WhateverListenerYouHave());
    }
}
```

{% endcode %}

2. With a PluginWrapper instance from `dev.manere.utils.library.PluginWrapper`

```java
package dev.manere.example;

import dev.manere.utils.library.wrapper.PluginWrapper;

public class ExamplePlugin extends PluginWrapper {
    @Override
    protected void start() {
        // Do anything you want to do with the library.
        // Obviously the PluginWrapper automatically sets up your plugin
    }
}
```
