#!/bin/bash## Minecraft Alpha SMP Server startup script# Version 1.0.2, released November 13th, 2010# (c) 2010 Dagmar d'Surreal# Released under the terms of the GNU GPL 2.0.# Run this script with the argument 'licence' to read the licence.############################################################################### #### DO NOT EDIT THIS FILE!!! Put your settings in the usual /etc directory #### or in ~/.minecraft.conf if you are running this as a normal user. #### ###############################################################################die() { local message=$* local bell=`tput bel 2>/dev/null` local bold=`tput bold 2>/dev/null` local red=`tput setf 4 2>/dev/null` local off=`tput sgr0 2>/dev/null` echo "$bell${bold}Fatal error: $red$message$off" exit 1}get_configuration() { if [ $UID -eq 0 ]; then # Started by root/init ...and before anyone can ask, there is # no time when it would make sense for the role user to be # used to start the server directly, because it's a _role_ # account--no more a 'user' than 'root' is. local conf_locs='/etc/init /etc' local confname='minecraft.conf' else # Started safely by a normal user account local conf_locs='~' local confname='.minecraft.conf' fi local found=0 local tmp for tmp in $conf_locs; do if [ -e $tmp/$confname ]; then source $tmp/$confname found=1 break fi done if [ ! found ]; then echo "No configuration file found, using defaults." >&2 fi}# There are a few sanity checks in here simply because there is no better# place for them. A few of the generated defaults _require_ that certain# information already have been sanity-checked.set_defaults() { # If the system is just starting, this might not be populated yet. USER=${USER:-`getusername $UID`} # Note: Unix usernames should not exceed eight characters in length # for reasons which are mostly historical, so 'minecraft' is a bad # choice and definitely unsuitable as a default. if [ $UID -eq 0 ]; then MC_USER=${MC_USER:-miner} else MC_USER=${MC_USER:-$USER} if [ $MC_USER != $USER ]; then # Technical/security considerations make this impractical at best. die "Non-root users may not specify a different MC_USER." fi fi [[ $MC_USER == "root" ]] && die "The server should never run as root!" if ! userexists $MC_USER; then die "The '$MC_USER' role account does not exist."; fi MC_DIR=${MC_DIR:-`gethomedir $MC_USER`} MEM_USE=${MEM_USE:-1024} [[ $MEM_USE -lt 2 ]] && die "MEM_USE may not be set lower than 2Mb!" # If Hey0's mod is installed, it's the default. if [ -r $MC_DIR/Minecraft_Mod.jar ]; then HEY0_MOD=${HEY0_MOD:-yes} else HEY0_MOD=${HEY0_MOD:-no} fi # This gives users sixty seconds to logout before everything goes away. GRACE_TIME=${GRACE_TIME:-60} # The following hack is brought to you by distros that firmly believe # everything should be in it's own separate subdirectory. *glare* local javaloc=`which java 2>/dev/null` if [ -z $javaloc ]; then if [ -x /usr/lib64/java/bin/java ]; then javaloc=/usr/lib64/java/bin/java else if [ -x /usr/lib/java/bin/java ]; then javaloc=/usr/lib/java/bin/java fi fi if [ -z $javaloc ]; then die "Java does not appear to be installed on this machine." else JAVABIN=${javaloc:-java} fi else JAVABIN=$javaloc fi which screen 2>/dev/null 1>/dev/null if [ $? != 0 ]; then die "GNU screen not found on system and is required!" fi}dump_settings () { local varnames="MC_USER MC_DIR MEM_USE HEY0_MOD GRACE_TIME" local tmp echo "# Minecraft server configuration" echo "# Date: `date`" echo "" for tmp in $varnames; do echo "$tmp=${!tmp}" done}append_to_path() { local IFS=: local dirname=$1 local tmp local newpath local match=0 for tmp in $PATH; do if [ $tmp == $1 ]; then (( match++ )) break fi done if [ $match -eq 0 ]; then PATH=${PATH:+$PATH:}$dirname fi}# This is here so that boolean variables can be defined more flexiblyboolean() { if [ ${1:0:1} == 0 -o ${1:0:1} == 'n' -o ${1:0:1} == 'N' ]; then return 1 fi}userexists() { [[ -n "`getuid $1`" ]]}gethomedir() { awk -F: "\$1 == \"$1\" { print \$6 }" /etc/passwd 2>/dev/null}getuid() { awk -F: "\$1 == \"$1\" { print \$3 }" /etc/passwd 2>/dev/null}getusername() { awk -F: "\$1 == \"$3\" { print \$1 } | head -n 1" /etc/passwd 2>/dev/null}getserverpids () { if [ -n "`which lsof 2>/dev/null`" ]; then # lsof almost makes this reliable lsof -t $MC_DIR/server.log.lck 2>/dev/null else local uid=`getuid $MC_USER` # Fallback to using ps. We're using the uid because people # can't be trusted to not use 'minecraft' as a username, and # that tends to make ps unable to find the name by the uid ps -C java -o uid=,pid=,cmd= | awk "(/minecraft_server.jar/ || /Minecraft_Mod.jar/) && \$1 == $uid { print \$2 }" 2>/dev/null fi}send_server_message () { local message=$* if [ $MC_USER == $USER ]; then screen -S Minecraft -p Minecraft -X stuff "`echo -e \"\r$message\r\"`" else su - $MC_USER -c "screen -q -S Minecraft -p Minecraft -X stuff \"`echo -e \"\r$message\r\"`\"" fi}send_stop_cmd () { send_server_message "stop"}construct_cmd () { local jarfile if boolean $HEY0_MOD; then jarfile=Minecraft_Mod.jar else jarfile=minecraft_server.jar fi echo "cd $MC_DIR ; screen -d -m -t Minecraft -S Minecraft $JAVABIN -Xms${MEM_USE}M -Xmx${MEM_USE}M -jar $jarfile nogui"}server_is_up() { if [ ! -e $MC_DIR/server.log.lck ]; then # No lockfile means the server is almost certainly down. return 1 fi [[ -n `getserverpids` ]]}server_start () { local status local cmd=`construct_cmd` if [ $MC_USER == $USER ]; then # Starting things as your own uid echo "Running: $cmd" eval $cmd status=$? else # Starting things as root with an su to another uid su - $MC_USER -c "`construct_cmd`" status=$? fi # Because the stupid thing doesn't place the file lock as the very first # thing it does, we need to wait a momnent. If your machine can't get it # done within a clock second, it probably shouldn't be running the server. sleep 1 # We check after the fact because there's simply no way to tell what the # hell happened on the other side of screen without pumping a whole shell # script through it as the "command". if [ $status -eq 0 ]; then if server_is_up; then echo "Minecraft server started successfully." exit else echo "Minecraft server failed to start properly." exit 1 fi echo "Minecraft server started successfully." exit else echo "Error: Command exited with non-zero status!" >&2 exit 1 fi}server_stop () { local second local cleanshutdown if [ $GRACE_TIME -ne 0 ]; then # There's not much point in giving a countdown, so this is pretty much it. # Maybe in a future version we'll emit markers every 15 seconds. echo "Giving Minecraft players $GRACE_TIME seconds warning..." send_server_message "say ATTENTION: The server is shutting down in $GRACE_TIME seconds!" sleep $GRACE_TIME fi send_server_message "say The server is shutting down NOW." for ((second=1 ; second < 30 ; second++)); do send_stop_cmd sleep 1 if ! server_is_up; then cleanshutdown=1 break fi done if [ $cleanshutdown -eq 1 ]; then echo "Minecraft server stopped successfully." else echo "Minecraft server failed to shutdown within 30 seconds!" >&2 exit 1 fi}get_configurationset_defaultsshow_licence() {cat <<EOF GNU GENERAL PUBLIC LICENSE Version 2, June 1991 Copyright (C) 1989, 1991 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The licenses for most software are designed to take away yourfreedom to share and change it. By contrast, the GNU General PublicLicense is intended to guarantee your freedom to share and change freesoftware--to make sure the software is free for all its users. ThisGeneral Public License applies to most of the Free SoftwareFoundation's software and to any other program whose authors commit tousing it. (Some other Free Software Foundation software is covered bythe GNU Lesser General Public License instead.) You can apply it toyour programs, too. When we speak of free software, we are referring to freedom, notprice. Our General Public Licenses are designed to make sure that youhave the freedom to distribute copies of free software (and charge forthis service if you wish), that you receive source code or can get itif you want it, that you can change the software or use pieces of itin new free programs; and that you know you can do these things. To protect your rights, we need to make restrictions that forbidanyone to deny you these rights or to ask you to surrender the rights.These restrictions translate to certain responsibilities for you if youdistribute copies of the software, or if you modify it. For example, if you distribute copies of such a program, whethergratis or for a fee, you must give the recipients all the rights thatyou have. You must make sure that they, too, receive or can get thesource code. And you must show them these terms so they know theirrights. We protect your rights with two steps: (1) copyright the software, and(2) offer you this license which gives you legal permission to copy,distribute and/or modify the software. Also, for each author's protection and ours, we want to make certainthat everyone understands that there is no warranty for this freesoftware. If the software is modified by someone else and passed on, wewant its recipients to know that what they have is not the original, sothat any problems introduced by others will not reflect on the originalauthors' reputations. Finally, any free program is threatened constantly by softwarepatents. We wish to avoid the danger that redistributors of a freeprogram will individually obtain patent licenses, in effect making theprogram proprietary. To prevent this, we have made it clear that anypatent must be licensed for everyone's free use or not licensed at all. The precise terms and conditions for copying, distribution andmodification follow. GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License applies to any program or other work which containsa notice placed by the copyright holder saying it may be distributedunder the terms of this General Public License. The "Program", below,refers to any such program or work, and a "work based on the Program"means either the Program or any derivative work under copyright law:that is to say, a work containing the Program or a portion of it,either verbatim or with modifications and/or translated into anotherlanguage. (Hereinafter, translation is included without limitation inthe term "modification".) Each licensee is addressed as "you".Activities other than copying, distribution and modification are notcovered by this License; they are outside its scope. The act ofrunning the Program is not restricted, and the output from the Programis covered only if its contents constitute a work based on theProgram (independent of having been made by running the Program).Whether that is true depends on what the Program does. 1. You may copy and distribute verbatim copies of the Program'ssource code as you receive it, in any medium, provided that youconspicuously and appropriately publish on each copy an appropriatecopyright notice and disclaimer of warranty; keep intact all thenotices that refer to this License and to the absence of any warranty;and give any other recipients of the Program a copy of this Licensealong with the Program.You may charge a fee for the physical act of transferring a copy, andyou may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Program or any portionof it, thus forming a work based on the Program, and copy anddistribute such modifications or work under the terms of Section 1above, provided that you also meet all of these conditions: a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change. b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License. c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.)These requirements apply to the modified work as a whole. Ifidentifiable sections of that work are not derived from the Program,and can be reasonably considered independent and separate works inthemselves, then this License, and its terms, do not apply to thosesections when you distribute them as separate works. But when youdistribute the same sections as part of a whole which is a work basedon the Program, the distribution of the whole must be on the terms ofthis License, whose permissions for other licensees extend to theentire whole, and thus to each and every part regardless of who wrote it.Thus, it is not the intent of this section to claim rights or contestyour rights to work written entirely by you; rather, the intent is toexercise the right to control the distribution of derivative orcollective works based on the Program.In addition, mere aggregation of another work not based on the Programwith the Program (or with a work based on the Program) on a volume ofa storage or distribution medium does not bring the other work underthe scope of this License. 3. You may copy and distribute the Program (or a work based on it,under Section 2) in object code or executable form under the terms ofSections 1 and 2 above provided that you also do one of the following: a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.)The source code for a work means the preferred form of the work formaking modifications to it. For an executable work, complete sourcecode means all the source code for all modules it contains, plus anyassociated interface definition files, plus the scripts used tocontrol compilation and installation of the executable. However, as aspecial exception, the source code distributed need not includeanything that is normally distributed (in either source or binaryform) with the major components (compiler, kernel, and so on) of theoperating system on which the executable runs, unless that componentitself accompanies the executable.If distribution of executable or object code is made by offeringaccess to copy from a designated place, then offering equivalentaccess to copy the source code from the same place counts asdistribution of the source code, even though third parties are notcompelled to copy the source along with the object code. 4. You may not copy, modify, sublicense, or distribute the Programexcept as expressly provided under this License. Any attemptotherwise to copy, modify, sublicense or distribute the Program isvoid, and will automatically terminate your rights under this License.However, parties who have received copies, or rights, from you underthis License will not have their licenses terminated so long as suchparties remain in full compliance. 5. You are not required to accept this License, since you have notsigned it. However, nothing else grants you permission to modify ordistribute the Program or its derivative works. These actions areprohibited by law if you do not accept this License. Therefore, bymodifying or distributing the Program (or any work based on theProgram), you indicate your acceptance of this License to do so, andall its terms and conditions for copying, distributing or modifyingthe Program or works based on it. 6. Each time you redistribute the Program (or any work based on theProgram), the recipient automatically receives a license from theoriginal licensor to copy, distribute or modify the Program subject tothese terms and conditions. You may not impose any furtherrestrictions on the recipients' exercise of the rights granted herein.You are not responsible for enforcing compliance by third parties tothis License. 7. If, as a consequence of a court judgment or allegation of patentinfringement or for any other reason (not limited to patent issues),conditions are imposed on you (whether by court order, agreement orotherwise) that contradict the conditions of this License, they do notexcuse you from the conditions of this License. If you cannotdistribute so as to satisfy simultaneously your obligations under thisLicense and any other pertinent obligations, then as a consequence youmay not distribute the Program at all. For example, if a patentlicense would not permit royalty-free redistribution of the Program byall those who receive copies directly or indirectly through you, thenthe only way you could satisfy both it and this License would be torefrain entirely from distribution of the Program.If any portion of this section is held invalid or unenforceable underany particular circumstance, the balance of the section is intended toapply and the section as a whole is intended to apply in othercircumstances.It is not the purpose of this section to induce you to infringe anypatents or other property right claims or to contest validity of anysuch claims; this section has the sole purpose of protecting theintegrity of the free software distribution system, which isimplemented by public license practices. Many people have madegenerous contributions to the wide range of software distributedthrough that system in reliance on consistent application of thatsystem; it is up to the author/donor to decide if he or she is willingto distribute software through any other system and a licensee cannotimpose that choice.This section is intended to make thoroughly clear what is believed tobe a consequence of the rest of this License. 8. If the distribution and/or use of the Program is restricted incertain countries either by patents or by copyrighted interfaces, theoriginal copyright holder who places the Program under this Licensemay add an explicit geographical distribution limitation excludingthose countries, so that distribution is permitted only in or amongcountries not thus excluded. In such case, this License incorporatesthe limitation as if written in the body of this License. 9. The Free Software Foundation may publish revised and/or new versionsof the General Public License from time to time. Such new versions willbe similar in spirit to the present version, but may differ in detail toaddress new problems or concerns.Each version is given a distinguishing version number. If the Programspecifies a version number of this License which applies to it and "anylater version", you have the option of following the terms and conditionseither of that version or of any later version published by the FreeSoftware Foundation. If the Program does not specify a version number ofthis License, you may choose any version ever published by the Free SoftwareFoundation. 10. If you wish to incorporate parts of the Program into other freeprograms whose distribution conditions are different, write to the authorto ask for permission. For software which is copyrighted by the FreeSoftware Foundation, write to the Free Software Foundation; we sometimesmake exceptions for this. Our decision will be guided by the two goalsof preserving the free status of all derivatives of our free software andof promoting the sharing and reuse of software generally. NO WARRANTY 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTYFOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHENOTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIESPROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSEDOR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OFMERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK ASTO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THEPROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,REPAIR OR CORRECTION. 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITINGWILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/ORREDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISINGOUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITEDTO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BYYOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHERPROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THEPOSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatestpossible use to the public, the best way to achieve this is to make itfree software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safestto attach them to the start of each source file to most effectivelyconvey the exclusion of warranty; and each file should have at leastthe "copyright" line and a pointer to where the full notice is found. <one line to give the program's name and a brief idea of what it does.> Copyright (C) <year> <name of author> This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.Also add information on how to contact you by electronic and paper mail.If the program is interactive, make it output a short notice like thiswhen it starts in an interactive mode: Gnomovision version 69, Copyright (C) year name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type \`show w'. This is free software, and you are welcome to redistribute it under certain conditions; type \`show c' for details.The hypothetical commands \`show w' and \`show c' should show the appropriateparts of the General Public License. Of course, the commands you use maybe called something other than \`show w' and \`show c'; they could even bemouse-clicks or menu items--whatever suits your program.You should also get your employer (if you work as a programmer) or yourschool, if any, to sign a "copyright disclaimer" for the program, ifnecessary. Here is a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the program \`Gnomovision' (which makes passes at compilers) written by James Hacker. <signature of Ty Coon>, 1 April 1989 Ty Coon, President of ViceThis General Public License does not permit incorporating your program intoproprietary programs. If your program is a subroutine library, you mayconsider it more useful to permit linking proprietary applications with thelibrary. If this is what you want to do, use the GNU Lesser GeneralPublic License instead of this License.EOF}# ' This is here to get around some syntax-highlighting failures.case "$1" in 'start') if server_is_up; then echo "The minecraft server is already running." exit fi server_start ;; 'stop') if ! server_is_up; then echo "The minecraft server is not running." exit fi server_stop ;; 'restart') if ! server_is_up; then echo "The minecraft server is not running." exit fi server_stop server_start ;; 'status') if server_is_up; then echo "The minecraft server is currently running." else echo "The minecraft server is currently NOT running." fi ;; 'dumpconfig') dump_settings ;; 'licence') show_licence ;; *) echo "Usage: $0 start|stop|restart|status|dumpconfig|licence" ;;esac# vim: set ts=2: