Manual configuration (~7-8 minutes)

You can also start with a blank project and manually configure Vital yourself.
While this is not recommended for less technical plugin developers, it's fully supported and not that hard to do.

Please follow these steps carefully:

  1. Create a blank Gradle project using gradle init or your IDE.
  2. In your build.gradle or build.gradle, add Vital as a plugin.
build.gradle.kts
plugins {
  id("dev.vitalframework.vital-gradle-plugin") version "1.0.0"
}
  1. Make sure to also add your server's runtime libraries as a compileOnly dependency (paper api, bungee api, etc.)
build.gradle.kts
repositories {
  maven("https://repo.papermc.io/repository/maven-public/")
}

dependencies {
  compileOnly("io.papermc.paper:paper-api:1.21.11-R0.1-SNAPSHOT")
}
  1. Build the project using Gradle (./gradlew ) and move the built plugin JAR (build/libs/project.jar) into your server's plugins/ directory.

Troubleshooting

If you are experiencing any problems during project initialization, like ./gradlew build, etc.
Please make sure you are running the correct JDK (24) and retry.
If you are still running into problems, a ./gradlew clean or cleaning your Gradle cache files under ~/.gradle/caches/ might help.
If not, please create an issue on GitHub.

Found an issue?

Help us improve the documentation by reporting typos, missing information, or anything confusing.

Don't worry, we will auto-fill most of the annoying fields.

Create GitHub issue

This site and the Vital framework were built with ❤️ by Mike Neumann