readek / melee-stream-tool Goto Github PK

Hello!

A friend of mine was asking for advice on how to add certain things to this project - and then I ended up digging into the source code and modifying it myself.

My main goal was to add character icons underneath the score counters for the game scoreboard.

I got this working and then I dug into things some more!

I was able to get an application running on MacOS (my personal platform). I upgraded the packages within package.json as well.

I have further ideas + suggestions, such as:

• Utilizing the forge.packagerConfig.extraResource to package all of the additional files relied upon
  • This would remove the need of having to place the executables in Stream Tool
• Separating out the images, CSS, etc. from the javascript code
• Generating an output HTML file
  • This goes hand in hand with the extraResource modification above - basically separating all of the electron application code from the outputs of Game Scoreboard.html and VS Screen.html
  • This also resolves possible pathing issues between operating systems - mainly MacOS. I found that utilizing relative paths for the generations .app couldn't reach "outside" of the application to files within Stream Tool - it only worked if I packages the files within forge.packagerConfig.extraResource

All this being said, what would be the best way for me to present changes?

I could perform incremental changes, such as:

• PR for my initial change of character icons
• PR for updating packages in package.json
• PR for separating out code and resources
• PR for generating the output HTML files
• etc.

I could also fork the repo as well! I recognize that this repository hasn't been active in a few years. I also recognize that this project (and all other stream tools) have been passion projects of yours!

If I do end up forking, I'll be sure to direct everyone to the original repo and to encourage them to support you via your ko-fi. Additionally, if my fork contains the changes I outlined above (if I ever get around to it as I am also busy), I'd love to talk about them with you / help integrate them into your original project.

Since it looks a little silly with Luigi's backwards L on his hat, and in general I just am not a fan of the practice of mirroring images personally.

Is there a technical reason the P2 portrait is mirrored? I think it would look just fine if it wasn't. :)

I really love the simple text feature as it allows myself to sue custom fonts to make dynamic Stream overlays. I think good additions would be a Round type (Best of 3, or Best of 5) A player 1 and 2 Score (Just a number). Player 1 and 2 WInners/Loosers (A text file that is empty if not selected) Player 1 and 2 Tag. A player 1 and 2 character name (simply says who they are playing). Additionally if there was a way to make it possible to save a image source of obs that changes based on player 1 and 2 character to teh stock icon that would be awesome. Similar to the big house 9 overlay.

users may run into trouble customizing Melee Stream Tool if they try to preview it in a normal browser, due to CORS:

Access to XMLHttpRequest at 'file:///C:/Users/jmlee337/Downloads/Melee.Stream.Tool.v1/Melee%20Stream%20Tool%20v1.1/Resources/Texts/ScoreboardInfo.json' from origin 'null' has been blocked by CORS policy: Cross origin requests are only supported for protocol schemes: http, data, isolated-app, chrome-extension, chrome, https, chrome-untrusted.

I suggest adding something like the following to the Customizing stuff section:

Game Scoreboard.html will not work in a normal browser. To customize Game Scoreboard.html with developer tools launch obs(64).exe with "--remote-debugging-port=9222" then open your local chrome and go to "localhost:9222".

Player names won't appear on the scoreboard after installing OBS 28.0.1. I've tried re-adding the scoreboard html to the scene, I've made sure to check the refresh when inactive and custom framerate options. I've also refreshed the cache. The caster names and round names show up fine. I also tried changing the character border color and no dice there either. :(
It can sometimes also take a moment to fully finish loading while the score ticks bounce around, but that also happened in previous versions.

When I attempt to update the stream, it will only update the VS Screen HTML file, but the Game Scoreboard HTML file will freeze in OBS.

Tested:

- Deleting and re-adding Game Scoreboard.html from OBS Studio
- Quitting Melee Stream Tool and restarting it
- Both deleting Game Scoreboard.html and quitting MST, then adding back GS and opening MST (it works at first, but when I switch to VS Screen and then back, it doesn't work)

I use Pop OS 20.04

Hi! in this repo, in the "Stream Tool" directory, there's a .exe file for the Stream Tool. How was this built?
The provided Windows build method (electron-forge make) does not generate a single .exe file but a whole folder of things, mostly Electron specific stuff, and building this and moving it into the "Stream Tool" folder still does not work as the file paths in the code are all hard coded to be relative paths from the "Interface Source Code" folder to the "Stream Tool" folder.
In my fork I have made the paths dynamic based on an environment variable and this works fine for tile Linux AppImage, but I'm still unable to recreate or make a replacement for the single .exe in the "Stream Tool" folder.
Could you please provide build steps to recreate or replace the .exe file? Thanks!

When running an event with a Camera, often times the players sit in a different order than expected, having a single button switch the sides of the players would be very helpful. As an example, going from this:

to this:

currently requires you to retype everything and reset characters and score, and as this is something that I as a TO think is quite frequent having a single button swap them would be great.