Add files via upload

Author: Hubert

License

@@ -0,0 +1,13 @@
+Copyright (c) 2015-2016, Hubert Tournier
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

Makefile

@@ -0,0 +1,34 @@
+# @(#) MinecraftShellLibrary:Makefile v1.00 (2016-09-18) / Hubert Tournier
+
+VERSION=1.00
+
+DEFAULTDESTDIR=/home/minecraft
+DEFAULTUSER=minecraft
+DEFAULTGROUP=minecraft
+
+tarball:
+	@tar czf MinecraftShellLibrary-${VERSION}.tar.gz License Makefile ReadMe README.md .minecraft-library .server-settings.ini Commands CronTasks
+
+verifyprerequisites:
+	@[ "`whereis screen | sed "s/screen://"`" = "" ] && echo "WARNING: GNU Screen doesn't seem to be installed. You'll need it!"
+	@[ "`whereis nbt2yaml | sed "s/nbt2yaml://"`" = "" ] && echo "WARNING: NBT2YAML doesn't seem to be installed. You'll need it!"
+
+install: verifyprerequisites
+	@echo -n "Destination directory [$(DEFAULTDESTDIR)]: " ; \
+	read DESTDIR ; \
+	[ "$$DESTDIR" = "" ] && DESTDIR=$(DEFAULTDESTDIR) ; \
+	echo -n "Minecraft user [$(DEFAULTUSER)]: " ; \
+	read USER ; \
+	[ "$$USER" = "" ] && USER=$(DEFAULTUSER) ; \
+	echo -n "Minecraft group [$(DEFAULTGROUP)]: " ; \
+	read GROUP ; \
+	[ "$$GROUP" = "" ] && GROUP=$(DEFAULTGROUP) ; \
+	install -m 0755 -o $$USER -g $$GROUP .minecraft-library $$DESTDIR ; \
+	install -m 0755 -o $$USER -g $$GROUP .server-settings.ini $$DESTDIR ; \
+	[ ! -f $$DESTDIR/.server-settings ] && cp .server-settings.ini $$DESTDIR/.server-settings ; \
+	cp -R Commands CronTasks $$DESTDIR ; \
+	chown -R $$USER:$$GROUP $$DESTDIR/Commands $$DESTDIR/CronTasks $$DESTDIR/.server-settings ; \
+	chmod 0755 $$DESTDIR/Commands $$DESTDIR/CronTasks $$DESTDIR/.server-settings ; \
+	mv $$DESTDIR/Commands/* $$DESTDIR ; \
+	rmdir $$DESTDIR/Commands
+

ReadMe

@@ -0,0 +1,56 @@
+About Minecraft Shell Library
+=============================
+An API for Minecraft / Bukkit server management and scripting.
+
+
+Installation
+============
+You'll need to know the location of your Minecraft server root directory (the place where you have your server.properties file), and the operating system user and group it runs under.
+
+After that just type "make install" and answer those questions.
+
+For an initial installation, you'll have to tweak the settings to your taste in the .server-settings installed file.
+Else verify if there are new configuration items to import in your existing server configuration.
+
+
+Usage
+=====
+Include the following line near the start of your shell scripts:
+
+. .minecraft-library
+
+Then you can use all the functions in the library.
+
+Check CronTasks/CronMonitor for a little example.
+
+The functions list is located at the start of the .minecraft-library file.
+For parameters, check each function header.
+
+
+Further development plans
+=========================
+The library works fine for me as it is.
+Nonetheless, I think I'll add a function to check if a player is running a forbidden client side mod, which could then be called from a cron script to kick/ban offending players.
+I'm also considering to add the remaining Minecraft console commands.
+
+
+Caveats
+=======
+Developed and tested only on FreeBSD 10.1.
+
+
+Versions and changelog
+======================
+1.00    2016-09-18      Initial public release
+
+
+License
+=======
+This open source software is distributed under a BSD license (see the "License" file for details).
+
+
+Author
+======
+Hubert Tournier
+September, 18 2016
+