English | 简体中文 | 繁體中文 | 日本語 | Русский
Introduction
MinecraftAdapter is a Minecraft Java Edition server adapter built on the RCON protocol. It executes commands, sends in-game messages, and (optionally) tails the server log to expose chat / join / leave events as standard events.
Highlights:
- Full RCON command surface: any command via
Api.exec(), typed helpers for player list & status - Messaging:
tellrawto individual players (To("user", player)),saybroadcast (To("server", ...)) - Optional log tail: chat → message events, join/leave → notice events (zero plugin dependency)
- Multi-server: each account is one server, auto-reconnect with exponential backoff + keepalive
- Zero third-party deps: RCON protocol implemented in-tree (~150 lines)
Installation
epsdk install MinecraftAdapter
or:
pip install ErisPulse-MinecraftAdapter
Server Prerequisites
Enable RCON in server.properties:
enable-rcon=true
rcon.port=25575
rcon.password=your_rcon_password
Configuration
[MinecraftAdapter.accounts.default]
host = "127.0.0.1" # RCON server address
port = 25575 # RCON port (rcon.port)
password = "your_rcon_password"
bot_id = "" # optional, defaults to account name
enable_log_tail = false # enable log tailing (chat/join/leave events)
log_path = "logs/latest.log" # log file path (same machine or mounted)
poll_interval = 1.0 # log scan interval (seconds)
enabled = true
Configuration notes (per account):
host/port/password: RCON endpoint (required)bot_id: bot identity in events (defaults to account name)enable_log_tail/log_path/poll_interval: event source via server log; requires the adapter to run on the same machine as the server (or the log directory mounted)
Usage
Messaging
from ErisPulse import sdk
mc = sdk.adapter.get("minecraft")
# Direct message to a player (tellraw)
await mc.Send.To("user", "Steve").Text("Hello Steve")
# Broadcast to the whole server (say)
await mc.Send.To("server", "myserver").Text("Server broadcast")
# Mentions are rendered inline
await mc.Send.To("server", "myserver").At("Steve").Text(" check this out")
# Multi-server
await mc.Send.Using("server2").To("server", "s2").Text("From the second server")
Standard API actions
r = await mc.Api.get_player_list() # {"players": ["Steve", "Alex"], "raw": "..."}
r = await mc.Api.get_status() # {"status": "ok", "connected": true}
r = await mc.Api.get_self_info() # server identity
r = await mc.Api.exec("whitelist add Alex") # any RCON command
# Multi-server
r = await mc.Api.Using("server2").exec("time set day")
Event listening (requires enable_log_tail = true)
@sdk.adapter.on_message()
async def on_chat(event):
if event["platform"] == "minecraft":
# event["detail_type"] == "server"
print(f"[MC] {event['user_id']}: {event['alt_message']}")
@sdk.adapter.on("notice")
async def on_notice(event):
if event["platform"] == "minecraft":
if event["detail_type"] == "server_joined":
print(f"{event['user_id']} joined")
elif event["detail_type"] == "server_left":
print(f"{event['user_id']} left")
Platform event mapping
| Server log line | Adapter event |
|---|---|
<Steve> hello |
message (detail_type: server) |
Steve joined the game |
notice (detail_type: server_joined) |
Steve left the game |
notice (detail_type: server_left) |
Raw log lines are preserved in minecraft_raw.line.
Important notes:
- RCON cannot receive chat events — this is a protocol limitation (pure request/response). Event receiving relies on log tailing
- Log tailing requires the adapter to run on the same machine as the server, or the log directory mounted
- Log format depends on vanilla / mainstream server software (Paper, Fabric, etc.); custom log plugins may not be parsed
say/tellrawechoes appear in the log — the adapter deduplicates them automatically- Only
textsegments are supported (tellraw plain text); media segments return a descriptive error - For full two-way bridging, pair a server-side WebSocket/HTTP forwarding plugin with the ErisPulse
WebhookAdapter
Reference links
Metadata
Release files for ErisPulse-MinecraftAdapter 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| erispulse_minecraftadapter-0.1.0.tar.gz | 13.4 kB | With provenance | Details for erispulse_minecraftadapter-0.1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| erispulse_minecraftadapter-0.1.0-py3-none-any.whl | Python 3 | none | any | Details for erispulse_minecraftadapter-0.1.0-py3-none-any.whl |
Total release size: 25.3 kB
Release files / erispulse_minecraftadapter-0.1.0.tar.gz
| Download URL | erispulse_minecraftadapter-0.1.0.tar.gz |
|---|---|
| Size | 13.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0c855e257e327933a7726469c86d3d7c93cccb8c61bef7dfd76e001f7f60335e
|
|
BLAKE2b-256 checksum How to use checksums |
97c246738f48f7d58a5d027468d3b7f4a7a85895ef112e243ee1d478f4bf3071
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 31, 2026.
Transparency logRelease files / erispulse_minecraftadapter-0.1.0-py3-none-any.whl
| Download URL | erispulse_minecraftadapter-0.1.0-py3-none-any.whl |
|---|---|
| Size | 11.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
bd0900a2c6af56f80af2d88d95003c53a233f97b06d3bc952403753315e0e3d8
|
|
BLAKE2b-256 checksum How to use checksums |
1092a1b0a5f0f493f63f3dbd677282e6b194f851e66e94854a20006cda39b7ab
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 31, 2026.
Transparency logSecurity for ErisPulse-MinecraftAdapter 0.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for erispulse_minecraftadapter-0.1.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 31, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.