Documentation for the FiveM integration (#21365)

Co-authored-by: Franck Nijhof <frenck@frenck.nl>
This commit is contained in:
Sander Jochems 2022-02-14 21:09:34 +01:00 committed by GitHub
parent ee7b0c1f50
commit 88fccaffad
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -0,0 +1,35 @@
---
title: FiveM
description: Instructions on how to integrate a FiveM server into Home Assistant.
ha_release: 2022.3
ha_category:
- Binary Sensor
- Sensor
ha_iot_class: Local Polling
ha_quality_scale: silver
ha_config_flow: true
ha_codeowners:
- '@Sander0542'
ha_domain: fivem
ha_platforms:
- binary_sensor
- sensor
---
FiveM allows players to play the game [Grand Theft Auto V](https://www.rockstargames.com/V) by [Rockstar Games](https://www.rockstargames.com) online with other players. FiveM adds support for custom resources. The FiveM integration lets you retrieve information from a FiveM server within Home Assistant.
{% include integrations/config_flow.md %}
## Binary sensors
This integration provides a binary sensor for the following information from a FiveM server:
- Connection status
## Sensors
This integration provides sensors for the following information from a FiveM server:
- Number of online players (player names are available in state attributes)
- Number of maximum players
- Number of resources (resource names are available in state attributes)