diff --git a/README.md b/README.md new file mode 100644 index 0000000..da21686 --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# Craftmin + +A collection of script to configure and manage a CraftBukkit Minecraft server. + +### Files + +| Filename | Description | +| ---------------- | ---------------------------- | +| `craftbukkit.sh` | Init script | +| `bukkit-log.xml` | Server log configuration | +| `craftmin.sh` | CraftBukkit management script| + +### Features + +TBC + +### Requirements + +- tmux +- sysvinit (systemd is currently not supported) + +### Setup + +1. Edit the configuration to your linking +2. Install the init script: + + mv craftbukkit.sh /etc/init.d/craftbukkit + chmod 755 /etc/init.d/craftbukkit + update-rc.d craftbukkit defaults