|
|
@@ -1,3 +1,27 @@
|
|
|
-# Splunk-IdleRPG
|
|
|
+# IdleRPG Support for Splunk
|
|
|
+Grabs information on one or more character's performance
|
|
|
+in the edge-of-your-seat action role playing game IdleRPG,
|
|
|
+available for free on the FreeNode IRC Network,
|
|
|
+and presents it in a simple splunk dashboard.
|
|
|
+
|
|
|
+For more information on the game, see
|
|
|
+http://xethron.lolhosting.net/
|
|
|
+
|
|
|
+## Installation
|
|
|
+On a standlone splunk instance, extract to
|
|
|
+`$SPLUNK_DIR/etc/apps/`. Make a copy of the
|
|
|
+default/inputs.conf to local/inputs.conf and
|
|
|
+modify to suit your needs. Make sure you
|
|
|
+update your character names in the stanza
|
|
|
+header and enable the script.
|
|
|
+
|
|
|
+## License
|
|
|
+This project is GPLv3. Use it. Enjoy. But share
|
|
|
+the wealth with others.
|
|
|
+
|
|
|
+See https://www.gnu.org/licenses/gpl-3.0.en.html
|
|
|
+
|
|
|
+## Author information
|
|
|
+Fred Damstra
|
|
|
+fred.damstra@gmail.com
|
|
|
|
|
|
-IdleRPG Support for Splunk
|
