Skip to content

Commit

Permalink
Add documentation for RConObserver
Browse files Browse the repository at this point in the history
  • Loading branch information
CounterPillow committed Oct 6, 2014
1 parent c6830a3 commit 16edd62
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions docs/config.rst
Expand Up @@ -376,6 +376,31 @@ Observers
once for every 1% of progress.

**Required**

``RConObserver(target, password[, port][, pct_interval])``
This Observer will announce render progress with the server's ``say``
command through RCon.

* ``target=<address>``
Address of the target Minecraft server.

**Required**

* ``password=<rcon password>``
The server's rcon password.

**Required**

* ``port=<port number>``
Port on which the Minecraft server listens for incoming RCon connections.

**Default:** ``25575``

* ``pct_interval=<update rate, in percent>``
Percentage interval in which the progress should be announced, the same as
for ``ServerAnnounceObserver``.

**Default:** ``10``



Expand Down

0 comments on commit 16edd62

Please sign in to comment.