Usage - Dani-error/velar GitHub Wiki

Dependency

Gradle (Kotlin DSL)
repositories {
    mavenCentral()
}

dependencies {
    implementation("io.github.dani-error.velar:<module>:1.1.0")
}

Replace <module> with one of the modules listed below.

Maven
<dependency>
  <groupId>io.github.dani-error.velar</groupId>
  <artifactId>MODULE</artifactId>
  <version>1.1.0</version>
</dependency>

Replace MODULE with one of the modules listed below.

Gradle (Groovy DSL)
repositories {
    mavenCentral()
}

dependencies {
    implementation 'io.github.dani-error.velar:<module>:1.1.0'
}

Replace <module> with one of the modules listed below.


Additional Repositories

You may need to add the following if you rely on transitive dependencies:

  • https://repo.papermc.io/repository/maven-public/ (PaperLib)
  • https://repository.derklaro.dev/releases/ (ProtocolLib via Derklaro’s repo; can also use JitPack)
  • https://repo.codemc.io/repository/maven-releases/ (PacketEvents)
  • https://s01.oss.sonatype.org/content/repositories/snapshots/ (for snapshot-only dependencies)

You should shade some dependencies to avoid conflicts as shown here.


Modules

Module Name Artifact ID Description
API api Core Velar API (no platform-specific code).
Common common Abstract API implementations for building new platforms.
Bukkit bukkit Full Bukkit (and forks) implementation—includes API & Common.

All of them published in maven central.

Platform

Before creating your NPCs, you have to learn first what is and how to define your Platform.

⚠️ **GitHub.com Fallback** ⚠️