Skip to content

ray77/arcade4ever-hacs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

arcade4ever

arcade4ever HACS Integration

Home Assistant integration for arcade4ever.net — exposes live arcade stats as sensors.

Sensors

Entity State Attributes
sensor.arcade4ever_players_in_game comma-joined Name (Game) of players in an open game session (15 min window, counts session if either started_at OR latest heartbeat is within the window), or count, players[], window_minutes
sensor.arcade4ever_players_in_game_count integer count of the above (for gauges, statistics, numeric automations) window_minutes
sensor.arcade4ever_logged_in_users first 10 names of users with an active login session (5 min window), with +N more appended when the list is longer, or count, users[], window_minutes
sensor.arcade4ever_logged_in_users_count integer count of the above window_minutes
sensor.arcade4ever_top_beater_today Player (N beats) — the user with the most new personal bests today top_user, top_beats, leaderboard[], count
sensor.arcade4ever_last_highscore_beat Player — Game (score) for the latest personal-best event player, game, game_slug, score, beaten_at, events[]
sensor.arcade4ever_last_shout Author: Message of the newest shout (system messages excluded) author, message, created_at, shouts[]
sensor.arcade4ever_top_player_1_5 Name — Rating (Plays plays) for the top 5 players on the global leaderboard rank, user_id, name, rating, plays, games_qualified, favorite_game, badge_tier

Players In Game vs Logged In Users are different: the first requires an open game_sessions row + heartbeat (actually playing); the second only requires a live login cookie (could be reading the leaderboard).

0.3.0 note: the old sensor.arcade4ever_top_score_today is replaced by sensor.arcade4ever_top_beater_today (new unique_id; entity_id changes accordingly). If you have automations or dashboard cards bound to the old entity, repoint them.

Installation via HACS

  1. HACS → ⋮ → Custom repositories → add https://github.com/ray77/arcade4ever-hacs as Integration.
  2. Install arcade4ever from the HACS list.
  3. Restart Home Assistant.
  4. Settings → Devices & Services → Add Integration → arcade4ever.
  5. Enter the admin API secret (find it at https://arcade4ever.net/admin/api_settings.php). That's the only field.

Manual install

Copy custom_components/arcade4ever/ into <config>/custom_components/ and restart HA. Then add via UI as above.

API used

Read-only public endpoints under https://arcade4ever.net/api/public/:

  • active_players.php
  • online_users.php
  • highscores_today.php
  • highscore_beats.php
  • recent_shouts.php
  • top_beaters_today.php
  • top_players.php

The secret unmasks player names site-wide. Without it, names come back as L***r etc. — sensors still work, just masked.

License

MIT

About

arcade4ever HACS Integration — Home Assistant sensors for live arcade stats

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages