Skip to main content

Python class for interacting with Project Zomboid servers using RCON

Project description

zomboid-rcon version 0.2.2 (Beta)

A Python package for interacting with Project Zomboid Servers using RCON.

This project uses the timeout_decorator package which is Unix/Linux only. Timeouts will cause errors on Windows due to this.


How to use

Example:

from zomboid_rcon import ZomboidRCON

if __name__ == "__main__":
    pz = ZomboidRCON(ip='localhost', password='myPassword')
    command = pz.serverMsg("You dead yet?")
    print(command.response)
    print(command.response)

Outputs:

Message sent.
True

Available commands:

The follow commands are available through built-in methods:

  • serverMsg
  • players
  • save
  • quit
  • help
  • showoptions

Or execute any command using the command method:

from zomboid_rcon import ZomboidRCON

if __name__ == "__main__":
    pz = ZomboidRCON(ip='localhost', password='myPassword')
    command = pz.command("servermsg", "Hello!")

To do:

  • Add all possible commands
  • Find alternate solution for timeouts for Windows

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

zomboid_rcon-0.2.2.tar.gz (41.3 kB view hashes)

Uploaded Source

Built Distribution

zomboid_rcon-0.2.2-py3-none-any.whl (30.1 kB view hashes)

Uploaded Python 3

Supported by

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