topeterk / HitCounterManager

Free Hit Counter / Death Counter that is running in the background, so you can focus on your stream. No need to keep any windows open for a window capture any more. Initially designed for Dark Souls and similar games but supports any game.
MIT License
86 stars 20 forks source link

Update template for ease of use #6

Closed ghost closed 6 years ago

ghost commented 6 years ago

I may be missing something obvious here, but it would be nice if the default template was usable out of the box. It appears to be missing the actual JavaScript function but does have the call to one.

Due to the different available styles the most basic one would be the most ideal as a default.

topeterk commented 6 years ago

I'm not sure if I get it..

What is meant with the default template? The file HitCounter.template is created during development of the front end based on HitCounter.html. When the implementation of the HitCounter.html is settled then the content is moved to HitCounter.template. Afterwards it gets applied the keywords and comments that it can be used by the application to produce the HitCounter.html as expected. So it is actually working without any modification (out of the box).

Which function is missing and in which file? A single design file uses the generated HitCounter.html from the application as a file based interface between the application and OBS. The javascript file is holding some functions that are common for all/most designs to keep development more simple (less/no code duplication). The design files' function Start() gives control to the javascript file which will call DoVisualUpdate() each time a data update has to be processed (which is every 1.5 sec at the moment).

What exactly is meant as "most basic one" and in what kind of way shall it become the "default"? I think this depends on the users behalf how he wants to use the HitCounter and right know it is used by newcomers in the same quantity as advanced/professionals. There are also No Hit runners and No Death runners, so it is pretty hard to name any design the starter/basic/default one. The design files are flat and there is no default since the user have to choose one by himself. The appearance is set in a way to show a "normal" HitCounter without fancy fonts, weird sizes or projected 3D rendering. It has a title that someone that sees the counter the first time has a clue what each row represents and the attempts counter on top which can also be simply unchecked in the settings window when the user wants to get rid of it. Therefore I guess the current configuration is good to go.

When you still have something that I should change, please try to name it more precisely, otherwise please leave a short note that I know if I can close this issue.

ghost commented 6 years ago

I will go ahead and close this. I think I made it hastily one night without verifying my information, sorry for that.

I do appreciate the work on this application and have recommended it to some friends and other streamers.