From 16edd622a28cda0a7d56b184741007c48cce4237 Mon Sep 17 00:00:00 2001 From: Nicolas F Date: Mon, 6 Oct 2014 21:52:21 +0200 Subject: [PATCH] Add documentation for RConObserver --- docs/config.rst | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/docs/config.rst b/docs/config.rst index c617f52..c8892b0 100644 --- a/docs/config.rst +++ b/docs/config.rst @@ -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 of the target Minecraft server. + + **Required** + + * ``password=`` + The server's rcon password. + + **Required** + + * ``port=`` + Port on which the Minecraft server listens for incoming RCon connections. + + **Default:** ``25575`` + + * ``pct_interval=`` + Percentage interval in which the progress should be announced, the same as + for ``ServerAnnounceObserver``. + + **Default:** ``10``