Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
acrylic-style committed Jan 2, 2023
1 parent 50a15fc commit a7b0f4f
Showing 1 changed file with 62 additions and 1 deletion.
63 changes: 62 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,67 @@ This plugin does not have any commands other than `/azipluginmessaging` in spigo
Required plugin(s):
- LuckPerms

## Using the API
## Developer API

### Dependency

Repository: `https://repo.azisaba.net/repository/maven-public/`

Group ID: `net.azisaba.azipluginmessaging`

Artifact ID: `api`

#### Maven

```xml
<repository>
<id>azisaba</id>
<url>https://repo.azisaba.net/repository/maven-public/</url>
</repository>
```

```xml
<dependency>
<groupId>net.azisaba.azipluginmessaging</groupId>
<artifactId>api</artifactId>
<version>[version]</version>
</dependency>
```

#### Gradle

```groovy
repositories {
maven {
name = 'azisaba'
url = 'https://repo.azisaba.net/repository/maven-public/'
}
}
```

```groovy
dependencies {
compileOnly 'net.azisaba.azipluginmessaging:api:[version]'
}
```

#### Gradle (Kotlin DSL)

```kotlin
repositories {
maven { url = uri("https://repo.azisaba.net/repository/maven-public/") }
}
```

```kotlin
dependencies {
compileOnly("net.azisaba.azipluginmessaging:api:[version]")
}
```

### Using the API

Don't know where to start? Check out the `net.azisaba.pluginmessaging.api.protocol.Protocol` for available packets!

See [this page](https://github.com/AzisabaNetwork/AziPluginMessaging/blob/50a15fc2884e0943ec4e2b6622ab4399c4ebc036/spigot/src/main/java/net/azisaba/azipluginmessaging/spigot/commands/ToggleNitroSaraCommand.java)
for an example of how to use the API.

0 comments on commit a7b0f4f

Please sign in to comment.