Skip to content

Latest commit

 

History

History
261 lines (199 loc) · 11.5 KB

Readme.md

File metadata and controls

261 lines (199 loc) · 11.5 KB
Raw

Epic Games Store Weekly Free Games

Automatically login and find available free games the Epic Games Store. Sends you a prepopulated checkout link so you can complete the checkout after logging in. Supports multiple accounts, login sessions, and scheduled runs.

Setup

JSON Configuration

The tool can be configured with a combination of JSON and environment variables. The config file supports JSON5 syntax (comments, trailing commas, etc). For each property, the JSON config value takes priority over the respective environment variable value.

For details on each option, its defaults, and environment variable key, see the config documentation site.

The config file is stored in the mounted /usr/app/config volume and can be named config.json or config.json5.

config.json or config.json5

{
  "runOnStartup": true,
  "cronSchedule": "0 0,6,12,18 * * *",
  "logLevel": "info",
  "webPortalConfig": {
    "baseUrl": "https://epic.example.com",
  },
  "accounts": [
    {
      "email": "[email protected]",
    },
  ],
  "notifiers": [
    // You may configure as many of any notifier as needed
    // Here are some examples of each type
    {
      "type": "email",
      "smtpHost": "smtp.gmail.com",
      "smtpPort": 587,
      "emailSenderAddress": "[email protected]",
      "emailSenderName": "Epic Games Captchas",
      "emailRecipientAddress": "[email protected]",
      "secure": false,
      "auth": {
          "user": "[email protected]",
          "pass": "abc123",
      },
    },
    {
      "type": "discord",
      "webhookUrl": "https://discord.com/api/webhooks/123456789123456789/A-abcdefghijklmn-abcdefghijklmnopqrst12345678-abcdefghijklmnop123456",
      // Optional list of users or roles to mention
      "mentionedUsers": ["914360712086843432"],
      "mentionedRoles": ["734548250895319070"],
    },
    {
      "type": "telegram",
      // Optional Custom TELEGRAM server URL
      "apiUrl": "https://api.telegram.org",
      "token": "644739147:AAGMPo-Jz3mKRnHRTnrPEDi7jUF1vqNOD5k",
      "chatId": "-987654321",
    },
    {
      "type": "apprise",
      "apiUrl": "http://192.168.1.2:8000",
      "urls": "mailto://user:[email protected]",
    },
    {
      "type": "pushover",
      "token": "a172fyyl9gw99p2xi16tq8hnib48p2",
      "userKey": "uvgidym7l5ggpwu2r8i1oy6diaapll",
    },
    {
      "type": "gotify",
      "apiUrl": "https://gotify.net",
      "token": "SnL-wAvmfo_QT",
    },
    {
      "type": "homeassistant",
      "instance": "https://homeassistant.example.com",
      "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
      "notifyservice": "mobile_app_smartphone_name",
    },
    {
      "type": "bark",
      // your bark key
      "key": "xxxxxxxxxxxxxxxxxxxxxx",
      // bark title, optional, default: 'epicgames-freegames'
      "title": "epicgames-freegames",
      // bark group, optional, default: 'epicgames-freegames'
      "group": "epicgames-freegames",
      // bark private service address, optional, default: 'https://api.day.app'
      "apiUrl": "https://api.day.app"
    },
    {
        "type": "ntfy",
        "webhookUrl": "https://ntfy.example.com/mytopic",
        "priority": "urgent",
        "token": "tk_mytoken"
    },
    {
      "type":"webhook",
      //url of your webhook server
      "url":"https://webhook.site/my_uuid",
      //Optional headers
      "headers": {
         "Authentication": "Bearer 123456"
      }
    },
  ],
}

Web server

This project can occasionally ask you to login via device code authentication. Epic Games's device code session expires after 10 minutes, so this project uses a web server and redirect to prevent from sending you a new link every 10 minutes. There are two options for running the web server:

Web server config

If you're familiar with hosting web servers and/or reverse proxies, follow this:

  1. Expose port 3000 in your Docker run config (e.g. -p 81:3000 maps the host machine's port 81 to the container's port 3000)
  2. If you want to access the Captcha solving page from outside your network, setup any port forwarding/reverse proxy/DNS
  3. Set the webPortalConfig.baseUrl in the config

Localtunnel setup

If you don't have the ability to port forward/reverse proxy on your network, you can still access the web server remotely by setting:

{
  "webPortalConfig": {
    "localtunnel": true,
  },
}

in your config.json.

Notifications

Each notification method has unique setup instructions. Read its documentation (notification methods) on the config site for exact details and instructions. The example config may also help as an example.

