Python API
Build Endstone plugins in Python.
Write plugins in Python against the Endstone API - quick to iterate, with no compile step. Start with project setup, then work through the building blocks below.
Getting started
Project setup
Set up a project with pyproject.toml and the endstone entry point.
API reference
Browse the full Python API surface.
Core functionalities
Registering commands
Define and register commands players can run.
Event listeners
Listen for and handle server events.
Scheduling tasks
Run delayed and repeating tasks with the scheduler.
Async I/O
Run async I/O off the main thread and return results safely.
Gameplay
Working with players
Message, move, and manage the players on your server.
Worlds and blocks
Read and change blocks, and reach the level and its dimensions.
Inventory and items
Build item stacks and manage player inventories.
User interface
Forms
Show interactive forms to players.
Boss bars
Show a progress bar at the top of players' screens.
Scoreboards
Track scores and show per-player sidebars and name tags.
Color codes
Apply Minecraft color and formatting codes to text.
Data and distribution
Config and persistence
Store plugin configuration and data on disk.
Publishing to PyPI
Package and publish your plugin to PyPI.