Example plugins
Every example is a repository of its own in the VersatiaFramework organisation: one Paper 1.21.4 plugin (two, where the feature is about two plugins) showing exactly one feature, with one file to read, the log lines to expect and a few things to try. The catalogue with the learning path lives in VersatiaExamples; the cards below follow the same order.
Each repository builds on its own with ./gradlew build once VersatiaAPI (and, for the Database example,
VersatiaModule-Database and VersatiaStarter) are in your local Maven repository (see
Building the framework), and runs on a server with
VersatiaCore installed. Repositories are named
VersatiaExample-<Topic>-<Feature>, so they sort by topic on GitHub.
Learning path
Adding an example
Start from VersatiaExample-Template
("Use this template"), keep the README sections, add the example to the catalogue and put an
example card on the documentation page it illustrates. The template's build is the one every
example shares: repositories and the VersatiaCatalog import in settings.gradle.kts, versatiaVersion in gradle.properties, the
VersatiaStarter dependency, the checkPluginYml check that fails the build for a plugin.yml
Paper would reject or a paper-plugin.yml, and deployPlugin, which copies the JAR to your server without the version in
its name; see Plugin build scripts.