PixelScript overview

PixelScript is a modern JavaScript runtime for Minecraft servers. It keeps the important fundamentals from Paper/Spigot plugins, but lets you author logic in hot-reloadable JavaScript. The goal is simple: iterate fast without sacrificing type safety or observability.

Why PixelScript exists

• Java fatigue: Plugin authoring often devolves into rebuilds, server restarts, and boilerplate. PixelScript removes the restart loop.
• Flexible releases: Ship quick fixes and new features without going through a full build and deploy cycle. Hide features between a flag/watcher, and when the time comes, flip it on.
• Fix bugs live: Found a bug in production? Patch it live, don't let players wait for the next release.
• Interop-first: Call into Java classes, reuse existing services, and expose helpers back to scripts.
• AI friendly: It's javascript! Ever wanted to vibe code an entire server? Now you can.

Core ideas

1. Live reload: Edits to scripts are detected and reloaded without restarting the server.
2. Guard rails: The runtime validates exports, enforces a lifecycle, and surfaces errors in a readable way.
3. Bridge API: PixelScript's runtime (named 'Texel') exposes Minecraft server hooks and utility helpers.

What to expect from the documentation

Through these articles I'll guide you through the process of your PixelScript work environment, project setup and core API concepts. Hopefully, in an hour or two, you'll be building your server at mach speed!

Catch the spark, not the gospel

Many of the concepts in PixelScript are best understood by doing, hard to put into words but you'll immediately know when it clicks. Please start by following the guide, or playing around in one of our example projects! You'll get the hang of it within an hour, and never want to go back.

Think you're writing Java, because that's basically what you're doing. The API spec lined out in this documentation may seem small, but everything you can do in a regular Java plugin, you can do in PixelScript, without any this-and-that boilerplate.

On the horizon

PixelScript is actively being developed, and new features are being added all the time. Current upcoming features include:

• Native redis support (like the Sql api)
• Documentation overhaul (missing error components, debugging guides, more examples)
• Finally ship the example project