A step-by-step guide to setting up your development environment for PixelScript, including installing necessary tools and configuring your IDE.

Project Setup

A walkthrough of the PixelScript configuration options and how to customize them for your server setup.

Configuration

A walkthrough of scripts, how they're loaded, and how to organize your script files.

Scripts

Direct access to the Bukkit server instance for advanced server interactions.

Bukkit API

Download PixelScript

Stay updated with the latest changes and improvements in PixelScript through our detailed changelog.

Plugin and compiler changelog

A concept guide for Java and Skript developers transitioning to PixelScript.

Moving from XYZ

What PixelScript is, how it fits into your Minecraft plugin workflow, and what to expect from the runtime.

PixelScript overview

The global Script API, used to load Java classes and manage script lifecycle.

Script

Registering and managing commands through PixelScript.

Registering commands with `registerCommand(command: string, executor: (sender: CommandSender, args: string[]) => void): void`

Registering tab completers with `registerTabCompleter(command: string, completer: (sender: CommandSender, args: string[]) => string[]): void`

Registering command aliases with `registerCommandAlias(command: string, aliases: string | string[]): void`

Commands

Register event listeners to respond to Bukkit events in your scripts.

Setting spawn locations based on permissions

Preventing block breaking in protected areas

Event listeners

Schedule synchronous and asynchronous tasks to run on the server thread or in the background.

Run a sync task with `Scheduler.runSync(callback)`

Run an async task with `Scheduler.runAsync(callback)`

Run a sync task later with `Scheduler.runSyncLater(callback, delayInTicks)`

Run an async task later with `Scheduler.runAsyncLater(callback, delayInTicks)`

Run a sync repeating task with `Scheduler.runSyncTimer(callback, delayInTicks, periodInTicks)`

Run an async repeating task with `Scheduler.runAsyncTimer(callback, delayInTicks, periodInTicks)`

Cancel a task with `Scheduler.cancel(taskId)`

Scheduler

Execute SQL queries and manage database operations with automatic connection pooling and error handling.

Check if database is connected with `Sql.isAvailable()`

Check connection status with `Sql.isConnected()`

Create a table if it doesn't exist with `Sql.createTableIfNotExists(tableName, createTableSql, resultHandler)`

Add a column if it doesn't exist with `Sql.addColumnIfNotExists(tableName, columnName, columnDefinition, resultHandler)`

Query data with `Sql.makeQuery(query, preparer, resultHandler)`

Update data with `Sql.makeUpdate(query, preparer, resultHandler)`

Execute multiple queries atomically with `Sql.transaction(transactionHandler)`

`ctx.query(query, preparer, resultHandler)`

Database

Make HTTP requests to external APIs and web services with built-in error handling and JSON parsing.

Basic GET request with `fetch(url, options? )`

Get response as string with `response.asString()`

Parse JSON response with `response.asObject()`

Get HTTP status code with `response.getStatusCode()`

Check response status with `response.isSuccessful()` and `response.isFailed()`

HTTP Fetch

Log messages, warnings, and errors to the server console for debugging and monitoring.

Log information with `console.log(... messages)`

Log warnings with `console.warn(...messages)`

Log errors with `console.error(...messages)`

`log(... messages)` - Alias for `console.log()`

`warn(...messages)` - Alias for `console.warn()`

`error(...messages)` - Alias for `console.error()`

Console Logging

Parse and serialize JSON data for storage, API communication, and data interchange.

Serialize to JSON with `JSON.stringify(value)`

JSON

Share code between scripts using ES6-style named imports and exports.

Import with `import { name } from "path"`

import/export

An overview of PixelScript's threading model and how it interacts with the Bukkit server thread.

Concurrency Model

An overview of magic imports in PixelScript and how they facilitate module loading.

$ - Magic imports

Tips and tricks for working around limitations in Java's interop system.

Java interop

A quick and dirty list of special implementations of ES6 features in PixelScript.

ES6 Computed Property Names in Destructuring

ES6 Default Values for Nested Destructuring

Special implementations from es6

Native Java

Using the built-in timing functions to profile and optimize your PixelScript code.

Timings

Working with the PixelScript `.d.ts` type definition file to improve IDE support and type safety.

Documentation for all Pixelib projects.

PixelScript

Latest updates