Skip to content
Documentation

Creating a project

Project structure

What is in a generated project.

  • build.gradle.kts or pom.xml: the build file and the dependencies.
  • src/main/java/…: the plugin code, including the main class.
  • src/main/resources/plugin.yml (or paper-plugin.yml, bungee.yml, velocity-plugin.json depending on the platform): the descriptor the server reads, with the name, version, main class, API version and any depend or softdepend entries.
  • src/main/resources/config.yml and other resources, when the plugin needs them.
  • src/test/…: tests, when they exist. Gradle and Maven run them during the build.

It is ordinary Java. You can open and edit every file in the code editor, and the project can be exported to GitHub.

NextPlan, Build, Fix and Explain