summaryrefslogtreecommitdiff
path: root/docs/misc/mcsrv.md
diff options
context:
space:
mode:
authorilotterytea <iltsu@alright.party>2024-05-19 00:16:04 +0500
committerilotterytea <iltsu@alright.party>2024-05-19 00:16:04 +0500
commitecca9314a53b961f49ae57528e30a3a17f5300dc (patch)
treef99110ad90b9798b873c1c9ea4fdfba7aa45c34d /docs/misc/mcsrv.md
parent21991b1da2bfab5aa266e7ba91527a6ee62a6b99 (diff)
feat: docs
Diffstat (limited to 'docs/misc/mcsrv.md')
-rw-r--r--docs/misc/mcsrv.md38
1 files changed, 38 insertions, 0 deletions
diff --git a/docs/misc/mcsrv.md b/docs/misc/mcsrv.md
new file mode 100644
index 0000000..188ffdf
--- /dev/null
+++ b/docs/misc/mcsrv.md
@@ -0,0 +1,38 @@
+# Minecraft server status check
+
+The `!mcsrv` command allows you to quickly find out the status of Minecraft server.
+This is a handy command that solves the problem of
+logging into Minecraft and waiting for 20 seconds to load to check the server.
+
+## Syntax
+`!mcsrv [address]`
+
++ `[address]` - IP address or name address of the server.
+
+## Usage
+
++ `!mcsrv mc.hypixel.net`
++ `!mcsrv 12.255.56.21`
+
+## Responses
+
++ `✅ hypixel.net (209.222.114.115) | 36911/200000 | Hypixel Network [1.8-1.20]; HOLIDAYS EVENT | TRIPLE COINS AND EXP | 1.8.9`
++ `⛔ 12.255.56.21 (127.0.0.1)`
+
+## The meanings of the parts of the message *(separated by |)*
+
++ Alphabetic and numeric IP addresses.
++ The number of people playing at the moment and the maximum number of players.
++ The MOTD of the server. Separated by **;** *(semicolon)*.
++ Server version.
+
+
+## Important notes
+
++ The server status is taken from the third-party API ["mcsrvstat.us"](https://mcsrvstat.us).
+
+## Error handling
+
++ [Not enough arguments](/wiki/errors#0)
++ [Not found](/wiki/errors#12)
++ [Something went wrong](/wiki/errors#127)