Server Status Badge

Generate an auto-updating SVG badge showing your FiveM server's online state and player count. Copy the Markdown, HTML or BBCode and paste it anywhere.

ServerLive, EmbedRead the docs

Server

Address or join code

ip:port, host:port, cfx.re/join/abc123 or the bare join code. With a join code the badge also gets your server icon.

Start from

Shape

Theme

Size1x

Corner radius12px

Width0 auto

What it shows

Player count

Use the server nameColour codes are stripped and a long name is cut to fit.

The Join button needs a cfx.re join code, an IP has nothing to link to.

Extra line (optional)Your own text, shown next to the game type.

Artwork

Logo

Your server icon, straight from the Cfx.re list. Nothing to set up.

Backdrop

Colours

Online

Offline

Join button

Background

Background top

Text

Small text

Border

Offline keeps its own colour, so a server that is down never shows up green.

Live preview

Enter a server to see the badge.

Discord: Discord does not render SVG images in embeds or chat, so pasting the badge link there shows no preview. Use it on your website, a GitHub README or a forum thread, and link your status page on Discord instead.

What the badge shows

The badge shows the live state of your server: 402/700 players while it answers,offline when it does not. It is not a historical uptime percentage, we don't store status history yet. Every time the image is loaded (at most about once a minute because of caching) it checks your server again.

Three shapes

Badge: the small shields style strip for a README line.
Card: logo, server name, player bar and a Join button. The one to put at the top of a page.
Square: a compact tile with a player ring, made for forum signatures.

Your server logo

With a cfx.re join code the badge picks up the icon your server already shows in the FiveM server list, so there is nothing to upload. Animated icons are drawn as a single frame. If your server has no icon, or you badge it byip:port, pick Own picture and the tool shrinks your file and carries it inside the badge link. Server banner as a backdrop uses the banner your server advertises; we fetch it, and if it is missing, slow or over 96 KB the badge simply leaves it out.

URL format

Everything you set ends up in the link, so you can also edit an existing badge by hand:

https://fivemad.com/api/badge/<server>.svg?shape=card&players=bar&logo=server

Option	Values
`<server>`	Join code (`abc123`), `ip:port` or `host:port`
`shape`	`badge` (default), `card`, `square`
`style`	Badge only: `flat` (default), `flat-square`, `for-the-badge`
`theme`	Card and square: `dark` (default) or `light`
`players`	`count`, `bar`, `ring`, `percent`, `none`
`logo`	`server`, `none`, or a `data:image/...` picture
`art`	Backdrop: `none`, `icon`, `banner`
`label`	Left text or card title. `hostname=1` uses your server name instead.
`map`, `mode`, `updated`, `join`, `border`	`1` or `0`
`scale`, `radius`, `font`, `width`	Size, corner radius, text size, fixed width
`color`, `offline`, `bg`, `bg2`, `fg`, `muted`, `accent`, `bcolor`, `labelColor`	Hex without `#`, or a colour name

The tool page takes the same options, so /tools/server-uptime-badge?q=abc123&shape=card opens the editor on that design.

Join code or IP?

Use the join code if your server sits behind a proxy or blocks HTTP on the game port. It is also the only way to get your logo and your banner, and the only way the Join button has somewhere to point. Use ip:port for unlisted servers. Private network addresses are rejected.

Caching

The badge is cached for about a minute. GitHub proxies README images through its camo cache, so a badge there can lag a few minutes behind. There is a limit of 120 badge requests a minute per address.

Discord

Discord does not display SVG images, neither in chat previews nor in embeds, and there is no PNG version yet. For Discord, link yourstatus page or use a bot that posts the player count.