├── .gitignore ├── README.md ├── changelog.md ├── fsminit.js ├── img ├── Screen Shot 2021-01-15 at 20.26.16.png ├── Screen Shot 2021-01-18 at 21.26.14.png ├── Screen Shot 2021-01-18 at 21.27.40.png ├── Screen Shot 2021-01-18 at 21.31.43.png ├── Screen Shot 2021-01-18 at 21.32.30.png ├── Screen Shot 2021-01-19 at 22.03.50.png ├── Screen Shot 2021-01-19 at 22.22.52.png ├── Screen Shot 2021-01-25 at 17.12.24.png ├── Screen Shot 2021-02-01 at 02.39.54.png ├── fsm-cover-mid.png └── fsm-cover.png ├── lang └── en.json ├── lib ├── bot.js └── parser.js ├── module.json ├── packs └── documentation.db ├── scripts ├── bundle.js ├── fromTwitch.js ├── fsmMacro.js ├── fsmcore.js ├── modLayer.js ├── settings.js ├── streamTwitch.js ├── temp.js ├── tmi.min.js ├── utils.js └── work-in-progress │ ├── misc-code-bin.js │ └── modActions.js ├── streamMod.code-workspace ├── streamers.md └── styles └── fsmtabs.css /.gitignore: -------------------------------------------------------------------------------- 1 | ################################################################################ 2 | # This .gitignore file was automatically created by Microsoft(R) Visual Studio. 3 | ################################################################################ 4 | 5 | /.vs 6 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |

2 | # Foundry Stream Module # 3 | A module for integrating Twitch chat from streams into Foundry Virtual Tabletop. Foundry Stream Module sends player chats, rolls, interactions to the Twitch stream chat and allows viewers in the Twitch chat to send messages to the players as an out of character message. GM's or another configurable user role can also moderate the Twitch chat via canvas control buttons for actions such as Request Roll, Emote, Clear, Timeout, Ban, Slow and Raid. Check out our current list of streamers! [Current Streamers List](https://github.com/TabletopsAndAnvils/Foundry-Stream-Module/blob/main/streamers.md) If you would like your stream added to the list, drop at message to me over at [Discord](https://discord.gg/sR8MTsgWSc)

4 | 5 |

6 | # General # 7 | This is my first time programming anything in about 27 years, as such, there may be a few glitches here and there. Just understand that I've been a professional blacksmith and bladesmith for more than two and a half decades and programming is a lot different than swinging a hammer! I love the community around Foundry VTT and wanted to give a little back, so here it is, this is my hobby project - what I do to relax - although there's been a few tense moments just to get this first release out! If you find it useful, great! I hope that you like it! As my programming skills grow I hope this module grows with them.

8 | 9 |

10 | 11 | YouTube: Introducing Foundry Stream Module 12 | 13 | ## Change Log ## 14 | The most recent [changelog.md](https://github.com/TabletopsAndAnvils/Foundry-Stream-Module/blob/main/changelog.md) 15 | 16 |

17 | ## Configuration ## 18 | - `Twitch Channel` - This is your Twitch stream name. 19 | - `User Name` - For your Twitch username or registered bot name, to be used in the future for sending messages back to Twitch. Capitalization may affect echoing. If you're not receiving messages from Twitch but messages are going out, try all lowercase for the user name. 20 | - `Twitch OAuth Token` - OAuth token for the user above. Without it you will only be able to receive messages but rolls, chat etc will not be sent to Twitch. If you do not have a OAuth token for your Twitch stream, simply log in to Twitch with your browser, open a tab and go to https://twitchapps.com/tmi/ - follow the prompts and your OAuth token will be generated. This will be obfuscated on saving for added security. 21 | - `/t Twitch Chat Command` - Messages to Twitch should use /t command in chat window, messages without will be ignored and only sent to other clients in Foundry. Please note, this setting requires all connected clients to refresh on change. 22 | - `Out to Twitch` - Check to send Foundry chat messages to Twitch channel. 23 | - `Receive Twitch` - Enable to receive messages from your configured Twitch channel. 24 | - `Moderation Access Level` - Every once in a while a GM may need help with moderating a Twitch channel. Select user role to allow access to the module moderation controls. 25 | - `Chat Type` - How incoming messages from Twitch should be assigned. Depending on different modules being used, it may be desirable to change how a chat card is created. Options are OOC, IC, Emote, Roll and Other. Default setting is OOC. 26 | - `Quiet Mode` - Filters rolls such as attacks, checks and spells from being sent to Twitch, only allows OOC, IC, Emote and Other to be passed along to the stream. 27 | - `Send Connect Message` - Turn on/off announcement message when connecting to a Twitch channel chat.

