Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/docker/dockercraft
Docker + Minecraft = Dockercraft
https://github.com/docker/dockercraft
Last synced: about 2 months ago
JSON representation
Docker + Minecraft = Dockercraft
- Host: GitHub
- URL: https://github.com/docker/dockercraft
- Owner: docker
- License: apache-2.0
- Created: 2015-06-26T23:51:50.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2021-06-15T14:24:53.000Z (over 3 years ago)
- Last Synced: 2024-06-18T18:32:39.159Z (3 months ago)
- Language: Lua
- Size: 46.6 MB
- Stars: 7,150
- Watchers: 229
- Forks: 391
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- stars - docker/dockercraft
- awesome-docker - dockercraft - Docker + Minecraft = Dockercraft by [@docker][docker] (Container Operations / User Interface)
- awesome-docker - dockercraft - Docker + Minecraft = Dockercraft by [@docker][docker] (Container Operations / User Interface)
README
# Dockercraft
A simple Minecraft Docker client, to visualize and manage Docker containers.
[YouTube video](http://www.youtube.com/watch?v=eZDlJgJf55o)
> 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](https://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 [email protected]: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 :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](https://docs.docker.com/machine/install-machine/): `docker-machine ip `
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`.
## 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](https://github.com/cuberite/cuberite/blob/7f8a4eb7264a12ca2035b4e4d412485e01f309d4/src/BiomeDef.cpp#L17) and [Finishers](https://github.com/cuberite/cuberite/blob/7f8a4eb7264a12ca2035b4e4d412485e01f309d4/src/Generating/ComposableGenerator.cpp#L299) 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
```
Here are some examples:
**Do you long for the calm of the oceans?**
Try `Ocean 50 63`, or for a more frozen alternative, `FrozenOcean 50 63 Ice`
**Or perhaps the heat of the desert?**
Then `Desert 63 0 DeadBushes` is what you need
**Are you pining for the... Pines?**
We have you covered. Try `Forest 63 0 Trees`
**Or maybe you are looking for fun and games?**
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](https://docs.docker.com/machine/) and use portals to see what's inside
- Support more Docker commands
- Display [logs](https://docs.docker.com/v1.8/reference/commandline/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](https://github.com/docker/dockercraft/issues/19).
Also, we're using [Magicavoxel](https://ephtracy.github.io/) to do these nice prototypes:
You can find our Magicavoxel patterns in [that folder]().
To get fresh news, follow our Twitter account: [@dockercraft](https://twitter.com/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](http://cuberite.org). A custom Minecraft compatible game server written in C++. [github repo](https://github.com/cuberite/cuberite)
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".
```lua
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)
```go
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:
```lua
function PlayerJoined(Player)
-- refresh containers
r = os.execute("goproxy containers")
end
```
## Contributing
Want to hack on Dockercraft? [Docker's contributions guidelines](https://github.com/docker/docker/blob/master/CONTRIBUTING.md) apply.
