Skip to main content

English | 简体中文 | 繁體中文 | 日本語 | Русский

ErisPulse-MinecraftAdapter

ErisPulse-MinecraftAdapter

ErisPulse Minecraft adapter — RCON commands, messaging & log events

PyPI Python License ErisPulse


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: tellraw to individual players (To("user", player)), say broadcast (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:

  1. RCON cannot receive chat events — this is a protocol limitation (pure request/response). Event receiving relies on log tailing
  2. Log tailing requires the adapter to run on the same machine as the server, or the log directory mounted
  3. Log format depends on vanilla / mainstream server software (Paper, Fabric, etc.); custom log plugins may not be parsed
  4. say / tellraw echoes appear in the log — the adapter deduplicates them automatically
  5. Only text segments are supported (tellraw plain text); media segments return a descriptive error
  6. For full two-way bridging, pair a server-side WebSocket/HTTP forwarding plugin with the ErisPulse WebhookAdapter

Metadata

Release files for ErisPulse-MinecraftAdapter 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ErisPulse-MinecraftAdapter 0.1.1
File Size Uploaded Provenance Actions
erispulse_minecraftadapter-0.1.1.tar.gz 14.4 kB With provenance Details for erispulse_minecraftadapter-0.1.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for ErisPulse-MinecraftAdapter 0.1.1
File Interpreter ABI Platform Actions
erispulse_minecraftadapter-0.1.1-py3-none-any.whl Python 3 none any Details for erispulse_minecraftadapter-0.1.1-py3-none-any.whl

Total release size: 27.1 kB

Release files / erispulse_minecraftadapter-0.1.1.tar.gz

Download URL erispulse_minecraftadapter-0.1.1.tar.gz
Size 14.4 kB
Tags Source
SHA-256 checksum
How to use checksums
2f6974f8c4f9beebf4a5a94c3406a6f03b087a25bbe72e3a00b3496f83dbcf37
BLAKE2b-256 checksum
How to use checksums
aef8116c89167f842151526f5747f020859131b182d4fcdb486ea28040b4f6c1
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 Nov 5, 2026.

Transparency log

Release files / erispulse_minecraftadapter-0.1.1-py3-none-any.whl

Download URL erispulse_minecraftadapter-0.1.1-py3-none-any.whl
Size 12.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
78d34e79dc108e48a4da09bb19146ee85e3503b9da8931622272f3afb5510bc9
BLAKE2b-256 checksum
How to use checksums
e3f145780f0c0c8aefe3807bef2a9017e89e4f9037b139e49880be8ae0c3dc86
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 Nov 5, 2026.

Transparency log

Security for ErisPulse-MinecraftAdapter 0.1.1

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.

Select from 2 files

Attestation for erispulse_minecraftadapter-0.1.1.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 Nov 5, 2026.

Transparency log

A 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.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page