28 | - `Announcements` - These are announcements to be broadcast to your channel every x seconds. 29 | - `Chat Dice` - Turn on/off the dice roller in Twitch Chat. 30 | 31 | ## Features ## 32 | - `Chat` - Two way communication between Foundry and Twitch. 33 | - `GM Moderation` - On the side controls there are buttons to Clear Twitch chat, Timeout or Ban viewers and a Raid button. Please note, in order for the Raid function to work you must be signed in through a browser as well in order to click on confirmation dialog. 34 | - `Roll Request` - GM/Moderator can request a roll from a Twitch viewer. If DSN is enabled the dice will roll within the Foundry canvas, if not the result will just be sent to the chat card. 35 | 36 | # Links # 37 | * https://www.twitch.tv/tabletopsandanvils - My Twitch.tv where we livestream. 38 | * https://www.patreon.com/tabletopsandanvils - See what else I'm doing for Foundry. 39 | * https://www.youtube.com/channel/UCx1lu5HlZtmmk4JtsU_noSw - Tabletops & Anvils on Youtube. 40 | 41 | ## Acknowledgements ## 42 | Many thanks go out to the entire FoundryVTT community especially Atropos for creating it, just about everyone over in the #module-development channel on the FVTT Discord, League of Extraordinary FoundryVTT Developers, cwendrowski for creating Tabbed Chatlog, Melbz who wrote his own Twitch-bot for Foundry (https://bitbucket.org/Melbz/foundryvtt-twitch-bot/src/master/) that pointed me in the right direction for starting this module and Pint and Pie (https://github.com/thomasmckay) who is doing things with Twitch and Foundry that are absolutely mind-numbingly insane. His play through chat module lit the spark of inspiration for Foundry Stream Module many, many months ago! 43 | 44 | ## License 45 | - This work is licensed under a [Creative Commons Attribution 4.0 International License](https://creativecommons.org/licenses/by/4.0/legalcode). 46 | - This work is licensed under the [Foundry Virtual Tabletop EULA - Limited License Agreement for Module Development](https://foundryvtt.com/article/license/). 47 | 48 | ### Bugs 49 | - View current known bugs in the [Issue Tracker Backlog](https://github.com/TabletopsAndAnvils/Foundry-Stream-Module/issues) 50 | -------------------------------------------------------------------------------- /changelog.md: -------------------------------------------------------------------------------- 1 | ## Release 0.2.8 2 | - Fix casting bug (streamChatType) 3 | - Add prefix in chat message from Twitch 4 | - Add settings for hiding Twitch Chat 5 | - Add settings for customizing command alias 6 | - Optimizing chat message filtering 7 | - Fix button click don't work 8 | 9 | ## Release 0.2.7 10 | - Added user requested feature for a chat command. When enabled, only messages using /t will go to Twitch and appear in the Twitch tab, all other messages will not be sent and remain in the Foundry tab. This may become the default standard going forward with FSM for 0.8.x but I plan to listen to user opinions. 11 | - Removed the IC to OOC chat configuration from the config panel. 12 | - Updated localization to reflect above changes. 13 | 14 | ## Release 0.2.6 15 | - Added user requested output to dice roll requests. Roll request now outputs the forumula + rolltotal to Twitch after a request has been rolled. Ie 'Julia rolls 16 | 1d20 = [19] Thank you for the roll!' 17 | - Updated localization file to reflect above change. 18 | - Updated default configuration for above. 19 | 20 | ## Release 0.2.5 21 | - Minor hotfix to module.json 22 | 23 | ## Release 0.2.4 24 | - Added option from directly within Request Roll to hide the roll from players. This is not a blindroll, it is a gmroll to the GM and/or their moderator(s) 25 | depending on who made the request. While this has always been possible by using the drop down selector in the chat box itself, this is here as a matter of 26 | convenience for GM's and moderators. If a GM requests a private roll it will only been seen by the GM until it is revealed, however if a moderator requests 27 | a private roll, the roll (if using DSN) and result will be seen by the moderator and the GM. As normal, a private roll can be revealed by right clicking 28 | on it. 29 | - Added Request Roll localization support from within module configuration. Users can now customize the messages sent to Twitch regarding roll requests. 30 | Two option tags are available for these strings: ${dice} returns the roll request (ie 1d20) and ${who} returns who the request is made of if required. 31 | - Updated documentation in compendium. 32 | - Cleaned up code and structure in preparation for 0.8.x migration. 33 | 34 | ## Release 0.2.3 35 | - Fixed url in modules.json 36 | - Quick fix for language modification. You can now edit the language file for custom roll messages. Be sure to still include the trigger '!gm' and the variables 37 | '${who}' for the viewer name and '${dice}' for the dice to request. This is an advance method and should only be done by people familiar and comfortable with 38 | editing .json files as any error in the formatting of this file will not allow the module to load. I highly recommend making a backup of the original first! In 39 | the future, when I have the time to re-work the configuration of the module, I will make this editable from within Foundry itself. This is just a short term 40 | fix per user requests. PS, if you're editing the language .json in a language other than English that is currently supported byt Foundry, please share it on 41 | my github or Discord server so I can consider including it in future versions! 42 | 43 | ## Release 0.2.2u 44 | - Minor update to emotes. Emotes were being sent to chat cards even when Receive from Twitch was disabled. 45 | 46 | ## Release 0.2.2r 47 | - Added confirmation dialog for Clear Twitch Chat. 48 | - Bug fix regarding turning off receiving chat messages from Twitch where even when turned off, clients were still receiving messages. 49 | - Added obfuscation of the Twitch OAuth token. On save the OAuth token will appear scrambled, it's totally fine! I just added this for streamers who may be showing 50 | backend configuration in their streams to add a little bit of protection. 51 | - Removed Sub only mode, should be temporary. Looking into whether Twitch has depreciated the tag. 52 | - Removed Hide from Stream View temporarily. It will most likely be back in the immediate future, just waiting to see what changes may be made come the release 53 | of Foundry VTT 0.8.0. 54 | 55 | ## Release 0.2.1 56 | - Twitch Emotes are now passed into Foundry from Twitch chat! 57 | - Subscriber Mode: You can now select to only allow subscriber chat messages to be passed from Twitch to Foundry. Anyone with moderator status is not affected. This 58 | also affects the Request Dice Roll system but not the Twitch only dice rolling system, that will still need to be toggled off separately. This is a great 59 | feature to add incentive to Subscribing to your channel, unfortunately Twitch does not allow Followers to be tagged at this time so a similar feature for Followers 60 | will not be in the immediate future. 61 | 62 | ## Release 0.2.0r 63 | - Added inline tabbed chatting system! FSM now comes with a tabbed chatting system built in. By default this is on, however it can be turned off by enabling Legacy Mode. 64 | The tabbed chat is simple and a convenient way to keep the Foundry chat you know but also provide a separate tab where all Twitch messages go. It has been tested with 65 | Tabbed Chatlog and doesn't appear to have any conflicts, at least on my setup, your mileage might vary depending on what modules that affect the chat system you are running. 66 | - Added /stream hiding. For those broadcasting using the built in stream resources of Foundry you may want to hide the tabbed chat from your overlay. By default this 67 | feature is not enabled. 68 | - In game documentation created as an installed Journal Entry in the Compendium. 69 | - Reorganized the code from the ground up. 70 | 71 | ## Release 0.1.7 72 | - Just some minor tweaking and cleaning up some errant code. 73 | 74 | ## Release 0.1.6r 75 | - Added GM roll requests. GM/Moderator can ask Twitch viewers for a roll (ie 1d100 or 4d6+4, etc) and the first person to respond will 76 | roll the dice in Foundry. IF GM/Moderator specifies a viewer name it will wait for that player to roll, ignoring anyone else. A great 77 | way to make your viewers more involved with your games! Also works with Dice-so-Nice! 78 | - Join notifications/messages. This may be depreciated, testing it out to see if it works. May be limited on large channels and only 79 | sends messages in batches whenever it feels like it. 80 | - Emote/ Broadcast button added to canvas layer. 81 | - Added a filter to stop excess roll results and announcements. 82 | - Added configuration option to turn off Dice Roller in Twitch chat, this does not affect GM/Mod request rolls. 83 | 84 | ## Release 0.1.5r 85 | - Added a dice roller for viewers on Twitch. Now viewers can roll along with your players in Twitch! Just type !roll 3d8+5 etc in the 86 | Twitch chat and they can roll alongside you! Added a filter to catch the roll requests so they don't clutter up the chat window. The 87 | roller can handle multiple types of dice, with a range of modifiers and mathematical functions! 88 | - Added an initial response for Subs and re-Subs. I think this works but I don't have any subs to test it out. lol 89 | - Added two customizeable timed announcements for the channel. Announcements can be set up to fire every x number of seconds, use it to 90 | let new viewers know what's going on, or even how to use that fancy new dice roller! 91 | - Created macro usuable functions, streamOut, streamIn, triggerStream and awaitStream. These will most likely be refined over time and more will be 92 | added as needed. Unfortunately the Twitch API is limited in information that it passes along so tasks such as recognizing Followers is not 93 | supported at this time. I added a file called fsmMacro.js on Github with some examples of use. Macro capability is not very robust at this 94 | time but it's definitely a start! 95 | - Reworked structure, as always. 96 | 97 | ## Release 0.1.4 98 | - Added whisper filter, this stops all private messages between players or gm/players from being relayed. 99 | - Added Quiet mode, stops rolls such as attack, checks and spells from being relayed into stream chat. 100 | - Changed the way the speaker of a message from Foundry is identified on the Twitch chat. Speaker is now highlighted as \[Speaker\]: 101 | 102 | ## Release 0.1.3 103 | - Added ability to set the chat card type. Depending on modules being used, such as Tabbed Chatlog, changing the type of message will affect 104 | where the messages from the stream appears in Foundry. Choices are OOC, IC, Emote, Roll and Other. 105 | - Added option to connect to a stream channel chat silently without announcement. While useful for testing, it may not be desireable to 106 | have it announce a connection in a situation where there might be frequent reconnects. 107 | - Changed the Moderation Role configuration to a drop down style selection instead of a string input. 108 | 109 | ## Release 0.1.2 110 | - Added filters in Foundry=>Twitch hook to remove extraneous information being sent to Twitch chat. 111 | - Created modLayers.js, moved canvas layer control functions from main module. 112 | - Updated utils.js to remove unused code. 113 | 114 | ## Initial Public Release - 21.01.19 115 | - Foundry Stream Modue is a mod for integrating Twitch chat from streams into Foundry Virtual Tabletop. Foundry Stream Module sends player chats, rolls, interactions to the Twitch stream chat and allows viewers in the Twitch chat to send messages to the players as an out of character message. GM's or another configurable user role can also moderate the Twitch chat via canvas control buttons for actions such as Clear, Timeout, Ban, Slow and Raid. 116 | 117 | ### New Features 118 | - Integrate chat between Foundry and Twitch. 119 | - Moderation of Twitch chat channels. 120 | 121 | ### Bug Fixes 122 | - Added a redundancy check to stop duplicate messages when more than one GM was on the server. 123 | 124 | ### Improvements 125 | - Improved the handling of configuration to just GM roles over the previous GM and User roles. 126 | -------------------------------------------------------------------------------- /fsminit.js: -------------------------------------------------------------------------------- 1 | // (F O U N D R Y - S T R E A M - M O D 0 . 2 . 7) 2 | 3 | //(() => {})(); 4 | 5 | import "./scripts/tmi.min.js"; // I M P O R T S 6 | import * as fsmcore from "./scripts/fsmcore.js"; 7 | import { fsMod } from "./scripts/streamTwitch.js"; 8 | import fsmLayer from "./scripts/modLayer.js"; 9 | import * as settings from "./scripts/settings.js"; 10 | import { DiceRoller } from "https://cdn.jsdelivr.net/npm/rpg-dice-roller@4.5.2/lib/esm/bundle.min.js"; 11 | 12 | const roller = new DiceRoller(); // C O N S T A N T S A N D V A R I A B L E S 13 | const CHAT_MESSAGE_TYPES = { 14 | OTHER: 0, 15 | OOC: 1, 16 | IC: 2, 17 | EMOTE: 3, 18 | WHISPER: 4, 19 | ROLL: 5, 20 | }; 21 | 22 | let currentTab = "foundry"; 23 | 24 | Hooks.on("renderChatLog", async function (chatLog, html, user) { 25 | // S O R T T A B B E D M S G S 26 | 27 | if (fsmcore.TabbedChat()) return; 28 | if (game.settings.get("streamMod", "hideTwitchChat")) return; 29 | 30 | var toPrepend = '`; 33 | html.prepend(toPrepend); 34 | 35 | var me = this; 36 | const tabs = new TabsV2({ 37 | navSelector: ".tabs", 38 | contentSelector: ".content", 39 | initial: "tab1", 40 | callback: function (event, html, tab) { 41 | currentTab = tab; 42 | let chatLog = $("#chat-log"); 43 | 44 | let itemType0 = chatLog.find(".type0"); 45 | let itemType1 = chatLog.find(".type1"); 46 | let itemType2 = chatLog.find(".type2"); 47 | let itemType3 = chatLog.find(".type3"); 48 | let itemType4 = chatLog.find(".type4"); 49 | let itemType5 = chatLog.find(".type5"); 50 | if (tab == "foundry") { 51 | itemType0.removeClass("hardHide"); 52 | itemType0.show(); 53 | itemType1.hide(); 54 | itemType2.removeClass("hardHide"); 55 | itemType2.show(); 56 | itemType3.removeClass("hardHide"); 57 | itemType3.show(); 58 | itemType4.removeClass("hardHide"); 59 | itemType4.show(); 60 | itemType5.removeClass("hardHide"); 61 | itemType5.not(".gm-roll-hidden").show(); 62 | 63 | $("#foundryNotification").hide(); 64 | } else if (tab == "fsm") { 65 | itemType1.removeClass("hardHide"); 66 | itemType1.show(); 67 | itemType2.hide(); 68 | itemType3.hide(); 69 | itemType4.hide(); 70 | itemType5.hide(); 71 | itemType0.hide(); 72 | 73 | $("#fsmNotification").hide(); 74 | } else { 75 | console.log("Unknown tab " + tab + "!"); 76 | } 77 | 78 | chatLog.scrollTop(9999999); 79 | }, 80 | }); 81 | tabs.bind(html[0]); 82 | }); 83 | 84 | Hooks.on("renderChatMessage", (chatMessage, html, data) => { 85 | // R E N D E R T A B B E D C H A T 86 | 87 | //if (fsmcore.TabbedChat()) return; 88 | 89 | html.addClass("type" + data.message.type); 90 | 91 | var sceneMatches = true; 92 | 93 | if ( 94 | data.message.type == 0 || 95 | data.message.type == 2 || 96 | data.message.type == 3 || 97 | data.message.type == 4 || 98 | data.message.type == 5 99 | ) { 100 | if (data.message.speaker.scene != undefined) { 101 | html.addClass("scenespecific"); 102 | html.addClass("scene" + data.message.speaker.scene); 103 | if (data.message.speaker.scene != game.user.viewedScene) { 104 | sceneMatches = false; 105 | } 106 | } 107 | } 108 | 109 | if (currentTab == "foundry") { 110 | /*if ( 111 | (fsmcore.xCmd()) && 112 | data.message.type == 1) { 113 | data.message.type == 2}*/ 114 | if ( 115 | (data.message.type == 2 || 116 | data.message.type == 0 || 117 | data.message.type == 4 || 118 | data.message.type == 3) && 119 | sceneMatches 120 | ) { 121 | html.css("display", "list-item"); 122 | } else if (data.message.type == 5 && sceneMatches) { 123 | if (!html.hasClass("gm-roll-hidden")) { 124 | if ( 125 | game.dice3d && 126 | game.settings.get("dice-so-nice", "settings").enabled && 127 | game.settings.get("dice-so-nice", "enabled") 128 | ) { 129 | if ( 130 | !game.settings.get("dice-so-nice", "immediatelyDisplayChatMessages") 131 | ) 132 | return; 133 | } 134 | html.css("display", "list-item"); 135 | } 136 | } else { 137 | html.css("display", "none"); 138 | html.css("cssText", "display: none !important;"); 139 | html.addClass("hardHide"); 140 | } 141 | } else if (currentTab == "fsm") { 142 | if (data.message.type == 1) { 143 | html.css("display", "list-item"); 144 | } else { 145 | html.css("display", "none"); 146 | } 147 | } 148 | }); 149 | 150 | Hooks.on("diceSoNiceRollComplete", (id) => { 151 | // P L A Y N I C E W I T H D S N 152 | 153 | if (fsmcore.TabbedChat()) return; 154 | 155 | if (currentTab != "foundry") { 156 | $("#chat-log .message[data-message-id=" + id + "]").css("display", "none"); 157 | } 158 | }); 159 | 160 | Hooks.on("createChatMessage", (chatMessage, content) => { 161 | // C H A T N O T I F I C A T I O N S 162 | 163 | if (fsmcore.TabbedChat()) return; 164 | 165 | var sceneMatches = true; 166 | 167 | if (chatMessage.data.speaker.scene) { 168 | if (chatMessage.data.speaker.scene != game.user.viewedScene) { 169 | sceneMatches = false; 170 | } 171 | } 172 | 173 | if ( 174 | chatMessage.data.type == 0 || 175 | chatMessage.data.type == 2 || 176 | chatMessage.data.type == 3 || 177 | chatMessage.data.type == 4 178 | ) { 179 | if (currentTab != "foundry" && sceneMatches) { 180 | $("#foundryNotification").show(); 181 | } 182 | } else if (chatMessage.data.type == 5) { 183 | if ( 184 | currentTab != "foundry" && 185 | sceneMatches && 186 | chatMessage.data.whisper.length == 0 187 | ) { 188 | $("#foundryNotification").show(); 189 | } 190 | } else if (chatMessage.data.type == 1) { 191 | if (currentTab != "fsm" && sceneMatches) { 192 | $("#fsmNotification").show(); 193 | } 194 | } else { 195 | if (currentTab != "fsm") { 196 | $("#fsmNotification").show(); 197 | } 198 | } 199 | }); 200 | 201 | Hooks.on("preCreateChatMessage", (chatMessage, content) => { 202 | // T U R N I C M S G S I N T O O O C I F x C m d O F F 203 | if (fsmcore.xCmd()) { 204 | if (currentTab == "foundry") { 205 | if (chatMessage.type == 2) { 206 | chatMessage.type = 2; 207 | } 208 | } 209 | } 210 | if (!fsmcore.xCmd()) { 211 | if (game.settings.get("streamMod", "icChatInOoc")) { 212 | if (currentTab == "fsm") { 213 | if (chatMessage.type == 2) { 214 | chatMessage.type = 1; 215 | delete chatMessage.speaker; 216 | console.log(chatMessage); 217 | } 218 | } 219 | } 220 | } 221 | }); 222 | 223 | Hooks.on("renderSceneNavigation", (sceneNav, html, data) => { 224 | // R E N D E R N A V F O R T A B S 225 | if (fsmcore.TabbedChat()) return; 226 | 227 | var viewedScene = sceneNav.scenes.find((x) => x.isView); 228 | 229 | $(".scenespecific").hide(); 230 | if (currentTab == "fsm") { 231 | $(".type1.scene" + game.user.viewedScene).removeClass("hardHide"); 232 | $(".type1.scene" + viewedScene.id).show(); 233 | } else if (currentTab == "foundry") { 234 | $(".type0.scene" + game.user.viewedScene).removeClass("hardHide"); 235 | $(".type0.scene" + viewedScene.id).show(); 236 | $(".type2.scene" + game.user.viewedScene).removeClass("hardHide"); 237 | $(".type2.scene" + viewedScene.id).show(); 238 | $(".type3.scene" + game.user.viewedScene).removeClass("hardHide"); 239 | $(".type3.scene" + viewedScene.id).show(); 240 | $(".type4.scene" + game.user.viewedScene).removeClass("hardHide"); 241 | $(".type4.scene" + viewedScene.id).show(); 242 | $(".type5.scene" + game.user.viewedScene).removeClass("hardHide"); 243 | $(".type5.scene" + viewedScene.id) 244 | .not(".gm-roll-hidden") 245 | .show(); 246 | } 247 | }); 248 | 249 | Hooks.on("init", function () { 250 | // M O D - S E T T I N G S 251 | settings.registerSettings(); 252 | }); 253 | 254 | Hooks.once("canvasReady", () => { 255 | // C A N V A S L A Y E R 256 | // Add fsmLayer to canvas 257 | const layerct = canvas.stage.children.length; 258 | let tbLayer = new fsmLayer(); 259 | 260 | tbLayer.setButtons(); 261 | tbLayer.roleTest(); 262 | canvas.fsMod = canvas.stage.addChildAt(tbLayer, layerct); 263 | canvas.fsMod.draw(); 264 | 265 | let theLayers = Canvas.layers; 266 | theLayers.fsMod = fsmLayer; 267 | 268 | Object.defineProperty(Canvas, "layers", { 269 | get: function () { 270 | return theLayers; 271 | }, 272 | }); 273 | }); 274 | 275 | Hooks.on("ready", function () { 276 | // O N - R E A D Y - C O N N E C T I O N S 277 | 278 | fsmcore.SetupTwitchClient(); 279 | onStream(); 280 | fsmcore.streamDice(); 281 | fsmcore.AnnounceTime1(); 282 | fsmcore.AnnounceTime2(); 283 | }); 284 | 285 | Hooks.on("createChatMessage", async (message) => { 286 | // F O U N D R Y => T W I T C H 287 | if (fsmcore.xCmd()) return; 288 | if (message.data.type === 4) return; 289 | let testQuiet = game.settings.get("streamMod", "streamQuiet"); 290 | if (testQuiet === true) { 291 | if (message.data.type === 0) return; 292 | if (message.data.type === 5) return; 293 | if (message.export().includes("Stream Chat")) return; 294 | if (message.export().includes("#00000004.0000AC0")) return; 295 | if (game.settings.get("streamMod", "streamModEcho")) { 296 | let firstGm = game.users.find((u) => u.isGM && u.active); 297 | if (firstGm && game.user === firstGm) { 298 | let myChannel = game.settings.get("streamMod", "streamChannel"); 299 | let tempAlias = message.alias; 300 | let tempM = message.export(); 301 | let res = tempM.slice(23); 302 | let res1 = res.replace(/(^|\s)] \s?/g, " "); // Removes '] ' that may appear when stripping the timestamp 303 | let res2 = res1.replace(/(^|\s)Damage Apply Apply Half\s?/g, " "); // <= PF1e specific roll cleanup 304 | let res3 = res2.replace(/(^|\s)Info Attack Action\s?/g, " "); // <= PF1e specific roll cleanup 305 | let fin = res3.replace(tempAlias, "[" + tempAlias + "]: "); 306 | fsMod.client.say(myChannel, fin); 307 | } 308 | } 309 | }}); 310 | 311 | Hooks.on('preCreateChatMessage', (data, opts, usr) => { 312 | if (!fsmcore.xCmd()) return 313 | if (game.user.isGM && data.type === CONST.CHAT_MESSAGE_TYPES.OOC) data.type = CONST.CHAT_MESSAGE_TYPES.IC; 314 | }) 315 | 316 | Hooks.on("chatCommandsReady", function(chatCommands) { 317 | if (!fsmcore.xCmd()) { 318 | console.log("Registering Chat Commands: OFF") 319 | let ctype = game.settings.get("streamMod", "streamChatType"); 320 | chatCommands.registerCommand(chatCommands.createCommandFromData({ 321 | commandKey: "/t", 322 | invokeOnCommand: (chatlog, messageText, chatdata) => { 323 | ChatMessage.create({ 324 | speaker: { 325 | alias: "Foundry Stream Module" 326 | }, 327 | content: `Guru Meditation: Error #00000004.0000AC0 - Message not sent to Twitch because you used the /t command without having it enabled in your FSM config.` 328 | }); 329 | console.log(messageText); 330 | }, 331 | shouldDisplayToChat: false, 332 | createdMessageType: ctype, 333 | iconClass: "fa-sticky-note", 334 | description: "Please enable in FSM config" 335 | })); 336 | return 337 | } 338 | if (fsmcore.xCmd()) { 339 | console.log("Registering Chat Commands: ON") 340 | let ctype = game.settings.get("streamMod", "streamChatType"); 341 | chatCommands.registerCommand(chatCommands.createCommandFromData({ 342 | commandKey: "/t", 343 | invokeOnCommand: (chatlog, messageText, chatdata) => { 344 | let who = chatdata.speaker.alias; 345 | streamOut(messageText, who); 346 | console.log(messageText, chatdata.speaker.alias); 347 | }, 348 | shouldDisplayToChat: true, 349 | createdMessageType: ctype, 350 | iconClass: "fa-sticky-note", 351 | description: "Sends message to Twitch" 352 | })); 353 | console.log("commandKey loaded") 354 | } 355 | 356 | }); -------------------------------------------------------------------------------- /img/Screen Shot 2021-01-15 at 20.26.16.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/TabletopsAndAnvils/Foundry-Stream-Module/bf6a5f6d6a537dd234b20d6695288d4bb59a4333/img/Screen Shot 2021-01-15 at 20.26.16.png -------------------------------------------------------------------------------- /img/Screen Shot 2021-01-18 at 21.26.14.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/TabletopsAndAnvils/Foundry-Stream-Module/bf6a5f6d6a537dd234b20d6695288d4bb59a4333/img/Screen Shot 2021-01-18 at 21.26.14.png -------------------------------------------------------------------------------- /img/Screen Shot 2021-01-18 at 21.27.40.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/TabletopsAndAnvils/Foundry-Stream-Module/bf6a5f6d6a537dd234b20d6695288d4bb59a4333/img/Screen Shot 2021-01-18 at 21.27.40.png -------------------------------------------------------------------------------- /img/Screen Shot 2021-01-18 at 21.31.43.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/TabletopsAndAnvils/Foundry-Stream-Module/bf6a5f6d6a537dd234b20d6695288d4bb59a4333/img/Screen Shot 2021-01-18 at 21.31.43.png -------------------------------------------------------------------------------- /img/Screen Shot 2021-01-18 at 21.32.30.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/TabletopsAndAnvils/Foundry-Stream-Module/bf6a5f6d6a537dd234b20d6695288d4bb59a4333/img/Screen Shot 2021-01-18 at 21.32.30.png -------------------------------------------------------------------------------- /img/Screen Shot 2021-01-19 at 22.03.50.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/TabletopsAndAnvils/Foundry-Stream-Module/bf6a5f6d6a537dd234b20d6695288d4bb59a4333/img/Screen Shot 2021-01-19 at 22.03.50.png -------------------------------------------------------------------------------- /img/Screen Shot 2021-01-19 at 22.22.52.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/TabletopsAndAnvils/Foundry-Stream-Module/bf6a5f6d6a537dd234b20d6695288d4bb59a4333/img/Screen Shot 2021-01-19 at 22.22.52.png -------------------------------------------------------------------------------- /img/Screen Shot 2021-01-25 at 17.12.24.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/TabletopsAndAnvils/Foundry-Stream-Module/bf6a5f6d6a537dd234b20d6695288d4bb59a4333/img/Screen Shot 2021-01-25 at 17.12.24.png -------------------------------------------------------------------------------- /img/Screen Shot 2021-02-01 at 02.39.54.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/TabletopsAndAnvils/Foundry-Stream-Module/bf6a5f6d6a537dd234b20d6695288d4bb59a4333/img/Screen Shot 2021-02-01 at 02.39.54.png -------------------------------------------------------------------------------- /img/fsm-cover-mid.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/TabletopsAndAnvils/Foundry-Stream-Module/bf6a5f6d6a537dd234b20d6695288d4bb59a4333/img/fsm-cover-mid.png -------------------------------------------------------------------------------- /img/fsm-cover.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/TabletopsAndAnvils/Foundry-Stream-Module/bf6a5f6d6a537dd234b20d6695288d4bb59a4333/img/fsm-cover.png -------------------------------------------------------------------------------- /lang/en.json: -------------------------------------------------------------------------------- 1 | { 2 | "I18N.LANGUAGE": "English", 3 | "I18N.MAINTAINERS": "Mr_Underhill", 4 | 5 | ".title": "Foundry Stream Module", 6 | 7 | "fsMod.settings.twitchChannel.name": "Twitch Channel", 8 | "fsMod.settings.twitchChannel.hint": "Twitch Channel to integrate.", 9 | 10 | "fsMod.settings.twitchUN.name": "Twitch Username", 11 | "fsMod.settings.twitchUN.hint": "You or your bot's Twitch.tv username entered exactly as it appears in chat, it is case sensitive. This account should have /mod settings for your channel in order to use certain functions. Please note, that in order for a raid to work you must be logged in to this account through a browser in order to click the confirmation dialog.", 12 | 13 | "fsMod.settings.twitchAuth.name": "Twitch OAuth Token", 14 | "fsMod.settings.twitchAuth.hint": "OAuth token for the user above. Without it you will only be able to receive messages but rolls, chat etc will not be sent to Twitch. Please note, for security purposes the token will be obfuscated after saving. It is recommended that you record your token in a safe place in the event you need to change this setting in the future.", 15 | 16 | "fsMod.settings.streamRole.name": "Moderation Access Level", 17 | "fsMod.settings.streamRole.hint": "A GM may need some help with moderating a Twitch stream. Set the minimum user role level to have access to the moderation controls. Default setting is Gamemaster. This does not give the user access to the configuration of the module itself.", 18 | 19 | "fsMod.settings.subCheck.name": "Subscribers Only", 20 | "fsMod.settings.subCheck.hint": "Ignore viewers and Followers, only pass Subscriber chats to FSM. Moderators will still be able to send messages.", 21 | 22 | "fsMod.settings.streamConnect.name": "Send Connect Message", 23 | "fsMod.settings.streamConnect.hint": "By default a connection message is sent to the stream chat when a client successfully connects.", 24 | 25 | "fsMod.settings.fsbotEcho.name": "Send to Twitch", 26 | "fsMod.settings.fsbotEcho.hint": "Enable to send Foundry chats to Twitch Channel.", 27 | 28 | "fsMod.settings.fsModAllChatMessages.name": "Receive from Twitch", 29 | "fsMod.settings.fsModAllChatMessages.hint": "Enable to receive chats from Twitch Channel.", 30 | 31 | "fsMod.settings.streamQuiet.name": "Quiet Mode", 32 | "fsMod.settings.streamQuiet.hint": "Don't send rolls such as attacks, checks or spells to the stream chat.", 33 | 34 | "fsMod.settings.streamAnounce.name": "Announcement", 35 | "fsMod.settings.streamAnounce.hint": "Announcement to be posted to the stream chat.", 36 | 37 | "fsMod.settings.tabbedChat.name": "Legacy Mode", 38 | "fsMod.settings.tabbedChat.hint": "Hide the Tabbed Chat, use legacy-style Foundry chat.", 39 | 40 | "fsMod.settings.IcChatInOoc.name": "IC Chat to OOC", 41 | "fsMod.settings.IcChatInOoc.hint": "Transform In Character to Out of Character chat.", 42 | 43 | "fsMod.settings.streamDice.name": "Chat Dice", 44 | "fsMod.settings.streamDice.hint": "FSM includes a highly advanced dice roller available for viewers in chat accessible by typing !roll [formula] for your players to entertain themselves and roll along. These rolls do not appear in Foundry.", 45 | 46 | "fsMod.settings.streamRoll.name": "General Roll Request", 47 | "fsMod.settings.streamRoll.hint": "This is the message to send to Twitch when requesting a viewer to roll dice. ${dice} is for the requested dice. Example: The GM is requesting a viewer to roll! [Type !gm ${dice} to roll]", 48 | 49 | "fsMod.settings.streamRoll2.name": "Specific Roll Request", 50 | "fsMod.settings.streamRoll2.hint": "This is the message to send to Twitch when requesting a specified viewer to roll dice. ${dice} is for the requested dice, ${who} is the viewer the request is being made of. Example: The GM is requesting ${who} to roll! [Type !gm ${dice} to roll]", 51 | 52 | "fsMod.settings.streamAnounceT.name": "Interval", 53 | "fsMod.settings.streamAnounceT.hint": "How often should this be posted to the stream. Enter time in seconds, 0 to turn off. You may need to refresh after saving to make new settings take effect.", 54 | 55 | "fsMod.settings.chatType.name" : "Chat Type", 56 | "fsMod.settings.chatType.hint" : "How the incoming messages from the stream should be assigned. Depending on the modules you may be running it might be desirable to change how the chat card is assigned so it appears where you want it. Default is Out of Character which is designed to work with the inline tabbed chat feature.", 57 | 58 | "fsMod.tabs.foundry": "Foundry", 59 | "fsMod.tabs.fsm": "Twitch", 60 | 61 | "fsMod.settings.xCmd.name" : "/t Twitch Chat Command", 62 | "fsMod.settings.xCmd.hint" : "Messages to Twitch should use /t command in chat window, messages without will be ignored and only sent to other clients in Foundry. Please note, this setting requires all connected clients to refresh on change.", 63 | 64 | "fsMod.settings.thankRoll.name": "Roll Received Message", 65 | "fsMod.settings.thankRoll.hint": "How you want to thank your viewer for their roll. The output for this message is 'viewername rolls diceformula = [dicetotal] yourmessage' Example: Julia rolls 1d20 = [19] Thank you for the roll!", 66 | 67 | "fsMod.settings.hideTwitchChat.name": "Hide Twitch Chat", 68 | "fsMod.settings.hideTwitchChat.hint": "Don't show Twitch chat. (Browser refresh required)", 69 | 70 | "fsMod.settings.chatCommandAlias.name": "Chat command alias", 71 | "fsMod.settings.chatCommandAlias.hint": "Enter the word for roll command. Default if 'GM'" 72 | } 73 | -------------------------------------------------------------------------------- /lib/bot.js: -------------------------------------------------------------------------------- 1 | /*'use strict' 2 | 3 | const tls = require('tls') 4 | const assert = require('assert') 5 | const EventEmitter = require('events').EventEmitter 6 | 7 | const parser = require('./parser') 8 | */ 9 | 10 | const TwitchBot = class TwitchBot extends EventEmitter { 11 | // TODO: Make this parsing better 12 | listen() { 13 | this.irc.on('data', data => { 14 | this.checkForError(data) 15 | 16 | /* Twitch sends keep-alive PINGs, need to respond with PONGs */ 17 | if(data.includes('PING :tmi.twitch.tv')) { 18 | this.irc.write('PONG :tmi.twitch.tv\r\n') 19 | } 20 | 21 | if(data.includes('PRIVMSG')) { 22 | const chatter = parser.formatPRIVMSG(data) 23 | this.emit('message', chatter) 24 | } 25 | 26 | if(data.includes('CLEARCHAT')) { 27 | const event = parser.formatCLEARCHAT(data) 28 | if(event.type === 'timeout') this.emit('timeout', event) 29 | if(event.type === 'ban') this.emit('ban', event) 30 | } 31 | 32 | if(data.includes('USERNOTICE ')) { 33 | const event = parser.formatUSERNOTICE(data) 34 | if (['sub', 'resub'].includes(event.msg_id) ){ 35 | this.emit('subscription', event) 36 | } 37 | } 38 | 39 | if(data.includes(`@${this.username}.tmi.twitch.tv JOIN`)) { 40 | const channel = parser.formatJOIN(data) 41 | if(channel) { 42 | if(!this.channels.includes(channel)) { 43 | this.channels.push(channel) 44 | } 45 | this.emit('join', channel) 46 | } 47 | } 48 | 49 | if(data.includes(`@${this.username}.tmi.twitch.tv PART`)) { 50 | const channel = parser.formatPART(data) 51 | if(channel) { 52 | if(this.channels.includes(channel)) { 53 | this.channels.pop(channel) 54 | } 55 | this.emit('part', channel) 56 | } 57 | } 58 | }) 59 | } 60 | 61 | 62 | writeIrcMessage(text) { 63 | this.irc.write(text + "\r\n") 64 | } 65 | 66 | join(channel) { 67 | channel = parser.formatCHANNEL(channel) 68 | this.writeIrcMessage(`JOIN ${channel}`) 69 | } 70 | 71 | part(channel) { 72 | if(!channel && this.channels.length > 0) { 73 | channel = this.channels[0] 74 | } 75 | channel = parser.formatCHANNEL(channel) 76 | this.writeIrcMessage(`PART ${channel}`) 77 | } 78 | 79 | say(message, channel, callback ) { 80 | if(!channel) { 81 | channel = this.channels[0] 82 | } 83 | if(message.length >= 500) { 84 | this.cb(callback, { 85 | sent: false, 86 | message: 'Exceeded PRIVMSG character limit (500)' 87 | }) 88 | } else { 89 | this.writeIrcMessage('PRIVMSG ' + channel + ' :' + message) 90 | } 91 | } 92 | 93 | timeout(username, channel, duration=600, reason='') { 94 | if(!channel) { 95 | channel = this.channels[0] 96 | } 97 | this.say(`/timeout ${username} ${duration} ${reason}`, channel) 98 | } 99 | 100 | ban(username, channel, reason='') { 101 | if(!channel) { 102 | channel = this.channels[0] 103 | } 104 | this.say(`/ban ${username} ${reason}`, channel) 105 | } 106 | 107 | close() { 108 | this.irc.destroy() 109 | this.emit('close') 110 | } 111 | 112 | cb(callback, obj) { 113 | if(callback) { 114 | obj.ts = new Date() 115 | callback(obj) 116 | } 117 | } 118 | 119 | } 120 | 121 | module.exports = TwitchBot -------------------------------------------------------------------------------- /lib/parser.js: -------------------------------------------------------------------------------- 1 | //const _ = require('lodash') 2 | 3 | module.exports = { 4 | 5 | formatCHANNEL(channel){ 6 | channel = channel.toLowerCase() 7 | return channel.charAt(0) !== '#' ? '#' + channel : channel 8 | }, 9 | 10 | formatJOIN(event){ 11 | event = event.replace(/\r\n/g, '') 12 | return event.split('JOIN ')[1] 13 | }, 14 | 15 | formatPART(event){ 16 | event = event.replace(/\r\n/g, '') 17 | return event.split('PART ')[1] 18 | }, 19 | 20 | formatPRIVMSG(event) { 21 | const parsed = {} 22 | 23 | const msg_parts = event.split('PRIVMSG ')[1] 24 | let split_msg_parts = msg_parts.split(' :') 25 | const channel = split_msg_parts[0] 26 | 27 | if(split_msg_parts.length >= 2) { 28 | split_msg_parts.shift() 29 | } 30 | const message = split_msg_parts.join(' :').replace(/\r\n/g, '') 31 | 32 | let [tags,username] = event.split('PRIVMSG')[0].split(' :') 33 | parsed.username = username.split('!')[0] 34 | 35 | Object.assign(parsed,this.formatTAGS(tags)) 36 | parsed.mod = !!parsed.mod 37 | parsed.subscriber = !!parsed.subscriber 38 | parsed.turbo = !!parsed.turbo 39 | 40 | if(parsed.emote_only) parsed.emote_only = !!parsed.emote_only 41 | 42 | parsed.channel = channel 43 | parsed.message = message 44 | 45 | return parsed 46 | }, 47 | 48 | formatCLEARCHAT(event) { 49 | const parsed = {} 50 | 51 | const msg_parts = event.split('CLEARCHAT ')[1] 52 | let split_msg_parts = msg_parts.split(' :') 53 | 54 | const channel = split_msg_parts[0] 55 | const target_username = split_msg_parts[1] 56 | 57 | let [tags] = event.split('CLEARCHAT')[0].split(' :') 58 | Object.assign(parsed,this.formatTAGS(tags)) 59 | 60 | if(parsed.ban_reason) { 61 | parsed.ban_reason = parsed.ban_reason.replace(/\\s/g, ' ') 62 | } 63 | 64 | if(parsed.ban_duration) parsed.type = 'timeout' 65 | else parsed.type = 'ban' 66 | 67 | parsed.channel = channel 68 | if (target_username) { 69 | parsed.target_username = target_username.replace(/\r\n/g, '') 70 | } 71 | 72 | /* TODO: This needs a proper fix */ 73 | parsed.tmi_sent_ts = parseInt(parsed.tmi_sent_ts) 74 | 75 | return parsed 76 | }, 77 | 78 | formatTAGS(tagstring) { 79 | let tagObject = {} 80 | const tags =tagstring.replace(/\s/g,' ').split(';') 81 | 82 | tags.forEach(tag => { 83 | const split_tag = tag.split('=') 84 | const name = this.formatTagName(split_tag[0]) 85 | let val = this.formatTagVal(split_tag[1]) 86 | tagObject[name] = val 87 | }) 88 | 89 | if (tagObject.badges){ 90 | tagObject.badges = this.formatBADGES(tagObject.badges) 91 | } 92 | 93 | return tagObject 94 | }, 95 | 96 | formatBADGES(badges){ 97 | let badgesObj = {} 98 | if(badges) { 99 | badges = badges.split(',') 100 | 101 | badges.forEach(badge => { 102 | const split_badge = badge.split('/') 103 | badgesObj[split_badge[0]] = +split_badge[1] 104 | }) 105 | } 106 | return badgesObj 107 | }, 108 | 109 | 110 | formatUSERNOTICE(event){ 111 | const parsed = {} 112 | 113 | const msg_parts = event.split('USERNOTICE')[1] 114 | let split_msg_parts = msg_parts.split(' :') 115 | 116 | parsed.channel = split_msg_parts[0].trim() 117 | parsed.message = split_msg_parts[1] || null 118 | 119 | let tags = event.split('USERNOTICE')[0].split(':')[0].trim() 120 | 121 | Object.assign(parsed,this.formatTAGS(tags)) 122 | return parsed 123 | }, 124 | 125 | formatTagName(tag) { 126 | if(tag.includes('-')) { 127 | tag = tag.replace(/-/g, '_') 128 | } 129 | if(tag.includes('@')) { 130 | tag = tag.replace('@', '') 131 | } 132 | return tag.trim() 133 | }, 134 | 135 | formatTagVal(val) { 136 | if(!val) return null 137 | if(val.match(/^[0-9]+$/) !== null) { 138 | return +val 139 | } 140 | if (val.includes('\s')){ 141 | val = val.replace(/\\s/g, ' ') 142 | } 143 | return val.trim() 144 | } 145 | 146 | } -------------------------------------------------------------------------------- /module.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "streamMod", 3 | "title": "Foundry Stream Module", 4 | "description": "Implements two-way communication between Foundry VTT and Twitch, allowing for two-way chat plus adds dice rolling requests, a tabbed chat window, a separate dice engine for just for viewers, event handling and several moderation commands directly into Foundry itself, bringing your streamed game to the next level of interactivity!", 5 | "author": "MrUnderhill", 6 | "authors": [ 7 | { 8 | "name": "MrUnderhill", 9 | "url": "https://www.patreon.com/tabletopsandanvils", 10 | "email": "mr_underhill@icloud.com", 11 | "discord": "MrUnderhill#4707", 12 | "patreon": "TabletopsAndAnvils" 13 | } 14 | ], 15 | "version": "0.3.0", 16 | "minimumCoreVersion": "9", 17 | "compatibleCoreVersion" : "9", 18 | 19 | "styles": [ 20 | "/styles/fsmtabs.css" 21 | ], 22 | 23 | "esmodules": [ 24 | "/scripts/tmi.min.js", 25 | "/scripts/fsmcore.js", 26 | "/fsminit.js" 27 | ], 28 | "languages": [ 29 | { 30 | "lang": "en", 31 | "name": "English", 32 | "path": "/lang/en.json" 33 | } 34 | ], 35 | "packs":[ 36 | { 37 | "name": "documentation", 38 | "label": "Foundry Stream Module Documentation 0.2.4", 39 | "path": "packs/documentation.db", 40 | "entity": "JournalEntry", 41 | "module": "streamMod" 42 | } 43 | ], 44 | "dependencies":[ 45 | { 46 | "name": "_chatcommands", 47 | "type": "module", 48 | "manifest": "https://github.com/League-of-Foundry-Developers/Chat-Commands-Lib/releases/download/1.2.0/module.json" 49 | } 50 | ], 51 | "media":[ 52 | { 53 | "type": "cover", 54 | "link": "https://raw.githubusercontent.com/TabletopsAndAnvils/Foundry-Stream-Module/main/img/fsm-cover.png" 55 | } 56 | ], 57 | "bugs": "https://github.com/TabletopsAndAnvils/Foundry-Stream-Module/issues", 58 | "allowBugReporter": true, 59 | "url": "https://github.com/TabletopsAndAnvils/Foundry-Stream-Module", 60 | 61 | "manifest": "https://raw.githubusercontent.com/TabletopsAndAnvils/Foundry-Stream-Module/main/module.json", 62 | "download": "https://github.com/TabletopsAndAnvils/Foundry-Stream-Module/archive/0.3.0.zip" 63 | } 64 | -------------------------------------------------------------------------------- /packs/documentation.db: -------------------------------------------------------------------------------- 1 | {"_id":"6LuvhGTuKyAXcwkr","name":"Foundry Stream Module Documentation","permission":{"default":0,"w1x54ohimiGGgcC6":3},"folder":"","flags":{"core":{"sourceId":"JournalEntry.mATlGTrUk9RwkBUe"}},"content":"

