Theme
Getting a server key
The WFX.re Portal (/portal on the master server — in development http://127.0.0.1:7777/portal) is where you register servers. It plays the role of the Cfx.re Keymaster. It uses the same WFX.re account as the launcher.
Create a server
- Open
/portal, Sign in or Create account. - Click New server, enter a project name (3 to 64 characters) and click Create.
- A dialog shows Your server key — something like
wfx_followed by 40 hexadecimal characters. Copy it now: it is shown only once. The master only stores a sha256 hash of it. - Put it in your
server.jsonas"svKey"(or in theWILDM_SV_KEYenvironment variable) and restart the server.
You can register up to 10 servers per account.
Server details
Everything you set on the Portal is what players see in the server list; it overrides the name, description, tags and locale in server.json (those are only used for the server's local /info).
| Field | Rules |
|---|---|
| Project name | 3–64 characters |
| Description | Up to 140 characters — "write it as a sentence" |
| Tags | Comma separated, up to 5, each up to 16 characters, lower-cased, a-z 0-9 _ - only |
| Locale | A 2-letter code such as EN or FR, optionally with a region (EN-GB) |
| Max players | 1 to 1024 (shown in the list instead of the value sent by the server) |
| Icon | PNG, max 256 KB, 96×96 recommended (you get a warning for other sizes), max 4096×4096 |
| Banner | PNG or JPEG, max 1 MB, 2560×280 recommended |
The Live preview shows how the entry will look in the list. A server card shows whether it is online (a valid heartbeat was received in the last 90 s), with its address and player count.
Key management
- The Portal only shows the last 4 characters of the key (Key ending in ····).
- Regenerate key creates a new key and invalidates the old one immediately: the server disappears from the list until it sends a heartbeat with the new key.
- Delete server removes the registration, its icon and banner.
Keep your key secret
Anyone with your key can make their server appear as yours in the list. Never commit server.json with a real svKey to a public repository — prefer the WILDM_SV_KEY environment variable. If a key leaks, regenerate it.