skip to navigation
skip to content

Not Logged In

djangocms-minecraft 0.1.0

A set of Django plugins that will display live Minecraft server status and information within your project.

Latest Version: 0.2.1

This is a simple set of plugins intended for use with Django-CMS, designed to aid in retrieving data from the servers. Much of this code comes from Dinnerbone’s amazing source (..thank you dude!) that he has graciously left as “fully open”.

See the plugins in action here!

Protocol documentation is available as well, thanks to Dinnerbone.

IMPORTANT CHANGES from 0.0.1

In 0.0.1 there was an issue with the plugin regarding socket timeout - this has been fixed in 0.1.0 - as well as quite a few other additions and changes. However, these changes also resulted in requiring your plugins to be reconfigured in edit mode after you have migrated the changes into your project from the update. Until you do this, they will be blank.

Installation

Install with pip:

pip install djangocms-minecraft

Or, optionally, install the development version:

pip install git+https://git@bitbucket.org/oddotterco/djangocms-minecraft.git#egg=djangocms-minecraft

Then, in your project’s settings.py file, add ‘djangocms_minecraft’ to the INSTALLED_APPS like so:

INSTALLED_APPS += ('djangocms_minecraft',)

Finally, perform syncdb and migrate on your project, as well as collectstatic to get all the supplied css and images for this plugin.

A note on CACHEing

It is recommended that you configure caching on your server when using this plugin (and in general, really). It really is not too complicated to set up basic caching. The following is a very basic config example, just add it to your settings.py project file.:

# Enable plugin and content caching
# Don't forget to: ./manage.py createcachetable cache_data
CACHES = {
    'default': {
        'BACKEND': 'django.core.cache.backends.db.DatabaseCache',
        'LOCATION': 'cache_data',
    },
}

Minecraft Server Config

Don’t forget to make sure that your web server has access to the ports that your Minecraft server is going to be answering these queries on. Typically this will be the same as the Minecraft game port (which is default 25565) for the status, query and plugins-list plugins. For the RCON plugins, make sure that port (default is usually 25575) is open to the web server from the game server as well. Also, for all but the basic status plugin, you will need to configure the Minecraft server to enable those services. Query and RCON are both off by default (). Look for details in the Minecraft Server.properties wiki entry.

Usage

Simply add the plugins to pages as desired. They will show up in both a text plugin’s plugins-list as well as the page plugins-list, under the header “Minecraft”.

Also included, for your use, is the commandline client provided by Dinnerbone. At the moment it does not install anything to easily access it - that will change in the next release.

Support

If you have questions or ideas, or encounter bugs, add an entry to our issue tracker.

License

As with Dinerbone’s original code - Fully open. Go wild. Let us know what you do with it and PLEASE feel free to fork and pull-request!

Further Ideas

  • make the servers list reusable so that a user does not have to re-enter the server info - reduces error potential of

    bad data over multiple plugins pointing at the same server. Also might reduce the network traffic by improving caching to specific servers

  • Add RCON support (whitelist, reload, etc)

  • help page plugin that populates using rcon

  • Autocheck for dynmap plugin before offering to link the map?

  • Autocheck for other plugins and offer RCON support as appropriate

  • javascript to autoupdate the status on a page

  • optional and configurable RESTful jason API for external consumers

  • Configuration tips, dos and dont’s doc for new users (include info about security issues with enabling query)

  • Make server timeout configurable

  • Use the minecraft server icon as the up image if there is one

  • Add commandline install for the cli.py from Dinerbone.

CHANGELOG

  • v0.0.1a1 2014/Aug/25
    • Initial release
  • v0.0.1 2014/Aug/25
    • PEP version number conflicts resolved
  • v0.1.0 2014/Aug/28:
    • Fixed timeout issues when server was not available
    • Reduced to one servers list table for all plugins
    • Cleaned up templates and added example graphics
    • Added human readable field names and help text to server model
  • v0.2.0 –

    Added caching to server info to speed up rendering if cache is enabled and configured.

 
File Type Py Version Uploaded on Size
djangocms-minecraft-0.1.0.tar.gz (md5) Source 2014-08-28 19KB
  • Downloads (All Versions):
  • 4 downloads in the last day
  • 56 downloads in the last week
  • 233 downloads in the last month