Thank you for installing Foundry Stream Module!

Implements two-way communication between Foundry VTT and Twitch, allowing for two-way chat plus adds dice rolling requests, a tabbed chat window, a separate dice engine for just for viewers, event handling and several moderation commands directly into Foundry itself, bringing your streamed game to the next level of interactivity! I hope you enjoy the module and find it useful. Be sure to check out my other projects at https://www.patreon.com/tabletopsandanvils

Documentation

Configuration:

First, a little note about my setup. My Twitch channel is TabletopsAndAnvils however I created a second account for a 'bot', you can search online how to enable your email address to be used to register another account. After registering the second account I logged in with both of my accounts using separate browsers and gave the new account /mod capabilities. Without them you will not be able to use many of the functions and features of Foundry Stream Module. I'm not saying that you have to do it this way, but I found it useful. Also, our streaming name is rather long and I figured fsMod is a lot shorter for those compelled to read every character in a chat!

Twitch Channel - This is your Twitch stream name.

User Name - For your Twitch username or registered bot name, to be used in the future for sending messages back to

Twitch. Capitalization may affect echoing. If you're not recieving messages from Twitch but messages are going out, try all lowercase for the user name.

Twitch OAuth Token - OAuth token for the user above. Without it you will only be able to recieve messages but rolls, chat etc will not be sent to Twitch. If you do not have a OAuth token for your Twitch stream, simply log in to Twitch with your browser, open a tab and go to https://twitchapps.com/tmi/ - follow the prompts and your OAuth token will be generated.

