Skip to content

Card Xbox

dckiller51 edited this page Oct 25, 2026 · 1 revision

🎮 Xbox Card (xbox) (since 1.3.7)

The game you're playing and your counters (gamerscore, achievements…), from one of two sources you choose in the builder:

Xbox TrueAchievements
What it is Home Assistant's official Xbox integration The TrueAchievements custom component (HACS)
Account Your Microsoft account A TrueAchievements Pro account
Profile ✅ gamerpic, gamertag, online / offline —
Game being played cover, platform · publisher, achievements, gamerscore (bar), progress cover, platform · publisher, achievements, gamerscore and TA score (bars), completion, ratio, time played
Counters gamerscore, friends, followers, following Gamerscore, TA score, completion, games finished, total games, achievements
Last sync — ✅ green, or red when the component reports a problem

📸 Preview

Xbox TrueAchievements
Xbox, nothing running
Console off / no game
TrueAchievements, nothing running
No game running
Xbox, game being played
Game being played
TrueAchievements, game being played
Game being played
Xbox, game details
Long press: game details
TrueAchievements, game details
Long press: game details

✨ Features & Possibilities

  • Every part can be turned off: profile, game, counters, last sync. Up to 8 counters, 1 to 4 per row (icon, value, label), in the order you choose. From 3 per row, the icon sits above the value.
  • Each counter can be customized: its label, its icon (automatic, one of the built-in icons, none, or one of your uploaded icons) and the icon's colour. Icons can also be hidden for the whole card.
  • Long press on the game (or tap it): all its details, like Home Assistant's "more info": genres, developer, release date, description, TA points, ratio, time played, links to the game and to the achievement guide on TrueAchievements…
  • Long press on a counter: its details too.
  • Console off: "Xbox off" (Xbox) or "No game running" (TrueAchievements) instead of the game.
  • Builder: pick the source, then your account (found in Home Assistant) and Fill in: every entity is set in one click. Every field stays editable.

⚙️ Options Reference

Parameter Type Default Description
type string — xbox
source string xbox xbox or trueachievements. Only changes the builder's suggestions and the "console off" text.
profile_entity string — Xbox: the profile binary_sensor.<gamertag> (gamerpic, name, online).
game_entity string — The game being played: sensor.<gamertag>_now_playing (Xbox) or sensor.trueachievements_<gamertag>_jeu_en_cours (TrueAchievements; the name depends on Home Assistant's language).
picture_entity string — The game's cover from an image entity. Xbox: image.<gamertag>_now_playing (set by Fill in), served through Home Assistant. Empty: the game entity's own picture.
stats list — Up to 8 counters: { "entity_id": "…", "name": "…", "icon": "…", "color": "#RRGGBB" }. Only entity_id is required. name: the entity's name without the account part otherwise. icon: auto (default, by the entity), gamerscore, star, percent, trophy, medal, controller, people, chart, none, or an uploaded icon path such as /sdcard/astrion/icons/xbox.png. color: tint of a built-in icon.
stats_per_row int 2 Counters per row, 1 to 4.
show_stat_icons bool true false hides every counter's icon.
sync_entity string — TrueAchievements: its connection status binary_sensor (with last_update).
show_profile bool true The profile row.
show_game bool true The game block.
show_stats bool true The counters.
show_sync bool true The last sync row.

Counter icons follow the entity: gamerscore shows a G, TA score a star, completion a %, games finished a trophy, friends and followers people.

📄 JSON Configuration Examples

TrueAchievements, like the classic Mushroom dashboard (game, Gamerscore, TA score, completion, games finished, last sync):

{
  "type": "xbox",
  "options": {
    "source": "trueachievements",
    "game_entity": "sensor.trueachievements_yourgamertag_now_playing",
    "stats": [
      { "entity_id": "sensor.trueachievements_yourgamertag_gamerscore" },
      { "entity_id": "sensor.trueachievements_yourgamertag_ta_score", "name": "TA Score" },
      { "entity_id": "sensor.trueachievements_yourgamertag_completion_percentage", "name": "Completion" },
      { "entity_id": "sensor.trueachievements_yourgamertag_completed_games", "name": "Games finished" }
    ],
    "sync_entity": "binary_sensor.trueachievements_yourgamertag_statut_de_connexion_ta"
  }
}

Xbox integration:

{
  "type": "xbox",
  "options": {
    "source": "xbox",
    "profile_entity": "binary_sensor.yourgamertag",
    "game_entity": "sensor.yourgamertag_now_playing",
    "picture_entity": "image.yourgamertag_now_playing",
    "stats": [
      { "entity_id": "sensor.yourgamertag_gamer_score" },
      { "entity_id": "sensor.yourgamertag_friends" },
      { "entity_id": "sensor.yourgamertag_follower" }
    ]
  }
}

💡 The Xbox integration reports achievements as 29 / 0 (no total), so only the gamerscore gets a bar; TrueAchievements gives the total, so achievements get one too.

Clone this wiki locally