ResourcesTeamStatusMaven

Installing Quark

How to install and use Quark in your project.

Quark provides a Gradle plugin that seamlessly integrates with your build script. To apply it:

plugins {
    id("java-library")
    id("com.gradleup.shadow") version "8.3.9"
    id("org.bxteam.quark") version "1.1.0"
}
plugins {
    id 'java-library'
    id 'com.gradleup.shadow' version '8.3.9'
    id 'org.bxteam.quark' version '1.1.0'
}

Then, add your dependencies using the quark configuration block:

dependencies {    
    // Add your runtime dependencies using quark configuration
    quark("com.google.code.gson:gson:2.10.1")
    
    // you can use the dependency notation and exclude modules as you
    // would with other configurations
    quark("com.google.inject:guice:7.0.0") {
        exclude("com.google.guava", "guava")
    }
}
dependencies {
    // Add your runtime dependencies using quark configuration
    quark "com.google.code.gson:gson:2.10.1"
    
    // you can use the dependency notation and exclude modules as you
    // would with other configurations
    quark("com.google.inject:guice:7.0.0") {
        exclude group: "com.google.guava", module: "guava"
    }
}

After adding your dependencies, you need to configure the Quark extension, by specifying the platform and other settings:

quark {
    // Specify the platform that will be used in your project (bukkit, paper, velocity or bungee)
    platform = "your-platform"

    // directory to download dependencies in
    libsFolder = "libraries"

    // repositories to fetch dependencies from
    // 
    // by default: includes maven central mirror
    repositories {
        // example repository
        maven("https://jitpack.io/")

        // optional: use all repositories declared in this
        // file if you don't want to re-include everything here
        includeProjectRepositories()
    }
  
    // relocate libraries here
    // com.google.code.gson --> org.bxteam.deps.gson
    relocate("com.google.code.gson", "org.bxteam.deps.gson")
}
quark {
    // Specify the platform that will be used in your project (bukkit, paper, velocity or bungee)
    platform = "your-platform"

    // directory to download dependencies in
    libsFolder = "libraries"

    // repositories to fetch dependencies from
    // 
    // by default: includes maven central mirror
    repositories {
        // example repository
        maven "https://jitpack.io/"

        // optional: use all repositories declared in this
        // file if you don't want to re-include everything here
        includeProjectRepositories()
    }
  
    // relocate libraries here
    // com.google.code.gson --> org.bxteam.deps.gson
    relocate "com.google.code.gson", "org.bxteam.deps.gson"
}

Then, in your plugin, use the library manager with Gradle integration:

public class YourPlugin extends JavaPlugin {
    private BukkitLibraryManager libraryManager; // Replace with your library manager (Paper, BungeeCord, Velocity)

    @Override
    public void onLoad() {
        libraryManager = new BukkitLibraryManager(this); // Replace with your library manager (Paper, BungeeCord, Velocity)
        libraryManager.loadFromGradle();
    }

    @Override
    public void onDisable() {
        if (libraryManager != null) {
            libraryManager.close();
        }
    }
}

Finally, build with shadowJar:

./gradlew shadowJar

Classic Way

If you don't want to use the Gradle plugin, you can still use Quark by manually adding the dependencies to your project.

Adding Dependencies

To use Quark you need to add BX Team Repository to your repositories and Quark to your dependencies in your project.

Depending on the build system you are using, add the following code to your project:

Repository Configuration

maven("https://repo.bxteam.org/releases")
maven { url "https://repo.bxteam.org/releases" }
<repository>
    <id>bx-team-releases</id>
    <name>BX Team Maven repository</name>
    <url>https://repo.bxteam.org/releases</url>
</repository>

Dependency Configuration

dependencies {
    implementation("org.bxteam.quark:{platform}:1.1.0")
}
dependencies {
    implementation "org.bxteam.quark:{platform}:1.1.0"
}
<dependency>
    <groupId>org.bxteam.quark</groupId>
    <artifactId>{platform}</artifactId>
    <version>1.1.0</version>
</dependency>

Replacing {platform}

Replace {platform} with the platform you want to use (See platforms).

Library Manager Setup

Quark provides platform-specific library managers that handle dependency loading for different Minecraft server platforms. Each platform has its own manager class that you'll need to initialize in your plugin.

public class BukkitTestPlugin extends JavaPlugin {
    private BukkitLibraryManager libraryManager;

    @Override
    public void onLoad() {
        libraryManager = new BukkitLibraryManager(this);
        libraryManager.addGoogleMavenCentralMirror();

        libraryManager.loadDependency("com.google.code.gson", "gson", "2.10.1");
    }

    @Override
    public void onDisable() {
        if (libraryManager != null) {
            libraryManager.close();
        }
    }
}
public class PaperTestPlugin extends JavaPlugin {
    private PaperLibraryManager libraryManager;

    @Override
    public void onLoad() {
        libraryManager = new PaperLibraryManager(this);
        libraryManager.addGoogleMavenCentralMirror();

        libraryManager.loadDependency("com.google.code.gson", "gson", "2.10.1");
    }

    @Override
    public void onDisable() {
        if (libraryManager != null) {
            libraryManager.close();
        }
    }
}
public class BungeeTestPlugin extends Plugin {
    private BungeeLibraryManager libraryManager;

    @Override
    public void onLoad() {
        libraryManager = new BungeeLibraryManager(this);
        libraryManager.addGoogleMavenCentralMirror();

        libraryManager.loadDependency("com.google.code.gson", "gson", "2.10.1");
    }

    @Override
    public void onDisable() {
        if (libraryManager != null) {
            libraryManager.close();
        }
    }
}
@Plugin(id = "velocity-test-plugin", name = "Velocity Test Plugin", version = "1.0.0")
public class VelocityTestPlugin {
    private final ProxyServer server;
    private final Logger logger;
    private final Path dataDirectory;
    private final PluginManager pluginManager;

    private VelocityLibraryManager<VelocityTestPlugin> libraryManager;

    @Inject
    public VelocityTestPlugin(ProxyServer server, Logger logger, @DataDirectory Path dataDirectory, PluginManager pluginManager) {
        this.server = server;
        this.logger = logger;
        this.dataDirectory = dataDirectory;
        this.pluginManager = pluginManager;
    }

    @Subscribe
    public void onProxyInitialization(ProxyInitializeEvent event) {
        libraryManager = new VelocityLibraryManager<>(this, logger, dataDirectory, pluginManager);
        libraryManager.addGoogleMavenCentralMirror();

        libraryManager.loadDependency("com.google.code.gson", "gson", "2.10.1");
    }

    @Subscribe
    public void onProxyShutdown(ProxyShutdownEvent event) {
        if (libraryManager != null) {
            libraryManager.close();
        }
    }
}

Next Steps

If you want to learn more, you can read next pages with advanced usage instructions.

Dependency Management

Load and manage Maven dependencies at runtime with Quark.

Package Relocation

Use package relocation to avoid namespace conflicts between libraries.

Repository Configuration

Configure Maven repositories for dependency resolution in Quark.

Isolated Class Loaders

Use isolated class loaders to prevent dependency conflicts.

Edit on GitHub

Last updated on

Examples

Here you can find examples using Quark in different platforms.

Advanced Usage

Advanced features and configuration options for Quark.

On this page

With Gradle plugin (recommended)
Classic Way
Adding Dependencies
Repository Configuration
Dependency Configuration
Library Manager Setup
Next Steps