# API

## Getting Started

To get started you need to install our repository and dependencies to your project.\
You can simply copy and paste the maven & gradle configuration as follows:

### Maven

<pre class="language-xml"><code class="lang-xml">&#x3C;repositories>
  &#x3C;!-- playerpoof -->
<strong>  &#x3C;repository>
</strong>    &#x3C;id>playerpoof&#x3C;/id>
    &#x3C;url>https://maven.playerpoof.com/repository/maven-public/&#x3C;/url>
  &#x3C;/repository>
&#x3C;/repositories
</code></pre>

```xml
<dependencies>
  <!-- playerpoof bukkit api -->
  <dependency>
    <groupId>com.playerpoof</groupId>
    <artifactId>api-bukkit</artifactId>
    <version>1.1.1</version>
    <scope>provided</scope>
  </dependency>
</dependencies>
```

### Gradle

```
repositories {
                mavenLocal()
                maven("https://maven.playerpoof.com/repository/maven-public/")
            }
```

```
implementation("com.playerpoof:api-bukkit:1.1.1")
```

## Useful functions

Our api is not finished so at the moment you'll find all interesting functions in the `PlayerPoofAPI` class.

```java
PlayerPoofAPI.isFakePlayer(player); # org.bukkit.OfflinePlayer
PlayerPoofAPI.isFakePlayer(playerName); # String
PlayerPoofAPI.isFakePlayer(playerId); # UUID

```