Repository navigation
Quick Login
ServerGuard's client half can add an optional one-click login panel to the Valheim title screen. It lets players join a specific server without the server browser, without typing an IP, and without a password prompt.
This is a client-side feature configured in client.yaml. It is off by default and has no effect on the server.
A panel in the upper-right of the main menu showing:
- The server logo (an image you provide)
- The server name (heading)
- A short description
- A scrollable Announcements box, with clickable links
- A live player count (queried while the player sits on the menu)
- A Connect button styled like the game's own buttons
Edit BepInEx/config/ServerGuard/client.yaml:
quickLoginEnabled: true
serverAddress: "my.server.com" # hostname or IP
serverPort: 2456 # the game port (default 2456)
serverPassword: "" # the server password, if any
serverName: "My Server"
serverDescription: "Welcome to the server!"
serverLogoPath: "logo.png" # image file in BepInEx/config/ServerGuard/
serverAnnouncements: "" # see belowRestart Valheim. The panel appears on the title screen.
serverAnnouncements fills a scrollable box under the description, headed
Announcements. It is edited in the same client.yaml as everything else above.
Write it as a YAML block scalar — the | keeps your line breaks exactly as typed.
Indent every line of the text by two spaces; YAML strips that indent back off:
serverAnnouncements: |
<b>Server events</b>
Bosses every Saturday, 20:00 UTC.
Join our [Discord](https://discord.gg/example) for the schedule.
Rules: [read them first](https://example.com/rules)- Length: unlimited. The box scrolls with the mouse wheel, by dragging, or with the scrollbar on its right edge. The panel grows taller when announcements are present.
-
Links:
[label](https://example.com)renders as underlined blue text; clicking it opens the URL in the player's browser. Onlyhttp://andhttps://are opened — anything else (file://, custom schemes) is shown as plain text and is not clickable, becauseclient.yamloften ships inside a modpack rather than being written by the player. Watch forOpening announcement link:in the BepInEx log. -
Styling: TextMeshPro rich text works —
<b>bold</b>,<i>italic</i>,<color=#ffcc00>colour</color>. -
Leaving it empty (
serverAnnouncements: "") hides the header and the box entirely.
Upgrading from an older companion version? The key is appended to your existing
client.yaml, with the same notes as comments, the first time the new build starts.
- Format: PNG (recommended — supports transparency) or JPG. Other formats are not supported.
- Size: any resolution; it is scaled to fit roughly 300 × 120 px, preserving aspect ratio. A landscape image around 512 × 256 works well. Keep it reasonable (≤ 1024 px) to avoid wasted memory.
-
Location: put the file directly in
BepInEx/config/ServerGuard/and setserverLogoPathto just the filename (e.g.logo.png).
There are two flows, both of which skip the IP/password prompts:
- Connect → Character Select → Start — click Connect on the panel. The main menu hides and you go to character selection. Pick (or create) a character and confirm; you connect straight to the configured server.
- Start Game → Character Select → Connect — click the vanilla Start Game first. The panel stays visible on the character screen. Pick a character, then click Connect to join immediately.
The password (if set) is applied automatically, so the in-game password dialog never appears.
- If the logo doesn't appear, check the BepInEx log for
Logo file not foundorunsupported imagewarnings, and confirm the file is a PNG/JPG inBepInEx/config/ServerGuard/. - The live player count uses a standard Steam server query (A2S_INFO) sent to the query port, which is your game port + 1 — so
2457for a default2456server. If your host or firewall blocks UDP on that port, the panel showsPlayers: ?. Check the BepInEx log forPlayer-count query to <host>:<port> got no answer.to confirm which port was tried.-
Fixed in 1.6.1: before that version the count always showed
?, because the query didn't answer the challenge packet Valve's query protocol requires. If you're on 1.6.0 or earlier, update the companion plugin.
-
Fixed in 1.6.1: before that version the count always showed
- The panel only shows on the title screen; it disappears once you're in-game.
- Disabling is as simple as setting
quickLoginEnabled: false(or leaving the address blank).
See also: Installation, Configuration.