Community Goals

[mpforce1]

Description

Fixes #546

• Adds the ability to automatically contribute to Twitch Community Goals (aka Channel Points Challenges/Community Challenges).
• Adds an optional configuration option to enable/disable the functionality, defaults to disabled to avoid changing functionality for existing user configurations.
• Updates supporting example.py and README.md.

Originally I wanted a way to automatically contribute points to a particular channel's community goals but it ended up being simpler to implement it generically for any channel. I don't mind maintaining my fork for personal use but if other people are interested I'm more than happy to contribute.

Technically this adds a dependency on 2 Twitch GQL operations so there may be a need to update this if Twitch changes the API in the future.

Type of change

• New feature (non-breaking change which adds functionality)

How Has This Been Tested?

I originally developed this around mid 2023 and had the functionality active for several months. Unfortunately, the channel I used to use this on is on hiatus so I can only verify it worked as of February 2024. However, I did manage to verify the hash for 1 of the Twitch operations (UserPointsContribution) hasn't changed since then.

There are a couple of TODOs left in the code corresponding to aspects of the API I was unable to independently verify as they are for events that rarely occurred in my testing. More eyes on this would help see if there are any issues. Personally, I never saw any issues with them so either they work fine or shouldn't have a major impact if they do fail, restarting the miner should fix any issues since reloading the channel points context will also reload the goal data.

Checklist:

• My code follows the style guidelines of this project
• I have performed a self-review of my code
• I have commented on my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation (README.md)
• My changes generate no new warnings
• Any dependent changes have been updated in requirements.txt

[rdavydov]

Good job!