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

# Setup

Step 1: **Add ProtectorAPI into your project**

**Latest Version:** ![](https://img.shields.io/maven-central/v/io.github.lijinhong11/protectorapi-api?label=%20)

**Javadoc:** <https://javadoc.io/doc/io.github.lijinhong11/protectorapi-api/latest/index.html>

Maven

```xml
<dependency>
  <groupId>io.github.lijinhong11</groupId>
  <artifactId>protectorapi-api</artifactId>
  <version>VERSION</version>
  <scope>provided</scope>
</dependency>
```

Gradle (Groovy DSL):

```gradle
implementation 'io.github.lijinhong11:protectorapi-api:VERSION'
```

Gradle (Kotlin DSL):

```kts
implementation("io.github.lijinhong11:protectorapi-api:VERSION")
```

**NOTE:** <mark style="color:red;">**Whatever you want, do not shade it into your artifact!**</mark>

Step 2: Enjoy :)