Installation guide

Install CoreCaseX on a supported Paper server.

CoreCaseX is a Paper-only plugin for Java 21 and Paper 1.21.11 or newer. It uses SQLite storage bundled through the plugin jar.

Requirements

  • Paper 1.21.11 or newer.
  • Java 21.
  • CoreCaseX jar installed on a Paper backend.
  • No separate database service is required for the current SQLite MVP.

Installation Flow

  1. Stop the server.
  2. Place the CoreCaseX jar in the Paper server plugins folder.
  3. Start the server on Paper 1.21.11+.
  4. Confirm the plugin enables without runtime guard errors.
  5. Run /case as a player with permission and confirm the Dialog opens.

Generated Files

CoreCaseX creates its runtime folder under:

plugins/CoreCaseX/

Bundled admin config files are regenerated with comments when deleted and the server is restarted:

config.yml
case-types.yml
discord.yml
messages.yml
storage.yml

Runtime data is stored by default at:

plugins/CoreCaseX/data/corecasex.db

Reload vs Restart

/case reload reloads config values into memory and logs validation warnings. Replacing the jar, changing Paper runtime, regenerating deleted default files, or changing an already-open SQLite path requires a restart or careful operational handling.

Production Validation

Before public use, test all five creation flows, player list/details, staff board filters, Open by ID, claim, assign/reassign, priority, status, internal note, staff reply, information request, reporter reply, resolve, reject, archive, teleport on location evidence, Discord success, Discord malformed URL behavior, and a harmless /case reload.