Mods / Status Server

Category: #Utility
Author: Nyuhnyash
Side: Server
Created: Mar 15th 2023 at 10:33 PM
Last modified: Sep 25th 2023 at 8:37 PM
Downloads: 589
Follow Unfollow 6

Latest file for v1.20.0-pre:
StatusServer_v1.0.1-compiled.zip 1-click install


Provides game server information via popular Server List Ping protocol

Configure

  1. Install the mod with /moddb install statusserver command
  2. Run the server with mod installed for the first time to generate default config file.
  3. Open TCP port specified in mod config (You can't share the same port with Vintage Story game server).
  4. (Optional) Add server icon (64x64, PNG only) path relative to VintagestoryServer executable (or use absolute path).

Default config file

{
    "Port": 25565,
    "IconFile": "server-icon.png",
    "EnabledExtensions": [ "world" ]
}​

Usage

There are plenty of libraries implementing the protocol: mcstatus, mcutil, etc. More examples.

Ready-to-use services: mcsrvstat.us, mcstatus.io, Telegram bot @msmpbot.

Operate raw json to access non-standard extensions data.

Raw json response
{
    "version": {
        "protocol": 2000,
        "name": "1.18.0-pre.6"
    },
    "players": {
        "max": 16,
        "online": 1,
        "sample": [
            {
                "name": "Nyuhnyash",
                "id": "3e4a67aa-c4f1-f5f7-dffd-37e2fad5f74d"
            }
        ]
    },
    "description": {
        "text": "Vintage Story Server"
    },
    "favicon": "data:image/png;base64,<...>",
// Non-standard extension
    "world": {
        "datetime": "2. May, Year 0, 17:31"
    }
}​

Version For Game version Downloads Release date Changelog Download 1-click mod install*
v1.0.1-dev.0
Various v1.18.x* Various v1.19.x* #v1.20.0-pre
182 Sep 25th 2023 at 8:37 PM Show StatusServer_v1.0.1-compiled.zip Install now
v1.0.1
#v1.15.10 #v1.16.5 Various v1.17.x* Various v1.18.x*
205 Apr 4th 2023 at 9:55 AM Show StatusServer_v1.0.1.zip Install now
v1.0.0
#v1.15.10 Various v1.16.x* Various v1.17.x* #v1.18.0-pre
202 Mar 15th 2023 at 10:51 PM Show StatusServer_v1.0.0.zip Install now

5 Comments (oldest first | newest first)

💬 NyuhnyashAuthor, Oct 1st 2023 at 11:20 PM

Kaofan clientsettings.json generated by VS Server itself, it's fine.

To add icon create 64x64 pixel PNG image, name it server-icon.png and put it in the same directory as VintagestoryServer.

💬 Kaofan, Oct 1st 2023 at 9:56 PM

Nyuhnyash

After entering the command "/moddb install statusserver", a new file called "clientsettings.json" appeared. Is this how it's supposed to be?

 

Edit: And how exactly do I add an icon?

💬 NyuhnyashAuthor, Oct 1st 2023 at 9:01 PM

Kaofan When mod is installed it will listen selected TCP port using Server List Ping protocol. You can then send ping or status request (using any online services or libraries) to [server IP]:[port (from mod config)] and recieve a response.

Example with mcstatus:

PS C:\> mcstatus vs.hardshard.ru:25587 ping
23.39459996437654ms
PS C:\> mcstatus vs.hardshard.ru:25587 status
version: v1.18.13 (protocol 2000)
motd: "Motd(parsed=['[RU] HardShard — Vintage Story: Season One', <Formatting.RESET: 'r'>], raw={'text': '[RU] HardShard — Vintage Story: Season One'}, bedrock=False)"
players: 2/50 ['EastRane (09c8c3be-14a8-0799-31a6-3b82bebb73a2)', 'Gottor (e6b572c3-bf56-a864-22c5-293a9a611649)']

💬 Kaofan, Sep 29th 2023 at 10:51 AM

Nyuhnyash

how exactly this mod works. Because I understand that when entering the command, the mod somehow installs something, but I don't know where the Server status will be shown.

💬 DearFox, Apr 8th 2023 at 8:50 PM

Хаха, это гениально))
Остальсь только реализовать прокси сервер для подключения Minecraft клиента к серверу VintageStory хD

(edit comment delete)