2 minutes estimated read time

About

To keep everything neatly structured and also to keep your plugin JAR size small, Vital is structured into multiple modules that all do specific things.
Each module adds its own different functionality to your plugin, like commands, inventories, holograms, configs, minigames, etc.

The core module is required for all other modules because it contains the main functionality of Vital.


To make your life as easy as possible, Vital provides its own Gradle plugin, so JAR bundling and dependency version management are automatically handled for you.
To add a module to your plugin, simply add it as an implementation dependency without specifying a version.

build.gradle.kts
plugins {
  id("dev.vitalframework.vital-gradle-plugin") version "1.0.0"
}

dependencies {
  implementation("dev.vitalframework:vital-commands")
  implementation("dev.vitalframework:vital-configs")
  implementation("dev.vitalframework:vital-holograms")
  // ...
}

Please refer to each module's documentation page to check platform compatibility and how to use each module.

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