VS Screen Alerts

VS Screen Alerts

A small universal Vintage Story code mod that lets admins send arbitrary text to player's screens, with full control over position, color and font.

Commands (server)

• /screenmsg <seconds> <text...> [style flags] — show to all online players

• /screenmsgp <playername> <seconds> <text...> [style flags] — show to one player

• /screenmsgclear — clear for all

• /screenmsgclearp <playername> — clear for one

Use `\n` for new lines in `<text...>`.

Per-message style flags

Both /screenmsg and /screenmsgp accept optional flags that override the config style for that single message. Flags may appear anywhere among the text words.

• --font / -f <name> — font family (e.g. Verdana); availability depends on client system fonts
• --size / -s <n> — font size (6–200)
• --color / -c <spec> — r,g,b, r,g,b,a, #rrggbb or #rrggbbaa (RGB 0–255, alpha 0–1)
• --align / -a <Area> — on-screen anchor: CenterMiddle, CenterTop, LeftTop, RightBottom, …
• --offset / -o <x,y> — pixel offset from the anchor

Examples:

/screenmsg 10 Restart soon! --color 255,80,80 --align CenterTop
/screenmsgp Alice 8 Welcome! --font Verdana --color #00ff00
/screenmsg 7 Boss spawned! --font Lora --size 40 --offset 0,120

Config

The mod auto-creates a config file on both server and client:

VintagestoryData/ModConfig/vsscreenalerts.json

Default format:

[
  {
    "priority": "server",
    "fontSize": 36,
    "fontName": "",
    "textAlignment": "CenterMiddle",
    "textOffset": [0, -90],
    "textColorRGBA": [255, 255, 255, 1]
  }
]

• priority — "server" (default) use the style received from the server; "client" ignore the server style and use the local config
• fontSize — font size
• fontName — font family; empty = the game's default font
• textAlignment — EnumDialogArea name (anchor point on screen)
• textOffset — [x, y] pixel offset from the anchor
• textColorRGBA — [r, g, b, a]; RGB accepts 0–255 or 0–1, alpha 0–1

The server sends its config style to clients inside every notification packet. Per-message flags only affect the server-side style that is sent.

Contribute

You can access & contribute source code by links on the top of this page. Thank you for choosing and supporting my modification!