RCVolus / league-prod-toolkit

Toolkit for League Productions with overlays for champion select, ingame events, end of game stats, and more
MIT License
135 stars 25 forks source link

[ Feature ] Create .txt files and images in a folder from custom data #162

Open FireFoXz09 opened 1 year ago

FireFoXz09 commented 1 year ago

Generating .txt files and images in a folder could be useful for some other purposes (like getting the standing of all the teams we entered to use them to generate/create a custom scene for an overall standing across a season or a tourney, for example.

Describe the solution you'd like All the data/infos we enter in Teams, for example (team names, standing, coach, tag, etc., could be generated in differents text file (blueteamname.txt, blueteamstanding.txt, redteamscore.txt. etc) or in a folder with the team name (ex: T1 folder, having a name.txt, logo.png, standing.txt. etc) to be used more simply for other purpose without the need to double write them in custom scenes or other places in the broadcast. image image image

I dunno if this is hard to implement, or a dumb suggestion. I've been using text files for many prods and differents needs and it always worked for me so...

sdomi4 commented 1 year ago

The data entered in the teams module is saved to a "database" (which is just a .json file). You can take a look at the data in ...\prod-toolkit\modules\plugin-database\data\league-prod-toolkit.json. Is this already fit for your purpose? Or how would you be looking to access/use the text files?

FireFoXz09 commented 1 year ago

I was looking to use the txt files for some custom purpose here and there, but yeah I already found the .json files with the data. Sadly it not usable as it is for my purpose. One example in my mind would be to use thoses .txt files in OBS to attach or read individual information to display them. (Read text files option from OBS). This is only an example about what I could use, sonce in my prod I have many other scenes (like schedule, records, all the teams in the league, etc.) I could enter them manually in my other scenes or graphics, but it just double my work since I already write them in the prod-tool-kit.

Himyu commented 1 year ago

Could further elaborate on what you have in mind maybe with some simple graphics? so we might look to implement them directly, or if exposing data is the better option.

FireFoXz09 commented 1 year ago

Well, for some people, using text files is simplier for broadcasting games or showing information on stream. For example, what if I need to show a team name on screen? I need to have it ready somewhere.

USE OF TXT FILES

This is an example of using text files in a scene/layout in OBS. Information's need to be updated manually every time I change them. I updated the standing of a team and by saving it in notepad, it update on stream. (Yes, the standing and the team name is in the same file here, but best case scenario, we put all thoses data in individual text files so we can grab them indivisually as we need for each setup/scene. Some of theses informations are the same as in the toolkit (such as team names, score, standing, logo, etc.) It can save time and make it easier if the toolkit ALSO generate text files individually for each information so we can get them by reading the content of the text files. (easier for the prod to manage all the updated infos for the stream.

image

Another example, getting all the teams we added with updated information in txt files, we can put a standing by ourselves without having to type them all one by one in double (in the toolkit and in another text file or photoshop, for example)

We could generate text files for the current blue team (name, logo, score, tag, coach, etc), current red team (same), the current round (Finals, Grand Finals, Round of 8, round of 16, etc), casters (full name, nickname, twitter, twitch, etc) and go on. Many softwares for streaming generate text files like this (example: for a recent donation, top donor, recent subs, etc). By having blue side or red sides files, thoses updates when we change a serie or a matchup, even when teams change sides.

It's an option to help people not familiar with CSS, HTML and JS to still use your tool, but still give flexibility to how to use the inputs and data generated from the toolkit (and maybe later go further and extract live stats, live current gold from each team, number of plating, drakes, experience, damage dealt etc. but this is for another project/later if we get there with the toolkit). I mostly ask this for the input we already add ourselves, so we only need to edit them in one place.

I dunno if it's clear or not XD Maybe it's harder to do than I think too. I was just an idea to add to the versatility of the toolkit.

sdomi4 commented 1 year ago

Since we want to maintain central theming and be able to operate the toolkit 100% remotely, .txt files aren't necessarily the path we want to follow. We plan to provide a series of additional browser sources that only display text based on information in the database:

This way should allow for the same custom screens you already use, which automatically updates whenever something is changed in the teams module. Additionally, this maintains central theming, so text colors & fonts don't have to be set individually. As a bonus, providing pages with these text variants also would allow for a small script to create text files if that is still desired :) This shouldn't be a huge pain to implement, but won't be our highest priority at the moment.