Introduction #
The Community module allows you to interact with your viewers cross platform by allowing them to connect their third-party accounts to Stream Hydra. Say you want to reward your Twitch subscribers by whitelisting them on your Minecraft server. Well, you wouldn’t ordinarily know all of your subscribers Minecraft user IDs, but you do know their Twitch user IDs. Once you’ve setup your community, you can let your viewers connect their accounts to Stream Hydra and using specific nodes in your applets, you can translate their Twitch ID into their Minecraft ID in order to whitelist them. When used properly, this can be a very powerful module! To get started, enable the Community module from the modules page. To understand more about the data types returned, and how to use them, check out this article.
Setting Up Your Community #
In order to start accepting your viewers to connect their accounts, start by heading over to the “My Community” tab. Here you can click “Settings” at the side and fill in your Community’s name, icon and ‘slug’ (the end of the URL).
You can view your Community URL at the top of the page which you can share with your following. Upon clicking this link, you should see a new sign in page:
After signing in, you (or your followers) should be redirected to a page to join your community. If you don’t, you can always open your community link again.
From here, you should inform your followers to select the providers they wish to share with you. If they haven’t connected that provider yet, they can click “Connect” next to it and follow the instructions. They only need to connect to your community once, but can use their same Stream Hydra Community account to connect to other communities should they wish to.
Now that you have people connecting to your community, you can view them from the “My Community” page. Here you can see a list of users, with their usernames from any connected services they shared with you. You can search for members as well as kick or ban them from your community. If you wish to unban them, you can click “View Banned Members” and choose the user that applies. Note: The unbanned user will need to reconnect to your community after unban.
Now that this is all setup, you can start to pull in nodes to your applets in order to use this data.
Triggers #
These nodes will fire your applets on specific events in your community, and pass that data into your other nodes.
On Member Join #
This node will trigger your applet when a new member joins your community and will return the following values:
- ID (string) – The Stream Hydra community ID of the member.
- DISPLAY_NAME (string) – The username the user signed up to stream hydra community with.
- TWITCH_ID (string) – The Twitch ID of the user (can be null if they haven’t shared this provider with you).
- TWITCH_USERNAME (string) – The Twitch username of the user (can be null if they haven’t shared this provider with you).
- DISCORD_ID (string) – The Discord ID of the user (can be null if they haven’t shared this provider with you).
- DISCORD_USERNAME (string) – The Discord username of the user (can be null if they haven’t shared this provider with you).
- MINECRAFT_ID (string) – The Minecraft ID of the user (can be null if they haven’t shared this provider with you).
- MINECRAFT_USERNAME (string) – The Minecraft username of the user (can be null if they haven’t shared this provider with you).
- PATREON_ID (string) – The Patreon ID of the user (can be null if they haven’t shared this provider with you).
- PATREON_USERNAME (string) – The Patreon username of the user (can be null if they haven’t shared this provider with you).
On Member Leave #
This node will trigger your applet when a member leaves your community and will return the following values:
- ID (string) – The Stream Hydra community ID of the member.
- DISPLAY_NAME (string) – The username the user signed up to stream hydra community with.
- TWITCH_ID (string) – The Twitch ID of the user (can be null if they haven’t shared this provider with you).
- TWITCH_USERNAME (string) – The Twitch username of the user (can be null if they haven’t shared this provider with you).
- DISCORD_ID (string) – The Discord ID of the user (can be null if they haven’t shared this provider with you).
- DISCORD_USERNAME (string) – The Discord username of the user (can be null if they haven’t shared this provider with you).
- MINECRAFT_ID (string) – The Minecraft ID of the user (can be null if they haven’t shared this provider with you).
- MINECRAFT_USERNAME (string) – The Minecraft username of the user (can be null if they haven’t shared this provider with you).
- PATREON_ID (string) – The Patreon ID of the user (can be null if they haven’t shared this provider with you).
- PATREON_USERNAME (string) – The Patreon username of the user (can be null if they haven’t shared this provider with you).
On Identity Add #
This node will trigger your applet whenever a member of your community shares an additional provider with you and will return the following values:
- ID (string) – The Stream Hydra community ID of the member.
- DISPLAY_NAME (string) – The username the user signed up to stream hydra community with.
- PLATFORM (string) – The platform that was shared to your community. Can be “Twitch”, “Discord”, “Minecraft”, or “Patreon”.
- TWITCH_ID (string) – The Twitch ID of the user (can be null if they haven’t shared this provider with you).
- TWITCH_USERNAME (string) – The Twitch username of the user (can be null if they haven’t shared this provider with you).
- DISCORD_ID (string) – The Discord ID of the user (can be null if they haven’t shared this provider with you).
- DISCORD_USERNAME (string) – The Discord username of the user (can be null if they haven’t shared this provider with you).
- MINECRAFT_ID (string) – The Minecraft ID of the user (can be null if they haven’t shared this provider with you).
- MINECRAFT_USERNAME (string) – The Minecraft username of the user (can be null if they haven’t shared this provider with you).
- PATREON_ID (string) – The Patreon ID of the user (can be null if they haven’t shared this provider with you).
- PATREON_USERNAME (string) – The Patreon username of the user (can be null if they haven’t shared this provider with you).
On Identity Revoke #
This node will trigger your applet whenever a member of your community removes a shared provider with you and will return the following values:
- ID (string) – The Stream Hydra community ID of the member.
- DISPLAY_NAME (string) – The username the user signed up to stream hydra community with.
- PLATFORM (string) – The platform that was revoked by the member in your community. Can be “Twitch”, “Discord”, “Minecraft”, or “Patreon”.
- TWITCH_ID (string) – The Twitch ID of the user (can be null if they haven’t shared this provider with you).
- TWITCH_USERNAME (string) – The Twitch username of the user (can be null if they haven’t shared this provider with you).
- DISCORD_ID (string) – The Discord ID of the user (can be null if they haven’t shared this provider with you).
- DISCORD_USERNAME (string) – The Discord username of the user (can be null if they haven’t shared this provider with you).
- MINECRAFT_ID (string) – The Minecraft ID of the user (can be null if they haven’t shared this provider with you).
- MINECRAFT_USERNAME (string) – The Minecraft username of the user (can be null if they haven’t shared this provider with you).
- PATREON_ID (string) – The Patreon ID of the user (can be null if they haven’t shared this provider with you).
- PATREON_USERNAME (string) – The Patreon username of the user (can be null if they haven’t shared this provider with you).
Actions #
These nodes perform certain functions in your Community from applets within Stream Hydra.
Get Community URL #
This node will retrieve the URL for your community that users will have to navigate to in order to join your community. This is useful if you want to automate sending messages to various platforms without having to write out the URL in various places and risk getting it wrong.
- URL (string) – The URL for your community that will allow members to join.
Translate Identity (From Username) #
This node will translate a members username from one platform to another provided that the user has shared those platforms with you. For example, this is useful if you want to reward your Twitch subscribers cross platform by giving them a role in Discord, or whitelisting them on a Sub-Only Minecraft server. This node takes:
- Platform from (string)(required) – The platform to translate the user from. Must be either “Twitch”, “Discord”, “Minecraft”, or “Patreon”.
- Username (string(required) – The username to translate from.
- Platform to (string)(required) – The platform to translate the user to. Must be either “Twitch”, “Discord”, “Minecraft”, or “Patreon”.
When translated, the node will return the following values:
- TRANSLATED_ID (string) – The ID of the translated user in the platform you specified.
- TRANSLATED_NAME (string) – The username of the translated user in the platform you specified.
Note: The node will return null if the member does not exist, or if the member hasn’t shared that platform with you.
Translate Identity (From ID) #
This node will translate a members username from one platform to another provided that the user has shared those platforms with you. For example, this is useful if you want to reward your Twitch subscribers cross platform by giving them a role in Discord, or whitelisting them on a Sub-Only Minecraft server. This node takes:
- Platform from (string)(required) – The platform to translate the user from. Must be either “Twitch”, “Discord”, “Minecraft”, or “Patreon”.
- ID (string(required) – The ID to translate from.
- Platform to (string)(required) – The platform to translate the user to. Must be either “Twitch”, “Discord”, “Minecraft”, or “Patreon”.
When translated, the node will return the following values:
- TRANSLATED_ID (string) – The ID of the translated user in the platform you specified.
- TRANSLATED_NAME (string) – The username of the translated user in the platform you specified.
Note: The node will return null if the member does not exist, or if the member hasn’t shared that platform with you.
Kick Member #
This node when called will kick a specific member from your community using the ID and platform you specify.
- PLATFORM (list) – The platform for which the ID you are about to provide is from. E.g. If the ID you have of the user is from Twitch, then select Twitch from the dropdown
- ID (string) – The ID of the user from the platform you selected to kick.
Ban Member #
This node when called will ban a specific member from your community using the ID and platform you specify.
- PLATFORM (list) – The platform for which the ID you are about to provide is from. E.g. If the ID you have of the user is from Twitch, then select Twitch from the dropdown
- ID (string) – The ID of the user from the platform you selected to ban.
Unban Member #
This node when called will unban a specific member from your community using the ID and platform you specify.
- PLATFORM (list) – The platform for which the ID you are about to provide is from. E.g. If the ID you have of the user is from Twitch, then select Twitch from the dropdown
- ID (string) – The ID of the user from the platform you selected to unban.
This page will be updated as we add more support for Community triggers, actions and functions. If you have any questions please feel to free to contact us here via any method – except maybe carrier pigeon!
