Skip to content

installation.md

Latest commit

 

History

History
96 lines (72 loc) · 2.06 KB

installation.md

File metadata and controls

96 lines (72 loc) · 2.06 KB
Raw

Installation

Taffy4J requires Java 11 or newer. The stable release coordinate is com.antepod:taffy4j:0.13.0-2.

Gradle

repositories { mavenCentral() }

dependencies {
    implementation("com.antepod:taffy4j:0.13.0-2")
}

Maven

<dependency>
  <groupId>com.antepod</groupId>
  <artifactId>taffy4j</artifactId>
  <version>0.13.0-2</version>
</dependency>

The primary taffy4j JAR is universal and contains native libraries for all six supported OS/architecture pairs. Advanced consumers may instead use taffy4j-api, taffy4j-runtime, and one matching taffy4j-natives-<platform> artifact.

Current source snapshot

Until the stable coordinate is visible on Maven Central:

./gradlew publishToMavenLocal

Then use version 0.13.0-2-SNAPSHOT with mavenLocal(). This JAR contains the native library for the machine on which it was built.

repositories {
    mavenLocal()
    mavenCentral()
}

dependencies {
    implementation("com.antepod:taffy4j:0.13.0-2-SNAPSHOT")
}

JDK 24 and newer

Classpath applications should explicitly allow native access:

java --enable-native-access=ALL-UNNAMED ...

For Gradle's application plugin:

application {
    applicationDefaultJvmArgs = listOf("--enable-native-access=ALL-UNNAMED")
}

No java.library.path setting is needed. Taffy4J selects, verifies, extracts, and loads its own bundled library.

GitHub Packages

Stable releases are also available from this repository's GitHub Packages registry. GitHub requires authentication to download Maven packages. Use a personal access token (classic) with read:packages:

repositories {
    maven {
        url = uri("https://maven.pkg.github.com/antepodeum/Taffy4J")
        credentials {
            username = providers.gradleProperty("gpr.user").get()
            password = providers.gradleProperty("gpr.key").get()
        }
    }
}

Put the credentials in the user-level ~/.gradle/gradle.properties, not in the project repository:

gpr.user=YOUR_GITHUB_USERNAME
gpr.key=YOUR_TOKEN