Getting Started

Wyck is a custom biome API for Paper servers without the use of datapacks. Our wrappers allow you to easily add new biomes to the game and send them to clients without touching any internals.

Compatibility

Wyck is compatible with Minecraft 1.21.11, 26.1.2, 26.2 and requires a Paper server running on Java 25 or later. Wyck is also compatible with Folia, but it is up to you to ensure that the rest of your plugin is compatible with Folia if you choose to support it.

Installation

Installation depends on your build system and whether you choose to use Wyck as a shaded dependency or external plugin dependency. This guide will assume you are using Gradle (Kotlin DSL) and will cover both shaded and external dependency methods.

The latest stable release is 2.4.2 and the latest snapshot is 3.0.0-b3ee334.

Plugin Loader Shaded External

Java Copy

package dev.wyck.example;

import io.papermc.paper.plugin.loader.PluginClasspathBuilder;
import io.papermc.paper.plugin.loader.PluginLoader;
import io.papermc.paper.plugin.loader.library.impl.MavenLibraryResolver;
import org.eclipse.aether.artifact.DefaultArtifact;
import org.eclipse.aether.graph.Dependency;
import org.eclipse.aether.repository.RemoteRepository;

public class ExampleLoader implements PluginLoader {
  @Override
  public void classloader(PluginClasspathBuilder classpathBuilder) {
      MavenLibraryResolver resolver = new MavenLibraryResolver();
      resolver.addDependency(new Dependency(new DefaultArtifact("dev.wyck:Wyck:2.4.2"), null));
      resolver.addRepository(new RemoteRepository.Builder("wyck", "default", "https://repo.wyck.dev/public/").build());
      classpathBuilder.addLibrary(resolver);
  }
}

plugins {
  id("com.gradleup.shadow") version "9.4.2"
}

repositories {
  maven("https://repo.wyck.dev/public/")
}

dependencies {
  implementation("dev.wyck:Wyck:2.4.2")
}

tasks {
  shadowJar {
      val pack = "dev.wyck.example"
      relocate("dev.wyck", "$pack.wyck")
      archiveClassifier.set("") // Remove the -all suffix
  }

  jar {
      enabled = false // Disable the default jar task
  }

  build {
      dependsOn(shadowJar) // Ensure the shadowJar task is run before the build
  }
}

repositories {
  maven("https://repo.wyck.dev/public/")
}

dependencies {
  compileOnly("dev.wyck:Wyck:2.4.2")
}

If you are using Wyck in a plugin loader or as an external dependency you will need to add Wyck as a plugin dependency in your plugin.yml, or paper-plugin.yml.

Bukkit Plugin Paper Plugin

YAML Copy

name: ExamplePlugin
main: dev.wyck.example.ExamplePlugin
version: 1.0-SNAPSHOT
api-version: 1.21
paper-plugin-loader: dev.wyck.example.ExampleLoader # Add this line if you're using Wyck as a plugin loader
depend: [Wyck] # Add this line if you're using Wyck as an external dependency

name: ExamplePlugin
main: dev.wyck.example.ExamplePlugin
bootstrapper: dev.wyck.example.ExampleBootstrapper
version: 1.0-SNAPSHOT
api-version: 1.21
loader: dev.wyck.example.ExampleLoader # Add this line if you're using Wyck as a plugin loader
# Add these lines if you're using Wyck as an external dependency:
dependencies:
  bootstrap:
    Wyck:
      load: BEFORE
      required: true
      join-classpath: true
  server:
    Wyck:
      load: BEFORE
      required: true
      join-classpath: true

Wyck external dependency plugin can be found on our GitHub releases or Modrinth.

Leave a Star, Please!

If you find Wyck useful, please consider leaving a star on our GitHub repository.