Skip to content

Commit 4375d11

Browse files
DjaytanDjaytan
authored
docs: add a demonstration made with Asciinema (#230)
1 parent ffd23b4 commit 4375d11

4 files changed

Lines changed: 230 additions & 0 deletions

File tree

‎docs/asciinema/demo-gif.cast‎

Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
{"version": 2, "width": 80, "height": 18, "timestamp": 1749308065, "title": "Docker PaperMC Server - Demo", "env": {"SHELL": "/bin/bash", "TERM": "xterm-256color"}}
2+
[0.000, "o", "$ "]
3+
[0.050, "o", "d"]
4+
[0.100, "o", "o"]
5+
[0.150, "o", "c"]
6+
[0.200, "o", "k"]
7+
[0.250, "o", "e"]
8+
[0.300, "o", "r"]
9+
[0.350, "o", " "]
10+
[0.400, "o", "r"]
11+
[0.450, "o", "u"]
12+
[0.500, "o", "n"]
13+
[0.550, "o", " "]
14+
[0.600, "o", "-"]
15+
[0.650, "o", "i"]
16+
[0.700, "o", "t"]
17+
[0.750, "o", " "]
18+
[0.800, "o", "-"]
19+
[0.850, "o", "-"]
20+
[0.900, "o", "r"]
21+
[0.950, "o", "m"]
22+
[1.000, "o", " "]
23+
[1.050, "o", "-"]
24+
[1.100, "o", "p"]
25+
[1.150, "o", " "]
26+
[1.200, "o", "2"]
27+
[1.250, "o", "5"]
28+
[1.300, "o", "5"]
29+
[1.350, "o", "6"]
30+
[1.400, "o", "5"]
31+
[1.450, "o", ":"]
32+
[1.500, "o", "2"]
33+
[1.550, "o", "5"]
34+
[1.600, "o", "5"]
35+
[1.650, "o", "6"]
36+
[1.700, "o", "5"]
37+
[1.750, "o", " "]
38+
[1.800, "o", "-"]
39+
[1.850, "o", "e"]
40+
[1.900, "o", "u"]
41+
[1.950, "o", "l"]
42+
[2.000, "o", "a"]
43+
[2.050, "o", "="]
44+
[2.100, "o", "t"]
45+
[2.150, "o", "r"]
46+
[2.200, "o", "u"]
47+
[2.250, "o", "e"]
48+
[2.300, "o", " "]
49+
[2.350, "o", "d"]
50+
[2.400, "o", "j"]
51+
[2.450, "o", "a"]
52+
[2.500, "o", "y"]
53+
[2.550, "o", "t"]
54+
[2.600, "o", "a"]
55+
[2.650, "o", "n"]
56+
[2.700, "o", "/"]
57+
[2.750, "o", "p"]
58+
[2.800, "o", "a"]
59+
[2.850, "o", "p"]
60+
[2.900, "o", "e"]
61+
[2.950, "o", "r"]
62+
[3.000, "o", "m"]
63+
[3.050, "o", "c"]
64+
[3.100, "o", "-"]
65+
[3.150, "o", "s"]
66+
[3.200, "o", "e"]
67+
[3.250, "o", "r"]
68+
[3.300, "o", "v"]
69+
[3.350, "o", "e"]
70+
[3.400, "o", "r"]
71+
[3.450, "o", ":"]
72+
[3.500, "o", "l"]
73+
[3.550, "o", "a"]
74+
[3.600, "o", "t"]
75+
[3.650, "o", "e"]
76+
[3.700, "o", "s"]
77+
[3.750, "o", "t"]
78+
[3.750, "m", "Preparation"]
79+
[3.800, "o", "\r\n"]
80+
[4.000, "o", "⚙️ Preparing PaperMC server configuration files...\r\n"]
81+
[4.250, "o", "🧾 File eula.txt processed\r\n"]
82+
[4.400, "o", "🔍 No custom YAML overrides configuration files found in /opt/papermc/config/overrides.\r\n"]
83+
[4.500, "o", "📦 Generating configuration files...\r\n"]
84+
[5.000, "o", "✅ Configuration files successfully generated!\r\n"]
85+
[5.100, "o", "✨ PaperMC server ready to start!\r\n"]
86+
[5.100, "m", "Starting"]
87+
[5.500, "o", "Downloading mojang_1.21.4.jar\r\n"]
88+
[6.000, "o", "Applying patches\r\n"]
89+
[6.500, "o", "Starting org.bukkit.craftbukkit.Main\r\n"]
90+
[7.000, "o", "[14:54:34 INFO]: [bootstrap] Running Java 21 (OpenJDK 64-Bit Server VM 21.0.7+6-LTS; Eclipse Adoptium Temurin-21.0.7+6) on Linux 5.15.153.1 (amd64)\r\n"]
91+
[7.100, "o", "[14:54:34 INFO]: [bootstrap] Loading Paper 1.21.4-231-ver/1.21.4@09e9afd (2025-05-19T17:59:36Z) for Minecraft 1.21.4\r\n"]
92+
[7.500, "o", "[14:54:35 INFO]: <snip>\r\n"]
93+
[8.000, "o", "[14:54:42 INFO]: Preparing level \"world\"\r\n"]
94+
[8.050, "o", "[14:54:45 INFO]: Preparing start region for dimension minecraft:overworld\r\n"]
95+
[8.100, "o", "[14:54:45 INFO]: Preparing spawn area: 2%\r\n"]
96+
[8.225, "o", "[14:54:45 INFO]: Preparing spawn area: 2%\r\n"]
97+
[8.350, "o", "[14:54:46 INFO]: Preparing spawn area: 4%\r\n"]
98+
[8.475, "o", "[14:54:47 INFO]: Preparing spawn area: 85%\r\n"]
99+
[8.500, "o", "[14:54:47 INFO]: Time elapsed: 1558 ms\r\n"]
100+
[8.550, "o", "[14:54:47 INFO]: Preparing start region for dimension minecraft:the_nether\r\n"]
101+
[8.650, "o", "[14:54:47 INFO]: Preparing spawn area: 2%\r\n"]
102+
[8.750, "o", "[14:54:47 INFO]: Time elapsed: 419 ms\r\n"]
103+
[8.800, "o", "[14:54:47 INFO]: Preparing start region for dimension minecraft:the_end\r\n"]
104+
[8.900, "o", "[14:54:47 INFO]: Preparing spawn area: 2%\r\n"]
105+
[8.950, "o", "[14:54:47 INFO]: Time elapsed: 150 ms\r\n"]
106+
[9.000, "o", "[14:54:47 INFO]: Done preparing level \"world\" (5.232s)\r\n"]
107+
[9.100, "o", "[14:54:47 INFO]: Running delayed init tasks\r\n"]
108+
[9.100, "m", "Running"]
109+
[9.250, "o", "[14:54:47 INFO]: Done (14.264s)! For help, type \"help\"\r\n"]
110+
[11.000, "o", "[14:54:50 INFO]: UUID of player Djaytan is ce4c87ff-d276-443a-a4a1-510839b7ff02\r\n"]
111+
[11.500, "o", "[14:54:50 INFO]: \u001b[93mDjaytan joined the game\u001b[0m\r\n"]
112+
[11.550, "o", "[14:54:50 INFO]: Djaytan[/0.0.0.0:47164] logged in with entity id 37 at ([world]-508.5, 99.0, -129.5)\r\n"]
113+
[12.000, "o", "[14:54:54 INFO]: <Djaytan> Hello there!"]

‎docs/asciinema/demo.cast‎

Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
{"version": 2, "width": 80, "height": 18, "timestamp": 1749308065, "title": "Docker PaperMC Server - Demo", "env": {"SHELL": "/bin/bash", "TERM": "xterm-256color"}}
2+
[0.000, "o", "$ "]
3+
[0.050, "o", "d"]
4+
[0.100, "o", "o"]
5+
[0.150, "o", "c"]
6+
[0.200, "o", "k"]
7+
[0.250, "o", "e"]
8+
[0.300, "o", "r"]
9+
[0.350, "o", " "]
10+
[0.400, "o", "r"]
11+
[0.450, "o", "u"]
12+
[0.500, "o", "n"]
13+
[0.550, "o", " "]
14+
[0.600, "o", "-"]
15+
[0.650, "o", "i"]
16+
[0.700, "o", "t"]
17+
[0.750, "o", " "]
18+
[0.800, "o", "-"]
19+
[0.850, "o", "-"]
20+
[0.900, "o", "r"]
21+
[0.950, "o", "m"]
22+
[1.000, "o", " "]
23+
[1.050, "o", "-"]
24+
[1.100, "o", "p"]
25+
[1.150, "o", " "]
26+
[1.200, "o", "2"]
27+
[1.250, "o", "5"]
28+
[1.300, "o", "5"]
29+
[1.350, "o", "6"]
30+
[1.400, "o", "5"]
31+
[1.450, "o", ":"]
32+
[1.500, "o", "2"]
33+
[1.550, "o", "5"]
34+
[1.600, "o", "5"]
35+
[1.650, "o", "6"]
36+
[1.700, "o", "5"]
37+
[1.750, "o", " "]
38+
[1.800, "o", "-"]
39+
[1.850, "o", "e"]
40+
[1.900, "o", "u"]
41+
[1.950, "o", "l"]
42+
[2.000, "o", "a"]
43+
[2.050, "o", "="]
44+
[2.100, "o", "t"]
45+
[2.150, "o", "r"]
46+
[2.200, "o", "u"]
47+
[2.250, "o", "e"]
48+
[2.300, "o", " "]
49+
[2.350, "o", "d"]
50+
[2.400, "o", "j"]
51+
[2.450, "o", "a"]
52+
[2.500, "o", "y"]
53+
[2.550, "o", "t"]
54+
[2.600, "o", "a"]
55+
[2.650, "o", "n"]
56+
[2.700, "o", "/"]
57+
[2.750, "o", "p"]
58+
[2.800, "o", "a"]
59+
[2.850, "o", "p"]
60+
[2.900, "o", "e"]
61+
[2.950, "o", "r"]
62+
[3.000, "o", "m"]
63+
[3.050, "o", "c"]
64+
[3.100, "o", "-"]
65+
[3.150, "o", "s"]
66+
[3.200, "o", "e"]
67+
[3.250, "o", "r"]
68+
[3.300, "o", "v"]
69+
[3.350, "o", "e"]
70+
[3.400, "o", "r"]
71+
[3.450, "o", ":"]
72+
[3.500, "o", "l"]
73+
[3.550, "o", "a"]
74+
[3.600, "o", "t"]
75+
[3.650, "o", "e"]
76+
[3.700, "o", "s"]
77+
[3.750, "o", "t"]
78+
[3.750, "m", "Preparation"]
79+
[3.800, "o", "\r\n"]
80+
[4.000, "o", "⚙️ Preparing PaperMC server configuration files...\r\n"]
81+
[4.250, "o", "🧾 File eula.txt processed\r\n"]
82+
[4.400, "o", "ℹ️ No custom YAML overrides configuration files found in /opt/papermc/config/overrides.\r\n"]
83+
[4.500, "o", "📦 Generating configuration files...\r\n"]
84+
[5.000, "o", "✅ Configuration files successfully generated!\r\n"]
85+
[5.100, "o", "✨ PaperMC server ready to start!\r\n"]
86+
[5.100, "m", "Starting"]
87+
[5.500, "o", "Downloading mojang_1.21.4.jar\r\n"]
88+
[6.000, "o", "Applying patches\r\n"]
89+
[6.500, "o", "Starting org.bukkit.craftbukkit.Main\r\n"]
90+
[7.000, "o", "[14:54:34 INFO]: [bootstrap] Running Java 21 (OpenJDK 64-Bit Server VM 21.0.7+6-LTS; Eclipse Adoptium Temurin-21.0.7+6) on Linux 5.15.153.1 (amd64)\r\n"]
91+
[7.100, "o", "[14:54:34 INFO]: [bootstrap] Loading Paper 1.21.4-231-ver/1.21.4@09e9afd (2025-05-19T17:59:36Z) for Minecraft 1.21.4\r\n"]
92+
[7.500, "o", "[14:54:35 INFO]: <snip>\r\n"]
93+
[8.000, "o", "[14:54:42 INFO]: Preparing level \"world\"\r\n"]
94+
[8.050, "o", "[14:54:45 INFO]: Preparing start region for dimension minecraft:overworld\r\n"]
95+
[8.100, "o", "[14:54:45 INFO]: Preparing spawn area: 2%\r\n"]
96+
[8.225, "o", "[14:54:45 INFO]: Preparing spawn area: 2%\r\n"]
97+
[8.350, "o", "[14:54:46 INFO]: Preparing spawn area: 4%\r\n"]
98+
[8.475, "o", "[14:54:47 INFO]: Preparing spawn area: 85%\r\n"]
99+
[8.500, "o", "[14:54:47 INFO]: Time elapsed: 1558 ms\r\n"]
100+
[8.550, "o", "[14:54:47 INFO]: Preparing start region for dimension minecraft:the_nether\r\n"]
101+
[8.650, "o", "[14:54:47 INFO]: Preparing spawn area: 2%\r\n"]
102+
[8.750, "o", "[14:54:47 INFO]: Time elapsed: 419 ms\r\n"]
103+
[8.800, "o", "[14:54:47 INFO]: Preparing start region for dimension minecraft:the_end\r\n"]
104+
[8.900, "o", "[14:54:47 INFO]: Preparing spawn area: 2%\r\n"]
105+
[8.950, "o", "[14:54:47 INFO]: Time elapsed: 150 ms\r\n"]
106+
[9.000, "o", "[14:54:47 INFO]: Done preparing level \"world\" (5.232s)\r\n"]
107+
[9.100, "o", "[14:54:47 INFO]: Running delayed init tasks\r\n"]
108+
[9.100, "m", "Running"]
109+
[9.250, "o", "[14:54:47 INFO]: Done (14.264s)! For help, type \"help\"\r\n"]
110+
[11.000, "o", "[14:54:50 INFO]: UUID of player Djaytan is ce4c87ff-d276-443a-a4a1-510839b7ff02\r\n"]
111+
[11.500, "o", "[14:54:50 INFO]: \u001b[93mDjaytan joined the game\u001b[0m\r\n"]
112+
[11.550, "o", "[14:54:50 INFO]: Djaytan[/0.0.0.0:47164] logged in with entity id 37 at ([world]-508.5, 99.0, -129.5)\r\n"]
113+
[12.000, "o", "[14:54:54 INFO]: <Djaytan> Hello there!"]

‎docs/asciinema/demo.gif‎

418 KB
Loading

‎docs/user-guide/src/index.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
A general-purpose, OCI-compliant PaperMC server with streamlined and fine-grained customization options.
44

5+
## 💻 Demonstration (12 seconds)
6+
7+
<script src="https://asciinema.org/a/722427.js" id="asciicast-722427" async></script>
8+
59
## ✨ Highlights
610

711
* 🏔️ **[Alpine](https://hub.docker.com/_/alpine)-based image**

0 commit comments

Comments
 (0)