Add files via upload

Author: TabletopsAndAnvils

README.md

@@ -6,7 +6,11 @@ A module for integrating Twitch chat from streams into Foundry Virtual Tabletop.
 # General #
 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. </p>
 
-<img align="right" src="https://github.com/TabletopsAndAnvils/Foundry-Stream-Module/blob/main/img/Screen%20Shot%202021-01-19%20at%2022.22.52.png">
+<img align="right" src="https://github.com/TabletopsAndAnvils/Foundry-Stream-Module/blob/main/img/Screen%20Shot%202021-01-19%20at%2022.22.52.png"><p>
+## Recommended but not required ##
+I highly recommend Tabbed Chatlog by cswendrowski! https://github.com/cswendrowski/FoundryVTT-Tabbed-Chatlog
+This module adds tabs to the regular Foundry chat and because Foundry Stream Module recieves chats and displays them as OOC (out of character) chat messages
+new messages will appear in the OOC tab. While not it's own Twitch tab, this is a huge benefit to keeping the chatlog readable and organized! </p>
 
 <a href="https://youtu.be/g6h1_mgtr4U"><img align="center" height="25%" width ="25%" src="https://img.youtube.com/vi/g6h1_mgtr4U/0.jpg"> YouTube: Introducing Foundry Stream Module</a>
 
@@ -46,6 +50,7 @@ For manual installation:
 
 ### Future Goals
 - `Clean Up Rolls` - Clean up the roll output to Twitch. As is, depending on the system and various mods being used, rolls can get quite complicated looking. In the meantime, for the next release I may look into separating chat from rolls in the output. There's a lot of different game systems out there so I wont say no to some help if anyone is interested in contributing! :)
+- `Breakout Window` - Possibly? Not sure that it really needs to be added now with the Tabbed Chatlog module. Still, a configurable breakout window for incoming chats that would be viewable by all players might happen in the future. Customizable for theme, color, opacity, etc.
 - `Set Dressing` - Be able to add floating, resizeable, placeable graphics such as a "stream tag" for all clients, branding for the stream.
 - `RTMP Pipe Dream` - With Jitsi/WebRTC it's now possible to stream a window or browser tab directly to YouTube and other RTMP servers. A long term goal is to incorporate this functionality into Foundry Stream Module along with controls to make a slim streaming client that is essentially WYSIWYG for the user, foregoing the use of other software such as OBS or Streamlabs.
 
@@ -57,4 +62,4 @@ Many thanks go out to the entire FoundryVTT community especially Atropos for cre
 - This work is licensed under the [Foundry Virtual Tabletop EULA - Limited License Agreement for Module Development](https://foundryvtt.com/article/license/).
 
 ### Bugs
-- View current known bugs in the [Issue Tracker Backlog](https://github.com/TabletopsAndAnvils/Foundry-Stream-Module/issues)
+- View current known bugs in the [Issue Tracker Backlog](https://github.com/TabletopsAndAnvils/Foundry-Stream-Module/issues)

changelog.md

@@ -1,3 +1,12 @@
+## Release 0.2.3
+- Fixed url in modules.json
+- 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
+'${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
+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
+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
+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 
+my github or Discord server so I can consider including it in future versions!
+
 ## Release 0.2.2u
 - Minor update to emotes. Emotes were being sent to chat cards even when Receive from Twitch was disabled.
 

lang/en.json

@@ -53,5 +53,11 @@
   "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.",
 
   "fsMod.tabs.foundry": "Foundry",
-  "fsMod.tabs.fsm": "Twitch"
+  "fsMod.tabs.fsm": "Twitch",
+
+  "fsMod.settings.viewerRoll.req": "The GM is requesting ${who} to roll! [Type !gm ${dice} to roll]",
+  
+  "fsMod.settings.reqRoll.req": "The GM is requesting a viewer to roll! [Type !gm ${dice} to roll]",
+
+  "fsMod.settings.thankRoll.req": "Thank you for the roll,"
 }

module.json

@@ -12,7 +12,7 @@
     "patreon": "TabletopsAndAnvils"
   }
   ],
-  "version": "0.2.2u",
+  "version": "0.2.3",
   "minimumCoreVersion": "0.7.5",
   "compatibleCoreVersion": "0.7.9",
 
