Ascii Bukkit Menu

Table of Contents

Ascii Bukkit Menu

What is it?

Ascii Bukkit Menu is a Bukkit server manager. Written with bash, designed to be simple and robust. Should work out of the box on most distros. Specificly designed to run on a headless server via a ssh session.

Features:

Uses screen to keep server session running in background, can reconnect at anytime.
Start/Stop/Restart commands.
Send commands directly to bukkit server.
Automatically update Bukkit server to latest recommended.
Bukkit server log rotation. Rotates server.log on each start, keeps last 20 compressed.
If using Ramdisks, will automatically copy worlds between ramdisk and localdisk. Then runs an md5sum to verify consistency of the data.
Start and Stop server on boot using non-interactive mode.

See:

ScreenShots - Updated for 0.2.8

Download:

Latest Release 0.2.8

Dependencies:

Java Runtime Enviroment http://java.com/en/download/manual.jsp
bash http://www.gnu.org/s/bash/
screen http://www.gnu.org/s/screen/
-Must have vertical support. (This is baked into debian based systems)
-Arch users try this package
-RHEL/CentOS use Git Souce | HowTo
grep http://www.gnu.org/s/grep/
wget http://www.gnu.org/s/wget/
zip / unzip
logrotate
md5sum (optional)
sysstat utilities (optional to see network usage)
python (optional)

Install:

AutoMagic Method:
This will download and install ABM, then run an interactive script to setup the configuration.
No need to edit config manually.
Simply copy and paste the following to a bash shell.

wget http://dev.bukkit.org/media/files/667/24/install.sh && chmod +x install.sh && ./install.sh

Traditional method - zip:

wget http://dev.bukkit.org/media/files/667/23/abm-0.2.8.zip
unzip abm-0.2.8.zip

Experimental Builds - git:
Not for the faint of heart.

git clone https://user77@github.com/user77/Ascii-Bukkit-Menu.git

Usage:

To use ABM simply change to the directory you installed it to and run the abm.sh script.

cd Ascii-Bukkit-Menu
./abm.sh

You can also run in non-interactive mode. This can be added to startup scripts. Currently doesn't work if you are using a ramdisk

./abm --start
./abm --stop

Help:

First check to see you have the correct dependencies as listed above.
Make sure your user has +rx permissions to Ascii-Bukkit-Menu directory

chmod -R u+rx Ascii-Bukkit-Menu
chown -R you:yourgroup Ascii-Bukkit-Menu

Issues:

Dosen't work on screen without vertical support.

This is very much a work in progress. So if you come across a bug, please open a ticket.
here.

Comments

_ForgeUser10234602
- Join Date: 12/19/2012
- Posts: 1
- Member Details
#155 _ForgeUser10234602

View User Profile

Send Message

Posted Mar 31, 2014
@TnTBass

I followed your instructions but I guess I am doing something wrong, when I start ABM i get an error stating -Dlog4j.configurationFile=/location/of/my/server/log4j2.xml The file or directory does not exist.

Rollback Post to Revision RollBack
_ForgeUser5803084
- Join Date: 10/12/2010
- Posts: 114
- Member Details
#154 _ForgeUser5803084

View User Profile

Send Message

Posted Jan 24, 2014
@TheRedHun1

Please see this comment: http://dev.bukkit.org/bukkit-plugins/ascii-bukkit-menu/?comment=148

That will solve your log problems.

Rollback Post to Revision RollBack
_ForgeUser7364672
- Join Date: 8/11/2011
- Posts: 17
- Member Details
#153 _ForgeUser7364672

View User Profile

Send Message

Posted Jan 23, 2014
I tried this out, hoping for a working restart script, and it works. I thank you so very much for it. There is one small issue though with the server log. It fails to load the server log every time and says there is no server log in the directory. Other then that issue, it works perfect. Could you also add the ability to schedule saving on lie a 10 minute interval?

Rollback Post to Revision RollBack
TheeTallest
- Location: Utah
- Join Date: 10/15/2008
- Posts: 6
- Member Details
#152 TheeTallest

View User Profile

Send Message

Posted Jan 17, 2014
@TnTBass

I will try to run it there. The last time I Put it there the server gave me the middle finger. Maybe I fat fingered it some how.....

EDIT: I guess I did fat finger it. All is working now except I cannot see anything being presented in the players line it says players [/] << does not display how many players are online. That could be my issue because no matter what I put in for the NIC it does not accept it sar=I have tried ETH0 eth0 and so on.

Last edited by TheeTallest: Jan 17, 2014

Rollback Post to Revision RollBack
_ForgeUser5803084
- Join Date: 10/12/2010
- Posts: 114
- Member Details
#151 _ForgeUser5803084

