Ascii Bukkit Menu
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:
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://[email protected]/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.
Is there any way to run multiple servers with this? Ive tried installing 2 of them but Im guessing the proc is the same or something, cause when I start the second one it says "Server already running" even tho its a diff console and all.
@user777
Thanks for the info, user777. I'll be giving this all a whirl tonight.
@JeSuisNerd
Thanks for the kind words JeSuisNerd.
So ABM will assume the directory is a sub directory of your bukkit installation directory. Where the name of the worlds is defined in the configuration.
Should work like the example in that link.
So for example if you have bukkit installed to:
/opt/bukkit
and you have your /etc/fstab setup to mount your ramdisk to /opt/bukkit/worlds
Then it will copy everything in /opt/bukkit/worlds to /opt/bukkit/worlds-offline
Now if you have many worlds in the worlds dir than that's fine too, it will take everything recursively.
The only issue with having your bukkit files in your ramdisk is that ABM won't grab those files too in the copy.
You could edit the start and stop functions in Ascii-Bukkit-Menu/include/scripts/functions.sh to grab it all.
But to be honest with you, having those files like the jar and logs in ramdisk are not going to be of much benefit.
Hope this helps.
-Jon
Would it be possible to add a delay for shutdown? Having the custom shutdown message is kinda pointless if no one sees it because the instant it goes out to everyone the shutdown happens and disconnects everyone.
I'd like to be able to issue the shutdown (or restart) from ABM and have the Shutdown message tell everyone to get to a safe spot, world coming down in X minutes and then have it shut it down after that delay....
This is a fantastic utility, thanks for taking the time to make it.
I do have one question about using ramdisk, though. I have fstab all set and mounting my empty world directory just fine, but I don't see any option that specifies which directories ABM will use to copy to/from ramdisk. My folders are the same as linked in a previous comment (http://forums.bukkit.org/threads/how-to-improve-mincraft-server-performance.662/) and I can run the bukkit server in ramdisk fine with the script shown on that page.
Will ABM automatically use these directories to locate and backup the worlds?
This is just what i was looking for!
I've installed it, but my "StartUp Time", "Build" and "Plugins" won't show the correct info, they keep on saying Loading...
Am I doing something wrong?
Also my restart wont work.. it shuts down the server, but it wont start again. I have to start it manualy.
Can someone help?
If this could work with the RTK it would be amazing :D
@muggerfugger
You can resume a screen session manually for sure. Going to be a pain in the @$$ to resume 3 different screen sessions and set them up the way abm does. ABM always runs your server in a detached screen session, so that if ABM borks your server doesn't die.
@PierreLouisCraft
Short answer, everything gets funky and can break. People don't always run this script from within the abm dir. So it is easier to use absolute in the event someone executes it from say /
@p000ison
Thanks.
@cheese5505
I've never used remote toolkit, but am willing to take a look.
Is there a way to make this and Remote Toolkit work together? This is amazing, but I need RTK for a plugin.
Awesome! :P
:o How is this in BukkitDev if its not a plugin?
I was wondering, why don't you use relative paths?
I see you find the path to the script with
Just use that to get rid of "$abmdir"?
@btechdog
Set your folder permissions to the user you are running the server as, and try again.
@TnTBass
I found the directory. But it said the permissions were denied. I went and changed it for the folder, but it still wouldn't work.
@btechdog
Sounds like you configured it to use a directory that doesn't exist. Pastebin your abm.conf file (located in the Ascii-Bukkit-Menu\include\config\ directory) please.
When I tried the installation an ran it. The shell gave me two errors: ./install.sh: line 51: cd: /craftbukkit/Ascii-Bukkit-Menu/: No such file or directory ./install.sh: line 52: ./abm.sh: No such file or directory Does ubuntu come with all the things I need to run it could that be the issue. I don't know which items on the list that ubuntu has or not?
@PierreLouisCraft
Its open source. Feel free.
We do love pull requests though. :)