Installation

Requirements

• Java 21 toolchain
• Paper server
• Skript plugin installed only if you want Skript syntax

[!NOTE] Keep Java and Paper versions aligned with your production server to avoid runtime incompatibilities.

Build artifact

From repository root:

./gradlew build

Expected output artifact:

• build/libs/Schema-Validator-<version>.jar

Deploy

1. Stop the server.
2. Copy the built JAR to plugins/.
3. Start the server.
4. Confirm that plugins/Schema-Validator/ was created.

Verify startup

Check console logs for:

• schema directory creation or load attempts
• optional Skript syntax registration, or a skip message when Skript is absent
• final plugin enable line with loaded schema count

Verify resources and baseline files

After first startup, verify these files exist:

• plugins/Schema-Validator/config.yml
• plugins/Schema-Validator/schemas/
• plugins/Schema-Validator/examples/

The bundled examples are useful for first validation runs and troubleshooting.

Verify commands

Run:

/sv help

Expected result:

• the command responds
• only the subcommands allowed by your permissions are shown
• if Skript is absent, the command still works

You can also verify:

/sv stats

Expected result:

• the plugin reports registry and validation counters
• the command works even when no schemas have been validated yet

Troubleshooting

[!TIP] If the plugin fails after an update, keep the config folder and replace only the JAR first.

Plugin does not enable

• Confirm Java 21 is used by the server process.
• If you want the Skript integration path, confirm Skript is installed and enabled.
• Confirm no duplicate old plugin JAR remains in plugins/.

Java/Bukkit API is not available to another plugin

• Confirm Schema-Validator is installed and enabled.
• Add softdepend: [Schema-Validator] to the consumer plugin.
• Check SchemaValidatorAPI.isAvailable() before calling validation methods.

Command does not work

• Confirm the plugin enabled successfully.
• Confirm your sender has schemavalidator.use, schemavalidator.reload, or schemavalidator.admin.
• Run /sv help from console to bypass player permission issues during troubleshooting.

Schemas are not loaded on startup

• Check schema-directory in plugins/Schema-Validator/config.yml.
• Confirm schema files use .json, .yml, or .yaml.
• If strict-mode: true, check logs for unsupported keyword exceptions.

Build succeeded but runtime still loads old behavior

• Confirm you copied the latest JAR from build/libs/.
• Restart the server fully (not only /reload).

Next task

Proceed to Quickstart for an end-to-end validation flow.