Skip to content
Server Status Badge

Server Status Badge

Build a live SVG badge, card or signature square with your FiveM server's logo, player count and a Join button, and embed it with Markdown, HTML or BBCode.

Open the tool Last updated

The Server Status Badge tool makes a live image of your FiveM server: 402/700 players while it answers, offline when it does not. You pick the shape, the artwork and the colours, and copy a ready snippet for a GitHub README, a website or a forum thread.

What it is for

  • A status card with your logo and a Join button at the top of your server’s website or Tebex store.
  • A small badge in a GitHub README for a server or a public config repo.
  • A compact square for a forum.cfx.re signature, with BBCode.

The badge is not a historical uptime percentage. It shows the state at the moment it was loaded, and it updates about once a minute wherever it is embedded.

Quick start

  1. Enter your server in Address or join code: ip:port, host:port, cfx.re/join/abc123 or just the join code.
  2. Pick a starting point under Start from. Dark card is the one most people want.
  3. Adjust Shape, What it shows, Artwork and Colours.
  4. Check the Live preview. It shows the real image on a dark and a white plate, with its true pixel size.
  5. Copy one of the snippets under Embed.

If you came from the Server Status Checker, Make a badge opens this tool with your server already filled in.

The three shapes

Shape What it looks like Good for
Badge The small shields style strip with the count on the right A README line, next to build badges
Card Logo, server name, player bar, Join button A website header, a README title block
Square A tile with a player ring and your logo Forum signatures, a sidebar

With a cfx.re join code, the badge uses the icon your server already shows in the FiveM server list. Nothing to upload, nothing to configure. Animated icons are drawn as one still frame so the badge stays small.

If your server has no icon, or you are badging it by ip:port, pick Own picture under Artwork. Your file is shrunk in the browser and travels inside the badge link, so keep it simple: the tool tells you how long the link has become and warns you when it gets too long for some forums.

Backdrop puts artwork behind a card or a square:

  • Icon, faded blows up the same logo. It costs nothing extra.
  • Server banner uses the banner your server advertises in banner_detail. We fetch it and put it in the image. If it is missing, slow, not an image or bigger than 96 KB, the badge drops it and still looks right.

Tip

A badge with a banner is a much heavier image than a plain one. On a page where the badge loads on every visit, the icon backdrop is the cheaper choice.

Options

Group Option What it does
Shape Shape Badge, card or square
Style Badge only: Flat, Square, Big
Theme Card and square: Dark or Light
Size Renders the badge bigger or smaller, from 0.5x to 3x
Corner radius Rounds the corners, 0 for sharp
Text size / Width Text size on a badge, fixed width on a card or square
What it shows Player count 402/700, a bar, a ring, a percentage, or hidden
Use the server name Your server name as the label or title, colour codes stripped
Game type, Map name, Last updated Extra lines on a card or square
Join button Card only, needs a join code
Extra line Your own text, for example your Discord invite
Artwork Logo Server icon, none, or your own picture
Backdrop None, the icon faded, or your server banner
Colours Online, Offline, Join button, Background, Text, Border Every part separately

Offline keeps its own colour whatever you pick for online, so a server that is down never shows up green.

Embed snippets

The Embed panel gives you four versions, each with a copy button. With a join code the link goes to https://cfx.re/join/<code> so a click opens FiveM. With an IP it links to the Server Status Checker page for your server.

Markdown (GitHub README)

Markdown
[![FiveM server status](https://fivemad.com/api/badge/abc123.svg?shape=card)](https://cfx.re/join/abc123)

HTML (website)

HTML
<a href="https://cfx.re/join/abc123"><img src="https://fivemad.com/api/badge/abc123.svg?shape=card" alt="FiveM server status" /></a>

BBCode (forums)

Text
[url=https://cfx.re/join/abc123][img]https://fivemad.com/api/badge/abc123.svg?shape=square[/img][/url]

Image URL

Just the image link, for places that only take an image URL.

Everything you set ends up in the image link, so you can tweak an existing badge without coming back to the tool:

Text
https://fivemad.com/api/badge/<server>.svg?shape=card&players=bar&logo=server&art=banner
Part 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 none, icon, banner
label Left text or card title. hostname=1 uses your server name.
sub Your own extra line
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 like blue

The tool page takes the same options, so /tools/server-uptime-badge?q=abc123&shape=card&art=banner opens the editor on that design. Old badge links keep working: label, style, color, labelColor and hostname still mean what they did.

For example, a big blue badge with your server name:

Text
https://fivemad.com/api/badge/abc123.svg?style=for-the-badge&color=blue&hostname=1

Tips

  • Check the preview on both plates. A card set to the light theme disappears on a white page unless you keep the border on.
  • Shorter titles read better. On a badge, status or your server tag often looks cleaner than the full hostname.
  • Size is the cheapest way to make a card look sharp on a high resolution screen: 2x renders the same design at twice the pixels.
  • GitHub shows README images through its own image cache, so a badge there can lag a few minutes behind.

Limitations

  • Discord does not show SVG images, neither in chat previews nor in embeds, and there is no PNG version yet. For Discord, link your Server Status Checker page or use a bot that posts the player count.
  • The badge updates about once a minute, not in real time. There is a limit of 120 badge requests a minute per address.
  • The logo, the banner and the Join button need a join code. An ip:port badge shows the player count and the name only.
  • It only knows what your server makes public. If the server does not answer from outside, the badge shows offline even when players on your LAN can join.