Widget Submission Guidelines, Template, and Checklist

Status
Not open for further replies.

Zaytri
she/her

Glitch Witch
Admin
Developer
Streamer
Widget Gallery Guidelines

When you submit a new widget, it will be reviewed by me or a forum moderator, to check if it passes the following guidelines:
  • No malware allowed, obviously
  • Must comply with Twitch Terms of Service and Community Guidelines
  • Code cannot be obfuscated or include unknown remote code
  • Code cannot send user data to a remote server without it being clear to the users how that data will be used
  • Cannot include anything related to web3 (NFTs, blockchain, cryptocurrency, etc.) or generative AI
  • Cannot include support for 7TV or global emotes from 3rd party emote services
  • Cannot include images of Pepe the Frog
Create a thread in Widget Verification to apply for verification. Your thread will only be visible to you and forum moderators. In your application, please share your widget code so that it can be reviewed. The best way would be to share a git repo via something like GitHub or GitLab, but we'll also accept something like Codepen or JSFiddle, Pastebin links, or even just attaching it to the thread as a zip file. If you are sharing code for a paid widget, we guarantee that we will keep your code private and not redistribute it to anyone else.

When you've passed the review, a ✅ will be added to the widget prefix, with an explanation that this widget has been verified at the top of the widget's overview page.

Even if it does pass these guidelines, the widget still may be denied for other reasons. In any case, we will make it clear to you why a widget has been denied, and you will be given chances to revise your submission.

If your submission has passed review, and you later make an update that violates these guidelines, your widget will be removed.


Widget Submission Template

Don't just copy someone else's widget description, make it your own! As a general rule, here are the 3 things you may want to include:
  1. Screenshots and/or Video
    • People likely aren't going to download your widget without seeing how it works in action
  2. Widget Features
    • If you're building off of Slime Chat, you can include a link to that and then list the features you've added on top of that
  3. Terms of Use
    • Set your terms for reselling, credits, etc.
Widget Code Checklist

Here's some things you may want to review in your code before submitting a widget, especially if you're building off of Slime Chat:
  1. Review the README.txt to ensure that all links and details are accurate
  2. Check the top of the overlay HTML file and <title> if you put your widget name and version in there, make sure it's accurate
  3. Check your settings JS file, make sure your `text-display`s are accurate, and that the first argument of slime2.widget.loadSettings() is a data JS file with your widget name
  4. Make sure to not include SLIME2_TWITCH_KEY.js, it's important that you do not give anyone access to your key
  5. You can include a data JS file if that makes it easier for you to set specific defaults, but it's recommended to not include it and set default values within the settings JS itself
    • Make sure to review what your widget looks like without a data JS file! You should ensure that it works without one, to make it easy for the user to revert to default settings by simply deleting their data JS file

Now that you've gone through all of that, you're ready to submit a widget! You can use the link below:

> Submit a New Widget
 
Last edited:
OP
OP
Zaytri

Zaytri
she/her

Glitch Witch
Admin
Developer
Streamer
Updated Widget Verification process: Rather than communicating with you via the forum conversation system, you will now need to create a thread with your widget code in Widget Verification to apply for verification.
 
Status
Not open for further replies.
Back
Top