SQLiteConnectMC

SQLiteConnectMC

A simple plugin that lets you integrate any SQLite DB with your Minecraft server and lets you execute all sorts of queries.

See To-Do.md for plugin progress.

| Supported Platforms | | --- | |Bukkit| |Spigot| |Paper| |Purpur| |Folia| |Canvas|

The platforms stated above have been tested to work with the plugin. Any forks of the above platforms *should* also work.

IMPORTANT NOTE

- The SRVBase releases are not the usual panel and console releases. The SRVBase releases expose a Postgresql connection and considers any added database to the config as a schema. - Please refer to the SRVBase README.md file or the doc.md file.

_The SRVBase releases require more technical knowledge to use, only use them if you know what you are doing._

Features

- Fail-Safe: Execute queries instantly with `/sqlite query <query>`. - Fail-Safe: Configure several SQLite files and switch between them in-game. - Fail-Safe: Run a simple login-protected query console with session cookies and CSRF checks. - Fail-Safe: Expose console/player commands, the web panel, or both through config. - Fail-Safe: Keep the default 50-row cap or set `query.row-limit` to `-1` for unlimited results. - Fail-Safe: Database tasks run asynchronously to keep your server ticking perfectly. - Fail-Safe: Read-only and read-write modes and be configured in the config, default is read-only to prevent any overrides.

Installation

1. Download the latest jar file. 2. Drop it into your server's `plugins/` folder. 3. Restart your server. 4. Open the `plugins/SQLiteConnectMC/config.yml` that gets generated and add the databases you want to inspect. Older config files are migrated automatically and backed up as `config.v<old-version>.bak.yml`. 5. Set `access.mode` to `CONSOLE_PLAYER`, `WEB_PANEL`, or `BOTH`, and adjust `query.row-limit` if you want something other than the default 50 rows. 6. If you want the panel, create a login with `/sqlite panel mail add <mail> pass set <pass>`. 7. Run `/sqlitereload` to apply config changes and start or restart the panel.

Commands

- `/sqlite query <query>` - Run a query safely on the selected database. - `/sqlite list tables` - List all tables in the selected database. - `/sqlite list databases` - List all configured databases. - `/sqlite select database <name>` - Switch the selected database. - `/sqlite help panel` - Show the panel status, URL, and account command usage. - `/sqlite panel mail add <mail> pass set <pass>` - Create or reset a web panel login. - `/sqlite help` - Displays an in-game help menu. - `/sqlitereload` - Reload the config and reconnect to the database.

Permissions

- `sqliteconnectmc.admin` : Required for all commands (Defaults to Server Operators).

Documentation

For more details on configuration, please check the doc.md file! [Warning: The doc file is AI generated to save time but is still pretty helpful.]