Skip to main content

Python RCON client for Plutonium

Project description

plutorcon

A lightweight Python client for sending RCON and status queries to Plutonium servers. Supports remote command execution (kick, say, tell) and retrieving server information (current map, player list, server name). You can also obtain detailed player data, including client IP addresses and GUIDs. Ideal for bots, admin panels, or monitoring tools.

Installation

pip install plutorcon

Usage

from plutorcon import PlutoniumRCON, Colors

server = PlutoniumRCON(ip="127.0.0.1", port=12500, password="mycoolpass")

# Get server status
overview = server.get_server_status()
print(overview)

# Get minimal player info (no IP)
players = server.get_players()
print(players)

# Get detailed player info (IP, Port, Guid, Name, etc.)
players_details = server.status()
print(players_details)

# Get server information
data = server.get_server_infos()
print(data)

# Send a global message
server.say("Hello, world!", Colors.RED)

# Send a private message to a player by ID
server.tell(0, "Hello you!", Colors.GREEN)

# Kick a player by ID
server.kick(0, "Bye bye!")

# Close the connection
server.close()

Troubleshooting

If you encounter issues, please check the following:

  • Ensure the client IP is whitelisted in the server's server.cfg file.
  • Make sure the server is configured to allow RCON connections and the rcon_password is set correctly.
  • Verify the server is running and accessible at the specified IP and port.

Contributing

Contributions are welcome! There is a way to tempban players, but it is not yet implemented. If you would like to add this feature, please submit a pull request.

Feel free to open an issue or submit a pull request for any improvements or bug fixes.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

plutorcon-1.0.3.tar.gz (6.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

plutorcon-1.0.3-py3-none-any.whl (7.5 kB view details)

Uploaded Python 3

File details

Details for the file plutorcon-1.0.3.tar.gz.

File metadata

  • Download URL: plutorcon-1.0.3.tar.gz
  • Upload date:
  • Size: 6.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.1

File hashes

Hashes for plutorcon-1.0.3.tar.gz
Algorithm Hash digest
SHA256 b7fa2c35bde1a9912ac9f5d245b0dff2eb3852006b5d349e3e3337ae335d5c48
MD5 d980d3552334f7479a3690c7769cca4d
BLAKE2b-256 6b17cba4e8292d424f0e91509fabfca155cc1fecf1012668f59d2ac1ebeb2447

See more details on using hashes here.

File details

Details for the file plutorcon-1.0.3-py3-none-any.whl.

File metadata

  • Download URL: plutorcon-1.0.3-py3-none-any.whl
  • Upload date:
  • Size: 7.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.1

File hashes

Hashes for plutorcon-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 64458537e5dd88beb76812dfc910a8183b64cd776e276612d18ca48ef4fb82ad
MD5 913650d39223058fe87485fcf044564a
BLAKE2b-256 8a1b22a2f56163ce6b824a916961e32d3366b8b958dfe090b033f8c9c7943771

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page