AdminCraft

AdminCraft is an open source Administration Web GUI Console for administering a Linux Minecraft Server. Admincraft is in early, but active development.

AdminCraft provides the following features:

• Start, Stop, Restart the Minecraft server
• Create backups of worlds to a separate location or mounted filesystem
• Web Console to monitor server logs
• Username/Password protected
• Ability to chat with users or send manual commands
• Built-in reference for Block/Item Dec codes
• Configure server properties via Web GUI
• Server Status (Online/Offline/Restarting/Backing Up)
• View and configure user status (Connected players, Ops, Banned IPs|Players)
• Ability to schedule 'cron-like' backup jobs on set intervals

Features in progress for 1.0:

• Reworking item/block ID reference
• Login sessions, security and support for multiple Admin Users
• Support for viewing Log History

Features to add Post 1.0:

• Support to deploy and administer multiple instances of Minecraft Servers
• Support to deploy AdminCraft on a separate server than the Minecraft Server
• More server and Minecraft monitoring features

Requirements

• Minecraft Server 1.1+
• A Linux OS. AdminCraft has only been tested on Ubuntu 11.04, but should be compatible with at least 9.04+
• Python 2.6+. Python 3 is not yet supported
• Python dependencies: Flask Framework 0.8
• Enough server power to run a Minecraft Server. Basically at least a P4 with a minimum of 2GB of RAM. Minecraft likes to eat memory. :)
• Basic Linux knowledge. :)

Installation (Ubuntu 9.04+)

Note Upon 1.0 release, I will have an install script as well as a deb package. For now, you'll have to deal with the manual installation. :D

Assuming you have at least Python 2.6+ installed and the minecraft_server.jar downloaded, please follow the steps below:

1. If not installed already, please install sqlite3:

    $ sudo apt-get install sqlite3 python-setuptools
   

2. Clone AdminCraft.git:

    $ git clone git://github.com/alfg/AdminCraft.git
   

3. Run setup.py to install dependencies:

    $ python setup.py install
   

4. Open config.ini and set the required variables.

5. Copy the Minecraft daemon to /etc/init.d/

    $ sudo cp scripts/minecraft /etc/init.d/
   

6. Configure USERNAME, WORLD, MCPATH, BACKUPPATH in /etc/init.d/minecraft in the text editor of your choice

    $ sudo vim /etc/init.d/minecraft
   

7. Set required permissions to the Minecraft daemon:

    $ sudo chmod a+x /etc/init.d/minecraft
   

8. Run update-rc.d to create sym links:

    $ sudo update-rc.d minecraft defaults
   

9. Now finally, run run.py:

    $ python run.py
   

   Or to run in the background:

    $ nohup python run.py &
   

   If you wish to view the nohup output:

    $ tail -f nohup.out
   

10. Using your preferred web browser, open localhost:5000 (or your server's hostname:5000)

11. Great success! (I hope)

Notes

AdminCraft is in very early, but active development. Therefore, I cannot guarantee this will install, run, or work properly.

AdminCraft runs under Flask's built-in server with debugging and auto-reloading disabled by default. You can turn this on by changing DEBUGMODE and AUTORELOADER to "True" in config.ini. It is recommended to disable debugging if deploying to an externally accessible server.

There is much cleanup and refactoring that needs to be done. So expect major changes in future maintenance versions.

Support is limited as the project is still under early active development. But if you need help installing, or run into any problems, feel free to contact me at alf.g.jr[at]gmail.com. I can only support Ubuntu 9.04+ installations at this time.