Code Monkey home page Code Monkey logo

webrcon's Introduction

WebRcon Package

Install

pip install webrcon

Docs

webrcon.RconConnector(host, port, password, message_callback=None, console_callback=None)

Initializes the class with the following parameters:

  • host: str - The IP address or hostname of the server accepting WebRcon connections.
  • port: Union[str, int] - The port number where the server is accepting WebRcon connections.
  • password: str - The password required for connecting via WebRcon.
  • message_callback: func - A synchronous or asynchronous function invoked whenever a chat message is received.
  • console_callback: func - A synchronous or asynchronous function invoked whenever a console message is received.

The following methods are all coroutines (and need to be awaited)

RconConnector.start(loop, **kwargs)

Opens a connection to the server

  • loop - an asyncio event loop, can be obtained through asyncio.get_event_loop()
  • kwargs - passed to websockets.client.connect - read the docs
RconConnector.close()

Closes the connection to the server

RconConnector.command(command, callback)

Sends a command over RCON to the server

  • command: str - The command you want to be sent to the server
  • callback: func - A sync/async function that should take a single argument. The passed value will be a dict consisting of the output from the RCON server.
    The response to your command will be under the Message key.

webrcon.InvalidServer

Your host/port/password combination is incorrect or the server isn't running.

webrcon.ConnectionClosed

The connection was closed but a command was still attempted.

webrcon's People

Contributors

thespookycat avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.