server icon indicating copy to clipboard operation
server copied to clipboard

Add warning/instructions to the casparcg.config file

Open hreinnbeck opened this issue 5 years ago • 1 comments

It is all too common that users have issues because they simply copy and paste from the examples at the bottom of the config file. I'd like to discuss adding something like below to the top of the example config:


////////////////////////////////////////////////////////////////////////////////////////////////////////////////
STOP!

You can *not* use any of the examples below by just copy/pasting them above!
These are examples of possible options and values for the configuration file.

They are conformed as:
<tag>default value [other possible values]</tag>

Any tag in the configuration above containing brackets or multiple values will be invalid and will not work.
////////////////////////////////////////////////////////////////////////////////////////////////////////////////

hreinnbeck avatar May 21 '19 15:05 hreinnbeck

Just whipped this together, as-is it should catch like 90% of problem configs. https://hreinnbeck.com/casparcg-config-validator/

hreinnbeck avatar Jun 15 '19 00:06 hreinnbeck