Quick Start

Prerequisites

Before you begin, you need:

Java 17 or higher
Gradle 7 or higher
Node.js (for running the test runner, can be downloaded automatically by using downloadNode setting)
A Paper/Spigot plugin project

Installation

Add Plugwright to your build.gradle.kts file:

plugins {
    id("io.github.drownek.plugwright") version "2.0.4"
}

plugwright {
    minecraftVersion.set("1.19.4")
    testsDir.set(file("src/test/e2e"))
    acceptEula.set(true)

    // Download some dependencies your plugin might need
    downloadPlugins {
        url("https://url.to/plugin1.jar")
        url("https://url.to/plugin2.jar")
        // ... etc
    }

    // If true, always downloads and uses an isolated Node.js version, ignoring the system Node.
    downloadNode.set(true)
}

If you already have Node.js installed on your system, you can comment out downloadNode.set(true) to speed up initialization. Otherwise, leave it uncommented.

Initialization

Run the init command to set up your test folder. This will automatically generate your package.json, TypeScript configuration, and an example test in a chosen directory.This command is interactive, so simply follow the prompts on your screen:

./gradlew plugwrightInit

Your First Test

Run your tests:

./gradlew plugwrightTest

Plugwright hooks into your build process and tests against your compiled plugin jar. Ensure your plugin compiles successfully (e.g. jar or shadowJar task) before running tests!

Get Started

Documentation