diff options
| author | ilotterytea <iltsu@alright.party> | 2024-05-19 00:16:04 +0500 |
|---|---|---|
| committer | ilotterytea <iltsu@alright.party> | 2024-05-19 00:16:04 +0500 |
| commit | ecca9314a53b961f49ae57528e30a3a17f5300dc (patch) | |
| tree | f99110ad90b9798b873c1c9ea4fdfba7aa45c34d /docs/misc | |
| parent | 21991b1da2bfab5aa266e7ba91527a6ee62a6b99 (diff) | |
feat: docs
Diffstat (limited to 'docs/misc')
| -rw-r--r-- | docs/misc/holiday.md | 37 | ||||
| -rw-r--r-- | docs/misc/mcsrv.md | 38 | ||||
| -rw-r--r-- | docs/misc/ping.md | 8 |
3 files changed, 83 insertions, 0 deletions
diff --git a/docs/misc/holiday.md b/docs/misc/holiday.md new file mode 100644 index 0000000..90297c8 --- /dev/null +++ b/docs/misc/holiday.md @@ -0,0 +1,37 @@ +# Holiday + +The `!holiday` command allows you to get information about today's and upcoming holidays. + + +> **So far, only Russian holidays and in Russian.** + + +## Syntax + +`!holiday [date]` + ++ `[date]` (Optional) - The date on which you want to get a random holiday. +If it's not specified, today's date will be used. + +## Usage + ++ `!holiday` - Get today's random holiday. ++ `!holiday 25.02` - Get a random holiday on February 25th. ++ `!holiday 25` - Get a random holiday on the 25th of this month. ++ `!holiday .02` - Get a random holiday for today's date in February *(e.g. if today is the 1st, then it's February 1st)*. ++ `!holiday yesterday` - Get yesterday's random holiday. ++ `!holiday tommorow` - Get tommorow's random holiday. + +## Response + ++ `Holiday for 25.02 (3/8): День открытия спирта` + +## Important notes + ++ The information is obtained from the third-party service ["ilotterytea/holidays"](https://hol.ilotterytea.kz) + +## Error handling + ++ [Incorrect argument](/wiki/errors#3) ++ [External API error](/wiki/errors#20) ++ [Something went wrong](/wiki/errors#127) 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) diff --git a/docs/misc/ping.md b/docs/misc/ping.md new file mode 100644 index 0000000..f36c9d0 --- /dev/null +++ b/docs/misc/ping.md @@ -0,0 +1,8 @@ +# Ping! +The `!ping` command checks to see if it's alive and gives a bunch of other data like memory usage, compiler version, etc. + +## Syntax ++ `!ping` + +## Responses ++ `funnywhitecat C++17 (gcc ) · Uptime: 24d23h · Memory usage: 18MB` |