View User Profile

Send Message

Posted Jan 17, 2014
@TheTallest

This is how I have it on one of my servers and it works like a charm:

# Java Arguments, change to whaever you like. # For a complete list, please see: http://bit.ly/mYKJte jargs="-server -Xmx1536M -Dlog4j.configurationFile=/opt/blackdamp/log4j2.xml"
Rollback Post to Revision RollBack
TheeTallest
- Location: Utah
- Join Date: 10/15/2008
- Posts: 6
- Member Details
#150 TheeTallest

View User Profile

Send Message

Posted Jan 16, 2014
@TnTBass

Yeah but Where in the abm.conf file do you place that line. I do not see any where you can post that line to make it work ? Please point out where we should place this line.

If you saying place it here

Java Arguments, change to whaever you like.
For a complete list, please see: http://bit.ly/mYKJte jargs="-server -Xincgc -Xmx1G"

I tried placing it there and it freaked out my server on start up. Could please point where this should go.
Rollback Post to Revision RollBack
_ForgeUser5803084
- Join Date: 10/12/2010
- Posts: 114
- Member Details
#149 _ForgeUser5803084

View User Profile

Send Message

Posted Jan 12, 2014
@TheTallest

Actually, that's a sub optimal way of doing it as there is already a config file you can use. I'm reposting my instructions with a bit of clarification (because I want this front and center for people using ABM).

Since Ascii Bukkit Menu already rotates logs, the new logging changes introduced in Minecraft 1.7 were causing problems with the intended functionality. Hence, here's how you can get ABM working for you again with minimal effort.

Create a file in your server directory. Name the file log4j2.xml

Edit your log4j2.xml with the contents of this gist. This has the format that works best for Ascii Bukkit Menu 0.2.8: https://gist.github.com/TnTBass/7793351

Add this to your start line for your server (you can change this in the abm.conf file located in ABM/include/config/abm.conf):

-Dlog4j.configurationFile=<path to server directory>log4j2.xml (Example: -Dlog4j.configurationFile=/opt/blackdamp/log4j2.xml )

Launch Ascii Bukkit Menu. server.log is now returned to the root of your server folder and Ascii Bukkit Menu functions as it used to.
Last edited by _ForgeUser5803084: Jan 12, 2014

Rollback Post to Revision RollBack
_ForgeUser9923590
- Join Date: 11/4/2012
- Posts: 2
- Member Details
#148 _ForgeUser9923590

View User Profile

Send Message

Posted Jan 12, 2014
Thank you, it's working now :D

Rollback Post to Revision RollBack
TheeTallest
- Location: Utah
- Join Date: 10/15/2008
- Posts: 6
- Member Details
#147 TheeTallest

View User Profile

Send Message

Posted Jan 12, 2014
@Sygaro

It is in your functions file. It took me a few minutes to find it myself but in that file look for the following line # Find PID of Bukkit Server right below you will see see this bukkitPID=`ps -ef |grep "java $jargs -jar $bukkitdir/craftbukkit" | grep -v grep | awk '{ print $2 }'` Put your start up parameter after craftbukkit but inside the quotes other it will get ignored. I Hope this helps.

Rollback Post to Revision RollBack
_ForgeUser9923590
- Join Date: 11/4/2012
- Posts: 2
- Member Details
#146 _ForgeUser9923590

View User Profile

Send Message

Posted Jan 12, 2014
Hi, I’m struggling to find where I should place the startup parameter. Which file should it be in and where in that file? I have tried to search for it in ../include/scripts/functions.sh but can’t find where the startup parameter should be. Please advise.

Rollback Post to Revision RollBack
TheeTallest
- Location: Utah
- Join Date: 10/15/2008
- Posts: 6
- Member Details
#145 TheeTallest

View User Profile

Send Message

Posted Jan 11, 2014
@TnTBass

Where am placing the line at? In the abm.conf file in the vars file ?

EDIT: Figured out where to put the line in he functions file. The only problem is when I load up with the line and log file you said to use it no longer shows a status and tells me that there is no bukkit server running. i reinstalled ABM and all is well now. I did not realize that I could change what shows up in what window in screen so if I Ctrl a around I can place items where I need them I am a happy camper now.

Last edited by TheeTallest: Jan 11, 2014

Rollback Post to Revision RollBack
_ForgeUser5803084
- Join Date: 10/12/2010
- Posts: 114
- Member Details
#144 _ForgeUser5803084

View User Profile

Send Message

Posted Jan 10, 2014
@TheTallest

Please check this comment I made earlier: http://dev.bukkit.org/bukkit-plugins/ascii-bukkit-menu/?comment=133

This comment describes how to get that information back.

