Minecraft App

Version 1.0

The Minecraft App lets you visualize the minecraft world from the guts side. Wondering how many blocks have been dug up by your buddies? Not a problem. Wondering who's found the most diamonds? Yep, got it covered. Have you been planting enough wheat? Carrots? Pototoes? The Minecraft App will let you know.

Release Notes

• Uses the new Splunk HTTP Event Collector as it's input instead of TCP.
• Now supports Spigot and Forge as well as Craftbukkit as a unified plugin jar.
• Plugin will cache items that the server does not acknowledge so restarting Splunk is no longer an issue
• Ore images in the "Mined Blocks" page of the app now display correctly.
• Minor bug fixes.

Getting Started

This section provides information about installing and using the Minecraft App.

Requirements

• Operating System: Windows, Linux, or Mac OS X.
• Web browsers: Latest versions of Chrome, Safari, or Firefox, Internet Explorer 9 or later.
• Craftbukkit, Spigot or Forge
  • Craftbukkit
  • Spigot
  • Forge
• LogToSplunk Plugin: The log to splunk plugin that allows input of more detailed minecraft data to splunk from CraftBukkit
• The Splunk Web Framework: The Web Framework is included in Splunk 6 and is available for download for Splunk 5 from the Splunk Developer Portal.
• Minecraft Overviewer (Optional): The Google Maps based minecraft word renderer from Overviewer

Installing the Minecraft App

The Minecraft App is built as a Splunk App on the Splunk Web Framework and must be installed on top of it.

Installing from Splunk Web

If you downloaded the Minecraft App from Splunk Apps, you can install the app within Splunk Web.

• For more, see Where to get more apps and add-ons.

Installing from a ZIP Source File

1. Download and unzip the Minecraft App or clone the repository from GitHub.
2. Copy the entire /minecraft-app subdirectory into $SPLUNK_HOME/etc/apps/.
3. Restart Splunk.
4. In Splunk Web, navigate to the Minecraft App (http://localhost:8000/dj/minecraft-app).

Event Collector Configuration

1. Confgiure the Splunk Http Event Collector as noted in the Documentation for whatever port you like.
2. Ensure firewalls and NAT are properly configured if applicable
3. Take note of the application key as you will need it later on

Installing the LogToSplunk Plugin

1. Copy the LogToSplunk jar from the app tgz or app directory into your craftbukkit server's plugins directory.
2. Create a config directory in the root server folder (the directory that contains the plugins folder).
3. Create and edit a splunk.properties text file in the config directory created in 3. Replace the port and application in your splunk.properties and adjust other options as necessary.

• Use the app token from the Event Collector Configuration above for this property splunk.craft.token=BEEFCAFE-1337-F00D-8BDA-2410D44E3453

• If you're running splunk on a separate machine from your minecraft server update this property splunk.craft.connection.host=127.0.0.1

• Use the app token from the Event Collector Configuration above for this property splunk.craft.connection.port=8088

• If you wish to log the output to a local log as well set this property to "true" mod.splunk.enable.consolelog=false

Configuring The Livemap

1. Download and configure Overview as described int the Overviewer Docs
2. Serve the overviewer via a webserver like Apache or IIS. Many operating systems have a web service built in that just needs to be enabled.
3. Create an initial render from overviewer with at least one of the "Normal","Lighting", and "Night" options
4. Copy the overviewer.css,overviewer.js, and overviewerConfig.js scripts from the base render directory to $SPLUNK_HOME/etc/apps/minecraft-app/django/minecraft-app/static/minecraft-app/ on your splunk server.
5. Edit $SPLUNK_HOME/etc/apps/minecraft-app/django/minecraft-app/static/minecraft-app/overviewerConfig.js and modify the path variable of each tileset object to include your webserver path. For example, change "path": "world-normal" to "path": "http://webserver:81/world-normal". The external hostname must be used in order for the map to be visible to clients. Using "localhost" as the webserver will not work as the minecraft app does not reserve the map, it simply redirects to it.

NOTE: The minecraft-app does not refresh overviewer renders automatically. This will need to be scheduled by another service (ie. cron or task scheduler).

Known Issues

1. Time calculations and active players may be mis-reported if player disconnects are not logged properly (ie. due to a server crash). Orphaned sessions may be estimated by running sessions from connection to the subsequent server start.
2. The live map may appear to "shift" as the minecraft world expands and overviewer resets it's origin in future renders. This can be corrected by recopying and modifying the overviewerConfig.js script with the same steps as the installation.

Documentation and resources

When you need to know more:

• For Overviewer documentation, see Overviewer

• For Spigt documentation, see Spigot

• For Forge documentation, see Forge

• For CraftBukkit documentation, see Craftbukkit

• For all things developer with Splunk, your main resource is the Splunk Developer Portal.

• For component reference documentation, see the Splunk Web Framework Reference.

• For more about Splunk in general, see Splunk>Docs.

How to contribute

If you would like to contribute to the Minecraft App, go here for more information:

• Minecraft App Github

Please feel free to open issues and provide feedback through GitHub Issues.

License

The Minecraft_App is licensed under the Apache License 2.0. Details can be found in the LICENSE file.