craftmin/README.md
2014-07-22 18:00:32 +02:00

50 lines
1.3 KiB
Markdown

# Craftmin
A collection of scripts to configure and manage a CraftBukkit Minecraft server.
### Files
| Filename | Description |
| ------------------ | ----------------------------- |
| `craftbukkit.sh` | Init script |
| `craftmin.sh` | CraftBukkit management script |
| `craftbukkit.conf` | Configuration file |
| `bukkit-log.xml` | Server log configuration |
### Requirements
- tmux
- sysvinit (systemd is currently not supported)
- sudo
### Setup
1. Edit `craftbukkit.conf` to your liking
2. Install the init script:
mv craftbukkit.sh /etc/init.d/craftbukkit
chmod 755 /etc/init.d/craftbukkit
update-rc.d craftbukkit defaults
3. Install `craftmin.sh`:
mv craftmin.sh /usr/local/bin/craftmin
chmod 755 /usr/local/bin/craftmin
4. Move the configuration file in place:
mv config /etc/craftbukkit.conf
### Usage
craftmin {console|backup|full-backup|wl-add|wl-rm}
#### Command description:
- **console**: Connects to the tmux console
- **backup**: Creates a world backup
- **full-backup**: Creates a full backup
- **wl-add [USER]**: Adds [USER] to the whitelist
- **wl-rm [USER]** Removes [USER] from the whitelist
- **--help**, **-h**: Shows a short help message