Rollback Post to Revision RollBack
TheeTallest
- Location: Utah
- Join Date: 10/15/2008
- Posts: 6
- Member Details
#143 TheeTallest

View User Profile

Send Message

Posted Jan 8, 2014
@TheTallest

Now I Have another issue My abm menu is not showing my bukkit server log ?

EDIT: Also it is not showing all of my plugins loaded as well it is not showing me how many players are logged onto the system.
{{https://dl.dropboxusercontent.com/u/6995352/MyABM.png|MyABM}}

Last edited by TheeTallest: Jan 9, 2014

Rollback Post to Revision RollBack
TheeTallest
- Location: Utah
- Join Date: 10/15/2008
- Posts: 6
- Member Details
#141 TheeTallest

View User Profile

Send Message

Posted Jan 8, 2014
Hello all

First I Love your menu it has made my life a heck of a lot easier. Second What file do I alter so I can get my logrotate to work. I am working On OpenSuse which did not put logrotate in what is normal location. I can execute log rotate from the command line and it comes up but ABM does not see it.

Thank you for any and all help.

Rollback Post to Revision RollBack
_ForgeUser5803084
- Join Date: 10/12/2010
- Posts: 114
- Member Details
#140 _ForgeUser5803084

View User Profile

Send Message

Posted Jan 1, 2014
@penne12

Try reinstalling ABM. Looks like you are missing some files.

Rollback Post to Revision RollBack
_ForgeUser9761674
- Join Date: 10/7/2012
- Posts: 37
- Member Details
#138 _ForgeUser9761674

View User Profile

Send Message

Posted Dec 28, 2013
Does anyone know why this happens when I run

sh ./abm

That this error message pops up?

abm.sh: 30: abm.sh: source: not found abm.sh: 39: abm.sh: depCheck: not found abm.sh: 40: abm.sh: source: not found abm.sh: 41: abm.sh: [[: not found abm.sh: 58: abm.sh: source: not found abm.sh: 107: abm.sh: Syntax error: "(" unexpected (expecting "then")

And the menu pops up, then exits. Then, when I press the up arrow, it has a screen command, which I run, that takes me to a new screen.
Rollback Post to Revision RollBack
_ForgeUser8587161
- Join Date: 3/15/2012
- Posts: 1
- Member Details
#137 _ForgeUser8587161

View User Profile

Send Message

Posted Dec 11, 2013
@thib3113

This exact thing happened to me. You forgot to run the wget command in a bash shell.
Start the terminal, and type this:

bash

Now, type the wget command. It should work now.
Rollback Post to Revision RollBack
_ForgeUser7080695
- Join Date: 6/28/2011
- Posts: 39
- Member Details
#135 _ForgeUser7080695

View User Profile

Send Message

Posted Dec 5, 2013
@TnTBass

Okay did this and looks to be working great. I don't run many plugins so can't say it has been fully tested but this gets things working for me. Thank you TnTBass

Rollback Post to Revision RollBack
_ForgeUser5803084
- Join Date: 10/12/2010
- Posts: 114
- Member Details
#134 _ForgeUser5803084

View User Profile

Send Message

Posted Dec 4, 2013
@lazy_architect

Found a better way to handle these new console changes/logging changes. This is rather specific to Ascii Bukkit Menu (Since Ascii Bukkit Menu already rotates logs, the new logging changes were causing problems).

Create a file in your server directory. Name the file log4j2.xml

Edit your log4j2.xml with the contents of this gist. This has the format that works best for Ascii Bukkit Menu 0.2.8: https://gist.github.com/TnTBass/7793351

Add this to your start line for your server:

-Dlog4j.configurationFile=<path to your server directory>log4j2.xml

(Example: -Dlog4j.configurationFile=/opt/blackdamp/log4j2.xml )

Launch Ascii Bukkit Menu. server.log is now returned to the root of your server folder and Ascii Bukkit Menu functions as it used to.

Rollback Post to Revision RollBack
_ForgeUser5803084
- Join Date: 10/12/2010
- Posts: 114
- Member Details
#133 _ForgeUser5803084

View User Profile

Send Message

Posted Dec 4, 2013
@lazy_architect

Try changing these lines in the include/config/vars file:

slog="$bukkitdir/logs/latest.log"

logs="$bukkitdir/logs/"

Report back please. :)

Last edited by _ForgeUser5803084: Dec 4, 2013

Rollback Post to Revision RollBack
To post a comment, please login or register a new account.

Project ID

33842
Created

Nov 14, 2011
Last Released File

Jan 22, 2013
Total Downloads

73,609
License

GNU General Public License ver...

Bukkit

Ascii Bukkit Menu

Bukkit Plugins