@@ -48,16 +48,12 @@
   "media":[
     {
       "type":"cover",
-      "link":"https://github.com/TabletopsAndAnvils/Foundry-Stream-Module/blob/main/img/fsm-cover.png"
-    },
-    {
-      "type":"screenshot",
-      "link":"https://github.com/TabletopsAndAnvils/Foundry-Stream-Module/blob/main/img/Screen%20Shot%202021-01-19%20at%2022.03.50.png"
+      "link":" https://raw.githubusercontent.com/TabletopsAndAnvils/Foundry-Stream-Module/main/img/fsm-cover.png"
     }
   ],
     "bugs": "https://github.com/TabletopsAndAnvils/Foundry-Stream-Module/issues",
     "url": "https://github.com/TabletopsAndAnvils/Foundry-Stream-Module",
 
     "manifest": "https://raw.githubusercontent.com/TabletopsAndAnvils/Foundry-Stream-Module/main/module.json",
-    "download": "https://github.com/TabletopsAndAnvils/Foundry-Stream-Module/archive/0.2.2u.zip"
+    "download": "https://github.com/TabletopsAndAnvils/Foundry-Stream-Module/archive/0.2.3.zip"
   }

scripts/fsmcore.js

@@ -3,6 +3,7 @@
 import { fsMod } from "./streamTwitch.js"; 
 import { levelCheck } from './streamTwitch.js';
 import { DiceRoller } from 'https://cdn.jsdelivr.net/npm/rpg-dice-roller@4.5.2/lib/esm/bundle.min.js';
+import {localize} from "./utils.js";
 
 const roller = new DiceRoller();
 
@@ -387,10 +388,16 @@ export function twitchRoll() { // A S K   F O R   R O L L
             console.log(who);
             var dice = html.find('[name="rollDice"]').val(); 
             if (who != "") {
-                  fsMod.client.say(myChannel, `The GM is requesting ${who} to roll! [Type !gm ${dice} to roll]`);
+                  let viewerRoll = (localize('settings.viewerRoll.req'));
+                  let v1 = viewerRoll.replace('${who}', who);
+                  let vFin = v1.replace('${dice}', dice);
+                  fsMod.client.say(myChannel, vFin); //`The GM is requesting ${who} to roll! [Type !gm ${dice} to roll]`);
                     diceWait(dice, who); }                       
                  else {
-                  fsMod.client.say(myChannel, "The GM is requesting a viewer to roll! [Type !gm " + dice + " to roll]");
+                  let reqRoll = (localize('settings.reqRoll.req'));
+                  let v1 = reqRoll.replace('${who}', who);
+                  let vFin = v1.replace('${dice}', dice);
+                  fsMod.client.say(myChannel, vFin); //"The GM is requesting a viewer to roll! [Type !gm " + dice + " to roll]");
                      diceWaitAll(dice);
             }
           }
@@ -461,11 +468,12 @@ export function diceWait(dice, who)  { // G M   R E Q U E S T   R O L L
       let myChannel = (game.settings.get("streamMod", "streamChannel"));
       let res = message.slice(3);
       var whoIs = who.toLowerCase();
-      var idCheck = tags["display-name"].toLowerCase();   
+      var idCheck = tags["display-name"].toLowerCase();  
+      let thankRoll = (localize('settings.thankRoll.req'));
             if (whoIs != idCheck) {return diceWait(dice, who);}
             if (whoIs == idCheck) {           
                 new Roll(res).roll().toMessage({speaker : {alias : `${tags["display-name"]}`}});
-                fsMod.client.say(myChannel, `Thank you for the roll, ${tags["display-name"]}!`);  
+                fsMod.client.say(myChannel, thankRoll + ` ${tags["display-name"]}!`);  
                 return;
                   }
               } return diceWait(dice, who);
@@ -484,8 +492,9 @@ export function diceWaitAll(dice) { // G M   R E Q U E S T   R O L L   -   A L L
     if (message.includes("!gm") && message.includes(dice) ) {
       let myChannel = (game.settings.get("streamMod", "streamChannel"));
       let res = message.slice(3);
+      let thankRoll = (localize('settings.thankRoll.req'));
           new Roll(res).roll().toMessage({speaker : {alias : `${tags["display-name"]}`}});
-          fsMod.client.say(myChannel, `Thank you for the roll, ${tags["display-name"]}!`);
+          fsMod.client.say(myChannel, thankRoll + ` ${tags["display-name"]}!`);
             return;        
             } 
       else return diceWaitAll(dice);