Minecraft plugin SkQuery

🔌 About SkQuery

SkQuery — is a Minecraft server plugin addon for Skript that exposes large parts of the Bukkit API to Skript scripts, enabling custom GUIs, MIDI playback support, many extra expressions/effects/events and other extended scripting capabilities. SkQuery is distributed as a Skript addon (not a standalone command plugin) and is used alongside the Skript plugin to add API access and advanced functionality for server scripts.

🎯 Purpose

SkQuery solves the gap between Skript's high‑level scripting and the Bukkit server API by providing syntaxes and utilities that let script authors call server features directly from Skript. It addresses limitations when building GUIs, handling advanced events, using MIDI, checking files and leveraging lower‑level Bukkit features inside scripts. SkQuery is primarily intended for server owners and script developers who use Skript to implement custom gameplay or administrative logic. ()

⚙ Key features

• Exposes many Bukkit API elements as Skript expressions, conditions and effects.
• Custom GUI/menu support for building inventory‑based interfaces from Skript.
• MIDI playback and stop syntax for in‑game MIDI file handling.
• File existence checks and other file utilities for scripts.
• Wide set of extra expressions/effects/events to extend Skript capabilities.
• bStats metrics included. ()

🧩 Who it's for

• Skript scripters who need access to Bukkit internals.
• Survival, Minigame and network servers that use Skript for custom mechanics.
• Admins and developers who prefer scriptable, data‑driven features instead of Java plugins.

🏗 Usage examples

• Create an inventory GUI entirely from a Skript using SkQuery expressions.
• Play a MIDI file to players and stop it via script commands.
• Check file existence before loading external data in scripts.
• Use added events/effects to implement custom NPC or scoreboard behaviour.

⌨️ Commands

🔐 Permissions

⚙ Installation

📥 Install

• Download the SkQuery .jar from an official release (GitHub / Spigot).
• Place the .jar in your server's plugins/ folder alongside Skript.
• Restart the server fully (do not use /reload).
• Ensure Skript loads before running scripts that use SkQuery syntaxes. ()

📦 Dependencies

• Skript — required. Latest SkQuery releases require specific Skript versions (see compatibility notes). ()
• Java: recent SkQuery releases were compiled targeting Java 17 (MC 1.13+ builds) — check the release notes for the correct Java target for each version. Older SkQuery builds exist for older Java/Minecraft versions. ()
• ProtocolLib: removed as a dependency in newer builds (some older packet features are no longer available). ()
• bStats — included for metrics (anonymous). ()

🧾 Configuration

• Official sources do not document a global config.yml for SkQuery. It primarily provides script syntaxes; configuration is usually done inside Skript scripts or by the server admin. If a release adds configuration, check the release notes or the plugin folder after first run. (Information about a config file is not present in central docs.) ()

🧠 Additional information

Known compatibility notes & conflicts

• SkQuery compatibility ties closely to the Skript version and Java runtime. Recent SkQuery releases note requirements such as Skript 2.6.1+ and Java 17 for builds targeting MC 1.13+. Use older SkQuery builds for legacy MC/Java versions. ()
• Some users have reported antivirus/false‑positive flags for certain builds — verify downloads and checksums and prefer official releases on GitHub/Spigot. See community reports on the resource page. ()

FAQ

Q: Does SkQuery work alone? A: No — SkQuery is an addon for the Skript plugin and requires Skript to be installed. ()

Q: Which Minecraft versions are supported? A: Supported MC versions depend on the SkQuery release. Recent forks target 1.13–1.21+; releases and tags note exact compatibility. Check the release notes before installing. ()

Q: Does SkQuery add plugin commands or permission nodes? A: SkQuery exposes syntaxes for Skript; it does not add documented user commands or dedicated permission nodes in the official documentation. Script authors implement commands inside Skript using its command syntax. ()

Q: Is there a dedicated config file or database support? A: Official documentation does not list a global config.yml or built‑in DB support; SkQuery focuses on providing scripting primitives. If a release introduces config options, they will be visible in the plugin folder or release notes. ()

Q: Does SkQuery collect usage statistics? A: Yes — recent releases include bStats metrics. ()

⚠ When to use SkQuery

Use SkQuery when you rely on Skript and need deeper access to Bukkit features (GUIs, MIDI, file checks and extra events). For pure command/permission plugins or heavy Java logic, a native Java plugin may be more appropriate.