Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README needs to be updated #157

Open
1 of 2 tasks
michaeljolley opened this issue Nov 10, 2020 · 6 comments
Open
1 of 2 tasks

README needs to be updated #157

michaeljolley opened this issue Nov 10, 2020 · 6 comments
Labels
📚 good first issue Good for newcomers

Comments

@michaeljolley
Copy link
Owner

michaeljolley commented Nov 10, 2020

We've been adding some really nice functionality to the extension, but haven't maintained the README.md as we should. We need to update the README.md to include the latest settings & capabilities. I don't have an exhaustive list, but I know it includes:

  • Additional Access States for VIPs, Moderators & Broadcaster
  • New settings / capability for holding the theme for X minutes based on channel points.

In relation to the channel point feature, we should probably describe how best to retrieve the channel point id. Also, in that vein, we should probably log to the output any channel point redemptions with their channel point id so people can grab it easier.

@michaeljolley michaeljolley added the 📚 good first issue Good for newcomers label Nov 10, 2020
@ToeFrog
Copy link
Contributor

ToeFrog commented Nov 13, 2020

@michaeljolley I actually had that question about the channel point id when I was setting this up this morning. What is the process for that. I can add it to the docs.

@michaeljolley
Copy link
Owner Author

Right now there isn't a good process. You need the unique id that Twitch passes when you use a channel redemption. That's why I mentioned we need to log that channel reward id to the console so we can tell people "turn on twitch themer, redeem the reward in chat, find the id in the console of VS Code, add that Id to the settings."

@ToeFrog
Copy link
Contributor

ToeFrog commented Nov 13, 2020

I'll take a look and see if I can't figure it out.

@parithon
Copy link
Contributor

Looking at the documentation for the pubsub event, the payload should include the reward title. It may be a better user experience to use that instead of the redemption ID. See https://dev.twitch.tv/docs/pubsub#example-channel-points-event-message

data.redemption.reward.title

@michaeljolley
Copy link
Owner Author

Just updated the extension to write the custom reward id out in the Twitch Themer output

@michaeljolley
Copy link
Owner Author

I updated the README to call out the new Access States, but details on how to use the channel point redemption still needs to get in there.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚 good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants