mirror of
https://github.com/alexbelgium/hassio-addons.git
synced 2026-01-09 17:31:03 +01:00
129 lines
6.3 KiB
Markdown
129 lines
6.3 KiB
Markdown
## ⚠ VNC not working on several machines. Please use config.env to execute the script
|
|
|
|
# Home assistant add-on: Free Games Claimer
|
|
|
|
|
|
I maintain this and other Home Assistant add-ons in my free time: keeping up with upstream changes, HA changes, and testing on real hardware takes a lot of time (and some money). I use around 5-10 of my >110 addons so regularly I install test machines (and purchase some test services such as vpn) that I don't use myself to troubleshoot and improve the addons
|
|
|
|
If this add-on saves you time or makes your setup easier, I would be very grateful for your support!
|
|
|
|
[![Buy me a coffee][donation-badge]](https://www.buymeacoffee.com/alexbelgium)
|
|
[![Donate via PayPal][paypal-badge]](https://www.paypal.com/donate/?hosted_button_id=DZFULJZTP3UQA)
|
|
|
|
## Addon informations
|
|
|
|
|
|
|
|
|
|
|
|
[](https://www.codacy.com/gh/alexbelgium/hassio-addons/dashboard?utm_source=github.com&utm_medium=referral&utm_content=alexbelgium/hassio-addons&utm_campaign=Badge_Grade)
|
|
[](https://github.com/alexbelgium/hassio-addons/actions/workflows/weekly-supelinter.yaml)
|
|
[](https://github.com/alexbelgium/hassio-addons/actions/workflows/onpush_builder.yaml)
|
|
|
|
[donation-badge]: https://img.shields.io/badge/Buy%20me%20a%20coffee-%23d32f2f?logo=buy-me-a-coffee&style=flat&logoColor=white
|
|
[paypal-badge]: https://img.shields.io/badge/Donate%20via%20PayPal-0070BA?logo=paypal&style=flat&logoColor=white
|
|
|
|
_Thanks to everyone having starred my repo! To star it click on the image below, then it will be on top right. Thanks!_
|
|
|
|
[](https://github.com/alexbelgium/hassio-addons/stargazers)
|
|
|
|
|
|
|
|
## About
|
|
|
|
[Free Games Claimer](https://github.com/vogler/free-games-claimer) : Claims free games periodically on
|
|
|
|
- Epic Games Store
|
|
- Amazon Prime Gaming
|
|
- GOG
|
|
- Live Games with Gold - planned
|
|
|
|
This addon is based on the docker image https://github.com/vogler/free-games-claimer
|
|
|
|
## Configuration
|
|
|
|
Webui can be found at <http://homeassistant:6080> (NoVNC interface - currently has issues on some machines).
|
|
|
|
### Options
|
|
|
|
| Option | Type | Default | Description |
|
|
|--------|------|---------|-------------|
|
|
| `CMD_ARGUMENTS` | str | `node epic-games ; node prime-gaming ; node gog` | Commands to run for claiming games |
|
|
| `CONFIG_LOCATION` | str | `/config/config.env` | Location of the configuration file |
|
|
|
|
### Example Configuration
|
|
|
|
```yaml
|
|
CMD_ARGUMENTS: "node epic-games ; node prime-gaming ; node gog"
|
|
CONFIG_LOCATION: "/config/config.env"
|
|
```
|
|
|
|
### Environment Configuration
|
|
|
|
All main configuration is done via the `config.env` file located at `/config/addons_config/free_games_claimer/config.env`.
|
|
|
|
If this file doesn't exist, it will be created at first boot with default settings.
|
|
|
|
### Required Environment Variables
|
|
|
|
Add these to your `config.env` file:
|
|
|
|
```env
|
|
# Epic Games Store
|
|
EG_EMAIL=your-email@example.com
|
|
EG_PASSWORD=your-password
|
|
|
|
# Amazon Prime Gaming
|
|
PG_EMAIL=your-amazon-email@example.com
|
|
PG_PASSWORD=your-amazon-password
|
|
|
|
# GOG (optional)
|
|
GOG_EMAIL=your-gog-email@example.com
|
|
GOG_PASSWORD=your-gog-password
|
|
|
|
# Notifications (optional)
|
|
EMAIL_SMTP_HOST=smtp.gmail.com
|
|
EMAIL_SMTP_PORT=587
|
|
EMAIL_USER=notifications@example.com
|
|
EMAIL_PASS=your-app-password
|
|
EMAIL_TO=recipient@example.com
|
|
```
|
|
|
|
### Additional Options
|
|
|
|
For complete configuration options and advanced settings, see: https://github.com/vogler/free-games-claimer#configuration--options
|
|
|
|
### Important Notes
|
|
|
|
- **VNC Issues**: The NoVNC web interface is currently not working reliably on several machines
|
|
- **Recommended**: Use the `config.env` file for configuration instead of the web interface
|
|
- **Security**: Store credentials securely and consider using app-specific passwords where available
|
|
|
|
### Custom Scripts and Environment Variables
|
|
|
|
This addon supports custom scripts and environment variables through the `addon_config` mapping:
|
|
|
|
- **Custom scripts**: See [Running Custom Scripts in Addons](https://github.com/alexbelgium/hassio-addons/wiki/Running-custom-scripts-in-Addons)
|
|
- **env_vars option**: Use the add-on `env_vars` option to pass extra environment variables (uppercase or lowercase names). See https://github.com/alexbelgium/hassio-addons/wiki/Add-Environment-variables-to-your-Addon-2 for details.
|
|
|
|
## Installation
|
|
|
|
The installation of this add-on is pretty straightforward and not different in comparison to installing any other add-on.
|
|
|
|
1. Add my add-ons repository to your home assistant instance (in supervisor addons store at top right, or click button below if you have configured my HA)
|
|
[](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Falexbelgium%2Fhassio-addons)
|
|
1. Install this add-on.
|
|
1. Click the `Save` button to store your configuration.
|
|
1. Set the add-on options to your preferences
|
|
1. Start the add-on.
|
|
1. Check the logs of the add-on to see if everything went well.
|
|
1. Open the webUI and adapt the software options
|
|
|
|
## Support
|
|
|
|
Create an issue on github
|
|
|
|
[repository]: https://github.com/alexbelgium/hassio-addons
|
|
|
|
|