Skip to content

Getting Started

Installation as a dependency

Add the sofycore-api artifact to a Maven or Gradle project with provided scope so it is never shaded into your plugin.

The API artifact is net.sofycore:sofycore-api. Use provided (Maven) or compileOnly (Gradle) scope: the classes are supplied at runtime by the installed sofyCore plugin and must never be shaded into your JAR.

You can request the sofycore-api JAR on our Discord. Install it into your local Maven repository and add it to your project:

Bash
mvn install:install-file -Dfile=sofycore-api.jar -DgroupId=net.sofycore -DartifactId=sofycore-api -Dversion=0.1.0-SNAPSHOT -Dpackaging=jar
MavenXML
<dependencies>
  <dependency>
    <groupId>net.sofycore</groupId>
    <artifactId>sofycore-api</artifactId>
    <version>0.1.0-SNAPSHOT</version>
    <scope>provided</scope>
  </dependency>
</dependencies>