hassio-addons/epicgamesfree

Home assistant add-on: Epic Games Free

Thanks to everyone having starred my repo! To star it click on the image below, then it will be on top right. Thanks!

About

Epic Games Store Weekly Free Games : automatically login and redeem promotional free games from the Epic Games Store. Handles multiple accounts, 2FA, captcha bypass, captcha notifications, and scheduled runs. This addon is based on the docker image https://hub.docker.com/r/charlocharlie/epicgames-freegames

Configuration

Addon options expose the env_vars field for passing extra environment variables; all other configuration is done via JSON files.

Configuration Files

Configuration files are stored in /config/addons_config/epicgamesfree/:

• config.yaml: Main configuration file
• cookies.json: Authentication cookies (optional)

If these files don't exist, they will be created at first boot with default settings.

• 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.

Basic Configuration

Create /config/addons_config/epicgamesfree/config.yaml:

{
  "accounts": [
    {
      "email": "your-epic-email@example.com", 
      "password": "your-password",
      "totp": "OPTIONAL_2FA_SECRET"
    }
  ],
  "intervalHours": 24,
  "onlyWeekly": false,
  "searchStrategy": "purchase",
  "browserNavigationTimeout": 300000,
  "notifications": {
    "email": {
      "smtpHost": "smtp.gmail.com",
      "smtpPort": 587,
      "emailSenderAddress": "notifications@example.com",
      "emailSenderName": "Epic Games Free",
      "emailRecipientAddress": "recipient@example.com",
      "secure": false,
      "auth": {
        "user": "notifications@example.com",
        "pass": "your-app-password"
      }
    }
  }
}

Configuration Options

Option	Type	Description
accounts	array	List of Epic Games accounts
intervalHours	number	Check interval in hours (default: 24)
onlyWeekly	boolean	Only claim weekly free games
searchStrategy	string	Search strategy: "purchase" or "claim"
browserNavigationTimeout	number	Browser timeout in milliseconds
notifications	object	Notification settings (email, webhook, etc.)

Account Configuration

For each account in the accounts array:

{
  "email": "account@example.com",
  "password": "password",
  "totp": "TOTP_SECRET",
  "onlyWeekly": true
}

Notification Methods

Email Notifications

"notifications": {
  "email": {
    "smtpHost": "smtp.gmail.com",
    "smtpPort": 587,
    "emailSenderAddress": "sender@example.com",
    "emailRecipientAddress": "recipient@example.com",
    "secure": false,
    "auth": {
      "user": "sender@example.com",
      "pass": "app-password"
    }
  }
}

Webhook Notifications

"notifications": {
  "webhook": {
    "url": "https://your-webhook-url.com",
    "events": ["purchase-success", "already-owned"]
  }
}

Important Notes

• Automatic Redemption: Due to Epic Games' improved automation detection, automatic redemption is no longer possible
• Notification System: The addon now sends redemption links via your preferred notification method instead of automatically claiming games
• 2FA Support: TOTP (Time-based One-Time Password) is supported for accounts with two-factor authentication
• Multiple Accounts: You can configure multiple Epic Games accounts

Cookie Import (Optional)

You can import browser cookies to avoid login issues. Create /config/addons_config/epicgamesfree/cookies.json:

For detailed cookie import instructions, see: https://github.com/claabs/epicgames-freegames-node#cookie-import

Troubleshooting

Timeout Errors

Add the following to your config.yaml:

"browserNavigationTimeout": 300000

Login Issues

1. Check your credentials are correct
2. Verify 2FA/TOTP configuration if enabled
3. Consider importing browser cookies
4. Check the addon logs for specific error messages

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)
2. Install this add-on.
3. Click the Save button to store your configuration.
4. Set the add-on options to your preferences
5. Start the add-on.
6. Check the logs of the add-on to see if everything went well.
7. Open the webUI and adapt the software options

Support

Timeout error

Please try adding "browserNavigationTimeout": 300000, to your config.yaml (https://github.com/alexbelgium/hassio-addons/issues/675#issuecomment-1407675351)

Other errors

Create an issue on github