Skip to content
This repository was archived by the owner on Jul 18, 2025. It is now read-only.

Commit 499bb4a

Browse files
author
Dave Tucker
committed
Update README with customizations!
Signed-off-by: Dave Tucker <dt@docker.com>
1 parent 7b1752f commit 499bb4a

File tree

5 files changed

+35
-0
lines changed

5 files changed

+35
-0
lines changed

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,41 @@ A simple Minecraft Docker client, to visualize and manage Docker containers.
6262
6363
![Dockercraft](https://github.com/docker/dockercraft/raw/master/docs/img/landscape.png?raw=true)
6464

65+
## Customizing Dockercraft
66+
67+
Do you find the plains too plain?
68+
If so, you are in luck!
69+
70+
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!
71+
72+
You can pass these additional arguments to your `docker run` command:
73+
```
74+
docker run -t -i -d -p 25565:25565 \
75+
-v /var/run/docker.sock:/var/run/docker.sock \
76+
--name dockercraft \
77+
gaetan/dockercraft <biome> <groundlevel> <sealevel> <finishers>
78+
```
79+
80+
Here are some examples:
81+
82+
**Do you long for the calm of the oceans?**
83+
![oceans](https://github.com/docker/dockercraft/raw/master/docs/img/ocean.png?raw=true)
84+
85+
Try `Ocean 50 63`, or for a more frozen alternative, `FrozenOcean 50 63 Ice`
86+
87+
**Or perhaps the heat of the desert?**
88+
![desert](https://github.com/docker/dockercraft/raw/master/docs/img/desert.png?raw=true)
89+
90+
Then `Desert 63 0 DeadBushes` is what you need
91+
92+
**Are you pining for the... Pines?**
93+
![forest](https://github.com/docker/dockercraft/raw/master/docs/img/forest.png?raw=true)
94+
We have you covered. Try `Forest 63 0 Trees`
95+
96+
**Or maybe you are looking for fun and games?**
97+
![jungle](https://github.com/docker/dockercraft/raw/master/docs/img/jungle.png?raw=true)
98+
If so, Welcome to the Jungle. `Jungle 63 0 Trees`
99+
65100
## Upcoming features
66101

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

docs/img/desert.png

359 KB
Loading

docs/img/forest.png

597 KB
Loading

docs/img/jungle.png

661 KB
Loading

docs/img/ocean.png

339 KB
Loading

0 commit comments

Comments
 (0)