Using the initializer (~2-3 minutes)

You can also use the Vital-Initializer to automatically create a project based on your preferred configurations.
This feature is currently not available through the web, and to use the initializer, you must clone the GitHub repository and run it locally.

The initializer will ask you a couple of questions and will eventually generate a complete project that matches your configurations.
Once generated, you can simply open the project in your favorite IDE and start developing.

To create a project using the initializer, follow these steps:

  1. Clone Vital from GitHub by running git clone https://github.com/mike-neumann/vital in your preferred location.
  2. Open the project in your IDE or directly in your terminal.
  3. Run the initializer by clicking on your run-configurations at the top-right and choosing "initializer" or by running this command in the initializer/ directory of the GitHub repository: ./initializer.sh or initializer.bat if you're on Windows.
  4. The initializer will now start and ask you a couple of questions, once completed, it generates your project and tells you its location. After generation is complete, copy the project into your preferred location and open it in your IDE or terminal.
  5. The generated project already contains a run-configuration for IntelliJ, simply click on "run-configurations" at the top-right and build your plugin. Or if you're using the terminal, run ./gradlew build in your plugin directory.
  6. Move the built plugin JAR (build/libs/plugin.jar) into your server's plugins/ folder and restart / reload your server.

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