This action allows you to set the welcome message that clients receive when they get approval for connection to the server.


The only parameter is the welcome message string. The string can be blank, have new lines, etc.


In Relay Server and Client, this message has a max length of 511 ANSI characters long. The server will silently cut off extra text.

In Blue Server, this message is in UTF-8 and not length-restricted, but Relay Clients will cut off at 511 ANSI characters anyway. Blue will retain the full message.

Note that in a reply to Blue Client's LAN network scan, the welcome message will be cropped to around 1,300 bytes, to prevent fragmentation of the message that might result in it being discarded.

ANSI and UTF-8 are explained more under Unicode notes.


It is recommended (but not required) that you include the server version in the welcome message for clients to have available.

Clients are not required to display the welcome string to users, so you can also use it to identify your game version, provide a feature list, etc.


The clients will receive the welcome message in the connect approval message, so it will be available from the point they trigger their Connection > On Connect event. So if you deny their connection, they will not receive the welcome message… which makes sense, not very welcoming to deny entry.