Skip to content

Commit 9fe776a

Browse files
authored
docs: make Asciinema demos agnostic to PaperMC version (#377)
In order to avoid giving the feeling of outdated or poorly maintained project when that's not the case.
1 parent cd2ae2e commit 9fe776a

6 files changed

Lines changed: 13 additions & 13 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Available in [Docker Hub](https://hub.docker.com/r/djaytan/papermc-server).
1919
## 💻 Demonstration (20 seconds)
2020

2121
<div align="center">
22-
<a href="https://asciinema.org/a/725450?autoplay=1" target="_blank"><img src="https://github.com/Djaytan/docker-papermc-server/blob/main/docs/asciinema/demo.gif" alt="asciicast"></a>
22+
<a href="https://asciinema.org/a/788324?autoplay=1" target="_blank"><img src="https://github.com/Djaytan/docker-papermc-server/blob/main/docs/asciinema/demo.gif" alt="asciicast"></a>
2323
</div>
2424

2525
## 📘 Usage

docs/asciinema/README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ Make sure the following tools are installed:
99
- 📼 [asciinema CLI](https://asciinema.org/docs/installation) – used to record terminal sessions
1010
- 🖼️ [agg CLI](https://docs.asciinema.org/manual/agg/installation/) – used to convert recordings into GIFs
1111

12+
⚠️ `asciinema` cannot run in Git Bash on Windows it seems (missing POSIX dependencies such as fcntl). The CLI is therefore better executed via WSL.
13+
1214
## 📝 Format
1315

1416
Recordings use the [Asciicast v2 format](https://docs.asciinema.org/manual/asciicast/v2/).
@@ -23,7 +25,13 @@ This can be done by running the following commands:
2325
$ asciinema auth
2426
```
2527

26-
## 🧰 Generating a GIF
28+
Then:
29+
30+
```bash
31+
$ asciinema upload demo.cast
32+
```
33+
34+
## 🧰 Generating a GIF
2735

2836
To generate a GIF from a recording, refer to the [official guide](https://docs.asciinema.org/getting-started/#generating-a-gif).
2937

docs/asciinema/demo-gif.cast

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -85,12 +85,8 @@
8585
[5.000, "o", "✅ Configuration files successfully generated!\r\n"]
8686
[5.100, "o", "✨ PaperMC server ready to start!\r\n"]
8787
[10.000, "m", "Starting"]
88-
[10.000, "o", "Downloading mojang_1.21.4.jar\r\n"]
8988
[10.500, "o", "Applying patches\r\n"]
90-
[11.000, "o", "Starting org.bukkit.craftbukkit.Main\r\n"]
91-
[11.500, "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"]
92-
[11.600, "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"]
93-
[12.000, "o", "[14:54:35 INFO]: <snip>\r\n"]
89+
[10.750, "o", "[14:54:35 INFO]: <snip>\r\n"]
9490
[12.500, "o", "[14:54:42 INFO]: Preparing level \"world\"\r\n"]
9591
[12.550, "o", "[14:54:45 INFO]: Preparing start region for dimension minecraft:overworld\r\n"]
9692
[12.600, "o", "[14:54:45 INFO]: Preparing spawn area: 2%\r\n"]

docs/asciinema/demo.cast

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -85,12 +85,8 @@
8585
[5.000, "o", "✅ Configuration files successfully generated!\r\n"]
8686
[5.100, "o", "✨ PaperMC server ready to start!\r\n"]
8787
[10.000, "m", "Starting"]
88-
[10.000, "o", "Downloading mojang_1.21.4.jar\r\n"]
8988
[10.500, "o", "Applying patches\r\n"]
90-
[11.000, "o", "Starting org.bukkit.craftbukkit.Main\r\n"]
91-
[11.500, "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"]
92-
[11.600, "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"]
93-
[12.000, "o", "[14:54:35 INFO]: <snip>\r\n"]
89+
[10.750, "o", "[14:54:35 INFO]: <snip>\r\n"]
9490
[12.500, "o", "[14:54:42 INFO]: Preparing level \"world\"\r\n"]
9591
[12.550, "o", "[14:54:45 INFO]: Preparing start region for dimension minecraft:overworld\r\n"]
9692
[12.600, "o", "[14:54:45 INFO]: Preparing spawn area: 2%\r\n"]

docs/asciinema/demo.gif

-151 KB
Loading

docs/user-guide/src/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ A general-purpose, OCI-compliant PaperMC server with streamlined and fine-graine
44

55
## 💻 Demonstration (20 seconds)
66

7-
<script src="https://asciinema.org/a/725450.js" id="asciicast-725450" async></script>
7+
<script src="https://asciinema.org/a/788324.js" id="asciicast-788324" async></script>
88

99
## ✨ Highlights
1010

0 commit comments

Comments
 (0)