Skip to content
This repository has been archived by the owner on Aug 12, 2024. It is now read-only.

Latest commit

 

History

History
162 lines (108 loc) · 6.24 KB

README.md

File metadata and controls

162 lines (108 loc) · 6.24 KB
Raw

Dockercraft

Dockercraft

A simple Minecraft Docker client, to visualize and manage Docker containers.

Dockercraft

YouTube video

WARNING: Please use Dockercraft on your local machine only. It currently doesn't support authentication. Every player should be considered a root user!

How to run Dockercraft

  1. Install Minecraft: minecraft.net

    The Minecraft client hasn't been modified, just get the official release.

  2. Pull or build Dockercraft image: (an official image will be available soon)

    docker pull gaetan/dockercraft

    or

    git clone git@github.com:docker/dockercraft.git
docker build -t gaetan/dockercraft dockercraft

  3. Run Dockercraft container:

    docker run -t -i -d -p 25565:25565 \
-v /var/run/docker.sock:/var/run/docker.sock \
--name dockercraft \
gaetan/dockercraft

    Mounting /var/run/docker.sock inside the container is necessary to send requests to the Docker remote API.

    The default port for a Minecraft server is 25565, if you prefer a different one: -p <port>:25565

  4. Open Minecraft > Multiplayer > Add Server

    The server address is the IP of Docker host. No need to specify a port if you used the default one.

    If you're using Docker Machine: docker-machine ip <machine_name>

  5. Join Server!

    You should see at least one container in your world, which is the one hosting your Dockercraft server.

    You can start, stop and remove containers interacting with levers and buttons. Some Docker commands are also supported directly via Minecraft's chat window, which is displayed by pressing the T key (default) or / key.

A command always starts with a /.

If you open the prompt using the / key, it will be prefilled with a / character, but if you open it with the T key, it will not be prefilled and you will have to type a / yourself before typing your docker command.

example: /docker run redis.

Dockercraft

Customizing Dockercraft

Do you find the plains too plain? If so, you are in luck!

Dockercraft can be customised to use any of the Biomes and Finishers supported by Cuberite!

You can pass these additional arguments to your docker run command:

docker run -t -i -d -p 25565:25565 \
    -v /var/run/docker.sock:/var/run/docker.sock \
    --name dockercraft \
    gaetan/dockercraft <biome> <groundlevel> <sealevel> <finishers>

Here are some examples:

Do you long for the calm of the oceans? oceans

Try Ocean 50 63, or for a more frozen alternative, FrozenOcean 50 63 Ice

Or perhaps the heat of the desert? desert

Then Desert 63 0 DeadBushes is what you need

Are you pining for the... Pines? forest We have you covered. Try Forest 63 0 Trees

Or maybe you are looking for fun and games? jungle If so, Welcome to the Jungle. Jungle 63 0 Trees

Upcoming features

This is just the beginning for Dockercraft! We should be able to support a lot more Docker features like:

  • List Docker Machines and use portals to see what's inside
  • Support more Docker commands
  • Display logs (for each container, pushing a simple button)
  • Represent links
  • Docker networking
  • Docker volumes
  • ...

If you're interested about Dockercraft's design, discussions happen in that issue. Also, we're using Magicavoxel to do these nice prototypes:

Dockercraft

You can find our Magicavoxel patterns in that folder.

To get fresh news, follow our Twitter account: @dockercraft.

How it works

The Minecraft client itself remains unmodified. All operations are done server side.

The Minecraft server we use is http://cuberite.org. A custom Minecraft compatible game server written in C++. github repo

This server accepts plugins, scripts written in Lua. So we did one for Docker. (world/Plugins/Docker)

Unfortunately, there's no nice API to communicate with these plugins. But there's a webadmin, and plugins can be responsible for "webtabs".

Plugin:AddWebTab("Docker",HandleRequest_Docker)

Basically it means the plugin can catch POST requests sent to http://127.0.0.1:8080/webadmin/Docker/Docker.

Goproxy

Events from the Docker remote API are transmitted to the Lua plugin by a small daemon (written in Go). (go/src/goproxy)

func MCServerRequest(data url.Values, client *http.Client) {
	req, _ := http.NewRequest("POST", "http://127.0.0.1:8080/webadmin/Docker/Docker", strings.NewReader(data.Encode()))
	req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
	req.SetBasicAuth("admin", "admin")
	client.Do(req)
}

The goproxy binary can also be executed with parameters from the Lua plugin, to send requests to the daemon:

function PlayerJoined(Player)
	-- refresh containers
	r = os.execute("goproxy containers")
end

Contributing

Want to hack on Dockercraft? Docker's contributions guidelines apply.

Dockercraft