Widgets
FiveM widget guide
Claim from the public list with a join code, then embed the card and pin it in Discord.
FiveM status comes from the public FiveM server list, so there is no query port and no plugin. If your server is on that list, Dispresso can read it.
What you need#
- A FiveM server that shows up on the public FiveM list.
- Your cfx.re join code, or the IP and port (30120 by default).
- Manage Server in a Discord that has Dispresso that Dispresso already knows, so list it on the directory first if needed.
1. Get the server ready#
Confirm your server is visible on the public FiveM list. A server hidden from the list (for example by blanking sv_master1) cannot be read. Find your join code: it is the end of your cfx.re/join/ link.
Ports and settings at a glance#
| Setting | Where it lives | What to use |
|---|---|---|
| Server port | endpoint_add_tcp and endpoint_add_udp | 30120 by default, TCP and UDP |
| Query port | Not used | Dispresso reads the public list, not your port |
| Server name | sv_hostname or sv_projectName in server.cfg | Where the ownership code goes |
Firewall and host: Players need TCP and UDP 30120 (or your port) open. Dispresso itself does not contact your server, it reads the public FiveM list, so there is nothing extra to open.
2. Add it to Dispresso#
Easiest is Discord. In a server where Dispresso is, with Manage Server:
- 1Run
/gameserver setup. - 2Pick FiveM from the list.
- 3Paste your join code (
abc123orcfx.re/join/abc123) or the IP and port203.0.113.10:30120. - 4Copy the code Dispresso gives you (step 3 below) and press Check when it is in place.
abc123
cfx.re/join/abc123Prefer the site? Sign in, open /dashboard/servers/games, pick the FiveM chip, search for your server and press Claim. FiveM often needs no typing at all: your server is probably in the claim pool at the top of the FiveM chip, so pick your Discord and press Claim. Claims are reviewed by staff before the host shows publicly.
3. Prove it is yours#
Verify ownership gives a code like DISPRESSO-K7M2QX. Put it in sv_projectName (or sv_hostname), wait for it to show on the FiveM list, press Check within ten minutes, then remove it. If Check says it is not there yet, the list has not caught up, wait a moment and press it again.
4. Put the widget on your website#
The widget needs your listing id. Open your server's page on /servers/games and look at the address bar:
https://dispresso.co/servers/games/GAME/12345The number on the end (12345 here) is the id. That is the value for data-server. You can also pin a live card in Discord, which finds the server by name or address for you (last step below).
<!-- One server: replace YOUR_LISTING_ID with the number from your listing's address -->
<div data-dispresso-game-server data-server="YOUR_LISTING_ID"></div>
<!-- Or the busiest fivem servers, top 5 -->
<div data-dispresso-game-server data-game="fivem" data-limit="5"></div>
<script src="https://dispresso.co/widgets/game-server.js?v=3" async></script>Paste it where the card should appear. It shows the name, the map when the server has one, players out of the maximum, an Online or Offline pill and when it was last checked. It follows the visitor's light or dark theme; add data-theme="dark" or "light" to force one. How to paste it into WordPress, Wix, Squarespace, Carrd and plain HTML is in Put a widget on any website.
5. Show it in Discord too#
Want the same live numbers in a channel? In the Discord where Dispresso is, with Manage Server, run:
/gameserver pin server:Your Server channel:#server-statusSearch by the FiveM server's name, its IP, IP:port or the listing id. Dispresso posts one card with players, map, status, address and a Join button, and keeps it up to date on its own, even after the bot restarts. /gameserver create does the same thing, /gameserver list shows the cards this server has and /gameserver remove takes one down. The message version works too: !gameserver pin. The card is only for a server that is already listed, so finish the steps above first.
Troubleshooting#
| What you see | Usually because | Fix |
|---|---|---|
| Could not reach that server right now | FiveM answered, your server did not | Wait a minute and try again. The server must be up while it is checked. |
| That join code did not resolve | The code is wrong | Copy it from your own server listing rather than from a player. |
| Already linked to another Discord server | Someone claimed the host for a different community | One host, one Discord. Ask in the Dispresso support server if it should be yours. |
| Card sits at Offline while the server runs | The join code points somewhere else, or the server is hidden from the FiveM list | Check the code on the listing, and that the server appears on the public list. |
| The widget says the server is not listed right now | The id is wrong, the listing is still Pending review, it was removed, or it is marked 18+ | Open the listing page and copy the number from its address. Approved and not 18+ is the rule for every public widget. |
Still stuck? Open your listing on the site and look at the card there. The widget shows exactly what that page shows, so if the page says Offline or Unknown the problem is the listing, not the embed.
Questions people ask#
Is a staff review needed?#
A claim goes to staff before the host shows publicly, because being on the FiveM list only proves it is online, not that you run it.
Why can I not list a server that is not on the FiveM list?#
Because there is nothing for Dispresso to read. Get onto the public list first.
Does the widget work before staff approve it?#
No. It shows a calm 'not listed right now' message until the listing is approved.