search

CasparCG / server

CasparCG Server is a Windows and Linux software used to play out professional graphics, audio and video to multiple outputs. It has been in 24/7 broadcast production since 2006. Ready-to-use downloads are available under the Releases tab https://casparcg.com.
GNU General Public License v3.0
901 stars 269 forks source link

Add warning/instructions to the casparcg.config file #1207

Open hreinnbeck opened 5 years ago

hreinnbeck commented 5 years ago

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 commented 5 years ago

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