Back to mods

Vintage Story Mod DB · Vintage Story mod

WelcomeScreen

Are you running a VS Server and with for more options that the welcome chat message? Have a look Features • Auto-open on join dialog appears when a player connects • Markdown content write `welcome.md` in the server data directory, rendered as rich text (he

Choose a version Pick your version below, then grab the matching file.

Quick answer

Which WelcomeScreen release should I use?

Updated 7 months ago
Latest stable file 1.1.0
Game version 1.21.6
Loader Built-in Vintage Story mod system

WelcomeScreen 1.1.0 targets 1.21.6. It must be installed on the client. Installation on the dedicated server is optional. No extra mods listed for this file.

Where it goes

Is WelcomeScreen required on the client, server, or both?

It must be installed on the client. Installation on the dedicated server is optional.

Client Required
Dedicated server Optional
Loader for this release Built-in Vintage Story mod system
Required install it here Optional supported, not mandatory Not supported do not install here Source doesn’t say do not assume

This release supports both sides, but the source does not require it on the server.

What else does WelcomeScreen 1.1.0 need?

1.1.0. Change the file and its required mods may change too.

No extra mods listed for this file

This file does not list any required mods. Do not add a library just because a different file uses it.

This file does not list any required or optional mods.

Before you install it

Add WelcomeScreen without breaking your instance.

Built for WelcomeScreen 1.1.0. Pick another file and the loader, install side or required mods may change.

  1. 01

    Stick to this file

    Use 1.1.0. It targets 1.21.6; another release may have different loader, side or dependency requirements.

  2. 02

    Bring the mods it needs

    This file does not list any required mods. Do not add a library just because a different file uses it.

  3. 03

    Put it on the correct side

    It must be installed on the client. Installation on the dedicated server is optional.

  4. 04

    Pick the file you checked

    Use the “Get this file” button beside 1.1.0. It opens that exact file at the source.

About this project

What does WelcomeScreen add?

Are you running a VS Server and with for more options that the welcome chat message? Have a look

Features

  • Auto-open on join dialog appears when a player connects
  • Markdown content write `welcome.md` in the server data directory, rendered as rich text (headings, bold, italic, links, lists, blockquotes, code)
  • Mod checker server compares client's installed mods against a recommended/blacklisted list and shows the result in the dialog
  • Reopen with HOME players can press HOME to reopen the dialog at any time

 

Installation

As Usual,download the latest `welcomescreen_x.x.x.zip` and place it in your server's `Mods/` directory. Do **not** extract the ZIP.

This is a **universal** mod — it must be installed on both server and client.

Configuration

All config files are auto-generated on first run in the server's `ModConfig/` directory.

WelcomeScreenConfig.json
Spoiler!
{
"Title": "Welcome",
"WelcomeFile": "welcome.md"
}


  • `Title` — dialog window title
  • `WelcomeFile` — path to the Markdown file (relative to server data dir)

 

welcome.md

Place this file in the server's data directory. Standard Markdown syntax is supported:

 

Spoiler!

```markdown
# Server Name

Welcome to our server!

## Rules
1. Be respectful
2. No griefing

**Have fun!**
```

 

 

WelcomeScreenModCheck.json
Spoiler!
{
"Enabled": true,
"RecommendedMods": [
{ "ModId": "rpvoicechat", "DisplayName": "RPVoiceChat", "Reason": "Proximity voice chat" }
],
"BlacklistedMods": []
}


  • `RecommendedMods` — mods the server suggests clients should have
  • `BlacklistedMods` — mods the server disallows (shown as warning, might lead to user blacklist in future)

Project description from Vintage Story Mod DB.

Pick your setup

WelcomeScreen releases for each Vintage Story version.

Choose the version and loader you play, then open the matching release.

1 available setups

Check the dependencies, then try the file in a copied instance before changing a world you care about.

Recent files

WelcomeScreen versions and loaders

1 of 1 releases match

Looking for an older file? The official Vintage Story Mod DB project page is in Resources.