Moderation Level - A GM may need some help with moderating a Twitch stream. Set the minimum user roll level to have access to the moderation controls. Default setting is Gamemaster. This does not give the user access to the configuration of the module itself.

Chat Type - How the incoming messages from the stream should be assigned. Depending on the modules you may be running it might be desirable to change how the chat card is assigned so it appears where you want it. Default is Out of Character which is designed to work with the inline tabbed chat feature.

Subscribers Only - Allow only Twitch subscriber messages to be posted into Foundry. This will not affect anyone with moderation roles who is not a subscriber.

Send to Twitch - Check to send Foundry chat messages to Twitch channel.

Recieve from Twitch - Enable to recieve messages from your configured Twitch channel.

Moderation Access Level` - Every once in a while a GM may need help with moderating a Twitch channel. Select user role to allow access to the module moderation controls.

Quiet Mode - Filters rolls such as attacks, checks and spells from being sent to Twitch, only allows OOC, IC, Emote and Other to be passed along to the stream.

Legacy Mode - Hides the tabbed chat, using legacy-style Foundry chat instead.

Hide in Stream View - Hide the tabbed chat in /stream view when using software such as OBS to create an overlay. Note, this does not effect the normal game view for you or your players.

IC to Twitch - Send in-character messages as Twitch messages. Automatically converts in-character messages to messages for Twitch sent from the Foundry tab. Messages from the Twitch tab all messages will be sent as the player name, not the character name.

Send Connect Message - Turn on/off announcement message when connecting to a Twitch channel chat.

Announcements - These are announcements to be broadcast to your channel every x seconds.

Chat Dice - Turn on/off the dice roller in Twitch Chat. FSM provides a very advance dice and mathematics engine and allows your viewers to take advantage of this and roll along with you and your players while not sending those rolls to Foundry. It works when a viewer types !roll dice+d+sides, ie !roll 1d100 or !roll 3d8+5. It can Fudge dice 'dF.1 or 4dF', roll Percentile '1d% or 4d%', Kill '3d10!k2', Min/Max modifiers '4d6max3 or 6d6min2', Explode '2d6! or 4d10!<=3', Compound '2d6!!', Penetrating '2d6!p', Reroll 'd6r, d6ro or 4d10r<=3', Keep and a whole lot more! You can read more on this incredible rolling engine at https://greenimp.github.io/rpg-dice-roller/guide/notation/modifiers.html#min-min-n

Join Announcement - Supposedly sends messages to people who join your channel, however it may be depreciated and therefor only here until I take it out. If it actually works, please drop me a line!

Features:

Roll Request - You can request a roll from a Twitch viewer. If the Who: field is left blank, anyone in the stream will have the chance to roll, if it's filled in, only that viewer can roll the dice. When rolled (ie !gm 1d100), the viewer will roll the dice in Foundry instead of in the Twitch chat. If you have Dice So Nice! enabled it will trigger them to roll on the screen as well. Rolls will appear in the Foundry tab.

Emote/Raw Message - Send a message as an emote or as raw. Raw is useful for passing commands to the Twitch IRC directly that have not been implemented in FSM at this time.

Clear Twitch Chat - Clears the chat history window.

Twitch Channel Chat Rate - Time is entered in seconds. It determines the amount of time between messages before a viewer can send aother. Default is 30 seconds.

Timeout - Temporarily bans a viewer from chatting. You can remove a timeout from here as well.

Ban - Bans a player from your channel. Unbanning is also possible.

Raid Channel - Raids help streamers send their viewers to another live channel at the end of their stream to introduce their audience to a new channel and have a little fun along the way. Raiding a channel at the end of your stream can be a great way to help another streamer grow his or her community. Keep in mind, you must have the browser open to Twitch to confirm the raid.

Release Notes:

## Release 0.2.1

-Twitch Emotes are now passed into Foundry from Twitch chat!

- Subscriber Mode: You can now select to only allow subscriber chat messages to be passed from Twitch to Foundry. Anyone with moderator status is not affected. This also affects the Request Dice Roll system but not the Twitch only dice rolling system, that will still need to be toggled off separately. This is a great feature to add incentive to Subscribing to your channel, unfortunately Twitch does not allow Followers to be tagged at this time so a similar feature for Followers will not be in the immediate future.

## Release 0.1.8

- Added inline tabbed chatting system! FSM now comes with a tabbed chatting system built in. By default this is on, however it can be turned off by enabling Legacy Mode.

The tabbed chat is simple and a convenient way to keep the Foundry chat you know but also provide a separate tab where all Twitch messages go. It has been tested with Tabbed Chatlog and doesn't appear to have any conflicts, at least on my setup, your mileage might vary depending on what modules that affect the chat system you are running.

- Added /stream hiding. For those broadcasting using the built in stream resources of Foundry you may want to hide the tabbed chat from your overlay. By default this feature is not enabled.

- In game documentation created as an installed Journal Entry.

- Reorganized the code from the ground up.

\n
\n

## Release 0.1.7

- Just some minor tweaking and cleaning up some errant code.

\n
\n

## Release 0.1.6r

- Added GM roll requests. GM/Moderator can ask Twitch viewers for a roll (ie 1d100 or 4d6+4, etc) and the first person to respond will roll the dice in Foundry. IF GM/Moderator specifies a viewer name it will wait for that player to roll, ignoring anyone else. A great way to make your viewers more involved with your games! Also works with Dice-so-Nice!

- Join notifications/messages. This may be depreciated, testing it out to see if it works. May be limited on large channels and only sends messages in batches whenever it feels like it.

- Emote/ Broadcast button added to canvas layer.

- Added a filter to stop excess roll results and announcements.

- Added configuration option to turn off Dice Roller in Twitch chat, this does not affect GM/Mod request rolls.

\n
\n

## Release 0.1.5r

- Added a dice roller for viewers on Twitch. Now viewers can roll along with your players in Twitch! Just type !roll 3d8+5 etc in the Twitch chat and they can roll alongside you! Added a filter to catch the roll requests so they don't clutter up the chat window. The roller can handle multiple types of dice, with a range of modifiers and mathematical functions!

- Added an initial response for Subs and re-Subs. I think this works but I don't have any subs to test it out. lol

- Added two customizeable timed announcements for the channel. Announcements can be set up to fire every x number of seconds, use it to let new viewers know what's going on, or even how to use that fancy new dice roller!

- Created macro usuable functions, streamOut, streamIn, triggerStream and awaitStream. These will most likely be refined over time and more will be added as needed. Unfortunately the Twitch API is limited in information that it passes along so tasks such as recognizing Followers is not supported at this time. I added a file called fsmMacro.js on Github with some examples of use. Macro capability is not very robust at this time but it's definitely a start!

- Reworked structure, as always.

\n
\n

## Release 0.1.4

- Added whisper filter, this stops all private messages between players or gm/players from being relayed.

- Added Quiet mode, stops rolls such as attack, checks and spells from being relayed into stream chat.

- Changed the way the speaker of a message from Foundry is identified on the Twitch chat. Speaker is now highlighted as [Speaker]:

\n
\n

## Release 0.1.3

- Added ability to set the chat card type. Depending on modules being used, such as Tabbed Chatlog, changing the type of message will affect where the messages from the stream appears in Foundry. Choices are OOC, IC, Emote, Roll and Other.

- Added option to connect to a stream channel chat silently without announcement. While useful for testing, it may not be desireable to have it announce a connection in a situation where there might be frequent reconnects.

- Changed the Moderation Role configuration to a drop down style selection instead of a string input.

\n
\n

## Release 0.1.2

- Added filters in Foundry=>Twitch hook to remove extraneous information being sent to Twitch chat.

- Created modLayers.js, moved canvas layer control functions from main module.

- Updated utils.js to remove unused code.

\n
\n

## Initial Public Release - 21.01.19

- Foundry Stream Modue is a mod for integrating Twitch chat from streams into Foundry Virtual Tabletop. Foundry Stream Module sends player chats, rolls, interactions to the Twitch stream chat and allows viewers in the Twitch chat to send messages to the players as an out of character message. GM's or another configurable user role can also moderate the Twitch chat via canvas control buttons for actions such as Clear, Timeout, Ban, Slow and Raid.

\n
\n

### New Features

- Integrate chat between Foundry and Twitch.

- Moderation of Twitch chat channels.

\n
\n

### Bug Fixes

- Added a redundancy check to stop duplicate messages when more than one GM was on the server.

\n
\n

### Improvements

- Improved the handling of configuration to just GM roles over the previous GM and User roles.

"} 2 | {"_id":"6LuvhGTuKyAXcwkr","name":"Foundry Stream Module Documentation","permission":{"default":0,"w1x54ohimiGGgcC6":3},"folder":"","flags":{"core":{"sourceId":"JournalEntry.mATlGTrUk9RwkBUe"}},"content":"