Skip to content
Server Status Badge

Server Status Badge

Make a live SVG badge with your FiveM server's online state and player count, and embed it with Markdown, HTML or BBCode on a site, README or forum.

Open the tool Last updated

The Server Status Badge tool makes a small image that shows your FiveM server’s live state: 64/128 online in green while it answers, offline in red when it does not. You pick the style and colours, and copy a ready snippet for a GitHub README, a website or a forum thread.

What it is for

  • Showing the live player count on your server’s website or Tebex store.
  • Putting a status badge at the top of a GitHub README for a server or a public config repo.
  • Adding it to your forum.cfx.re recruitment or showcase thread 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 Style, a Label and an Online colour under Options.
  3. Check the Live preview. It shows the badge on a dark and on a white background.
  4. Copy one of the snippets under Embed and paste it where you want the badge.

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

Options

Option What it does Default
Style Flat, Square (flat-square) or Big (for-the-badge) Flat
Label Left side text, up to 60 characters. Leave it empty for a value-only badge. fivem
Use server hostname as label Uses your server name as the label. Colour codes are stripped and long names are cut to fit. off
Online colour Auto, Green, Blue, Orange, Yellow, Grey or Custom (colour picker or hex like 7c3aed) Auto (green)
Label colour (optional) Hex without # for the left side 555

Offline is always red, whatever online colour you pick, so the badge stays honest.

Join code or IP?

  • Use the join code if your server sits behind a proxy or blocks HTTP on the game port.
  • Use ip:port for private or unlisted servers, since join codes only work for servers in the public list.
  • Private network addresses (192.168.x.x, 10.x.x.x, 127.0.0.1) are rejected, because nobody on the internet could reach them.

With a join code, the badge links 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.

Embed snippets

The Embed panel gives you four versions. Each has a copy button.

Markdown (GitHub README)

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

HTML (website)

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

BBCode (forums)

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

Image URL

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

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

Text
https://fivemad.com/api/badge/<server>.svg?label=&style=&color=&labelColor=&hostname=1
Part Values
<server> Join code (abc123), ip:port or host:port
label Left side text. Empty for a value-only badge. Left out means fivem.
style flat (default), flat-square, for-the-badge
color Online colour: a name (blue, orange, yellow, brightgreen, lightgrey) or hex without #
labelColor Hex for the left side, default 555
hostname 1 to use your server name as the label

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 backgrounds. A grey label on a dark site can be hard to read; set a Label colour if it is.
  • Shorter labels read better on small badges. status or your server tag often looks cleaner than the full hostname.
  • 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.
  • 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.