Testing notification and web server

Since user actions may not always be required, the notification methods and web server can be manually tested. Essentially, you just need to add:

  "testNotifiers": true,

to the root of your config.json. For more details check out the config docs. Note: to optimize for standby memory usage, the web server does not run when the process is not running. The web server will only be available during a scheduled run.

Docker Configuration

This image is available from both GitHub Container Registry and Docker Hub:

  • ghcr.io/claabs/epicgames-freegames-node:latest
  • charlocharlie/epicgames-freegames:latest

If you're experiencing issues with Chromium starting (hangs on login/notification), you can try the Debian image:

  • ghcr.io/claabs/epicgames-freegames-node:debian
  • charlocharlie/epicgames-freegames:debian

If you are using full JSON configuration, the only remaining Docker configurables are the port and volume.

Environment Variables

Most configuration options can be set via environment variable. Look for the env tag in the config docs for each option's key.

If for whatever reason you want to change the default config directory or config file name, CONFIG_DIR and CONFIG_FILE_NAME are available as environment variables.

Ports

Host port Container port Description
3000 3000 Port mapping on which the web server hosting the captcha solving page resides

Volumes

Host location Container location Mode Description
/my/host/dir/ /usr/app/config rw Location of the config and cookie file(s)

Memory Limit

It's recommended to add -m 2g as a docker run parameter to set a max memory usage of 2GB. The Chromium processes can sometimes run away, and without a limit your system can eventually lock up.

Docker Run

With JSON Config

$ docker run -d -v /my/host/dir/:/usr/app/config:rw -p 3000:3000 -m 2g ghcr.io/claabs/epicgames-freegames-node:latest

Without JSON Config

Without JSON config, you can only configure one account.

$ docker run -d -e TZ=America/Chicago -e [email protected] -e RUN_ON_STARTUP=true -e BASE_URL=https://example.com -e SMTP_HOST=smtp.gmail.com -e SMTP_PORT=587 -e [email protected] -e EMAIL_SENDER_NAME="Epic Games Captchas" -e [email protected] -e SMTP_SECURE=true -e [email protected] -e SMTP_PASSWORD=abc123 -v /my/host/dir/:/usr/app/config:rw -p 3000:3000 -m 2g ghcr.io/claabs/epicgames-freegames-node:latest

Cookie Import

If you're experiencing issues logging in with device code auth, you can import cookies for a temporary session.

  1. Setup the container per the below instructions
  2. In your web browser, log in to the Epic Games Store with "Remember me" checked.
  3. Install the EditThisCookie browser extension.
  4. While viewing the Epic Games Store page, open the EditThisCookie extension window, change the URL to https://www.epicgames.com/id, and click the export button: EditThisCookie export button
  5. In your mounted ./config folder, create <email_address>-cookies.json (e.g. [email protected]), and paste in your cookies.
  6. Start the container and the cookies will automatically be converted to a new format.

Cookie Import Notes

  • If you click "Log Out" on the browser session you copied the cookies from, the container may break.
  • If you have the container scheduled regularly, it should automatically refresh the cookies and keep you logged in for some time.

Running without Docker

If for some reason you don't want to use Docker to run this tool you can run it from source by cloning this repo and installing Node.js.

  1. Get this repo from Github
    • Clone using git (recommended): git clone https://github.com/claabs/epicgames-freegames-node.git
    • Or download and unpack ZIP archive: epicgames-freegames-node
  2. Create config folder in the cloned/unpacked directory
  3. Create JSON configuration
  4. Install Node.js 18 or higher
  5. Install Node.js dependencies
    • Start terminal and navigate to cloned/unpacked directory
    • Run npm i
  6. Start application: npm run start
  7. To update when using Git:
    • git pull
    • npm i

Miscellaneous

v4 to v5 Migration

In v5, several options have been added or removed. The added/removed options should not affect existing v4 configs, but may need to change your config.json for a stable solution.

Changed

  • cronSchedule: The default was changed to every six hours. You should change your cron schedule to run more often than every 8 hours, as the device code auth refresh token expires after 8 hours.

Removed

  • account.password: login credentials are no longer used
  • account.totp: login credentials are no longer used
  • noHumanErrorHelp: purchase is no longer automated
  • hcaptchaAccessibilityUrl: was deprecated in v4
  • email: was deprecated in v4, use notifiers with "type": "email"
  • baseUrl: was deprecated in v4, use webPortalConfig.baseUrl
  • onlyWeekly: was deprecated in v4, use searchStrategy

Thanks

Thanks to epicgames-weekly-freegames for the inspiration.

Thanks to EpicResearch for the documentation that made device code auth possible.