penguincoder
/
vagrant-minecraft
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

update docs

master
Andrew Coleman 2017-06-12 16:34:40 -04:00
parent 5cd7dc3612
commit eab4320ac2
1 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -6,6 +6,8 @@ There are simple servers for most Unix and Windows operating systems, sure, but
This is also helpful to give to your buddies so they can run their own local server, or it's very handy for a LAN party.
This stack uses the vanilla Minecraft server, Minecraft Overviewer set to the leaflet development branch, and caddy to serve static HTML files.
## How?
* Install [Vagrant](http://vagrantup.com)
@ -13,9 +15,20 @@ This is also helpful to give to your buddies so they can run their own local ser
* Clone this repo
* `vagrant up`
## Alternative How?
If you want to run this stack directly, without the use of a VM, the process is painless. You do need a few things installed, but the list of required items is quite short. You need an 'ecosystem' directory (just a place to put the server and the overviewer). For instance, this might be `/home/notch/mcserver`. It is not likely to be the Vagrant default, so be sure and set this variable!
* Install [Docker](http://docker.com)
* Ensure GNU Make is installed (specific to your operating system)
* `export MC_HOME=/path/to/minecraft/ecosystem` somewhere, probably in your `~/.bashrc`
* `cd vagrant-minecraft && ./provision.sh`
Once the ecosystem is up and running (check with `docker ps`), you can remove and restart individual components by `cd`ing into the directory and then running `make clean && make` for the minecraft server, overviewer, and caddy.
## What this provides
This repository gives you access to a fresh-built VM hosting the newest version of vanilla Minecraft. It runs the server out of memory and will periodically write new changes to disk. It supports log rotation and daily backups of the server. It also generates a Google Map of your world and keeps it up to date daily. There is nothing for you to do or configure. It Just Works(TM).
This repository gives you access to a fresh-built VM hosting the newest version of vanilla Minecraft. It also generates a map of your world and keeps it up to date daily. There is nothing for you to do or configure. It Just Works(TM).
### From your machine