git.sesse.net Git - casparcg/blob - README.txt

   1 ======================================================================================================\r
   2 CasparCG Video and Graphics Playout Server\r
   3 ======================================================================================================\r
   4 \r
   5 Thank you for your interest in CasparCG. The included software\r
   6 is provided as-is by Sveriges Televison AB.\r
   7 \r
   8 Please note that while the current CasparCG Client (version 1.8) will\r
   9 continue to work with CasparCG Server 2.0, you won't be able to\r
  10 trigger many of the new features. Please use the provided AIR app to\r
  11 try out the new functionality or add the new features to you \r
  12 control application (you can find the documentation on the wiki or ask in the forums). \r
  13 \r
  14 ======================================================================================================\r
  15 INSTALLATION\r
  16 ======================================================================================================\r
  17 \r
  18 You can place the CasparCG Server 2.0 folder anywhere you like, and even move it.\r
  19 \r
  20 If you don't already have Flash installed, use the bundled version in the Flash folder\r
  21 \r
  22 ======================================================================================================\r
  23 CONFIGURATION\r
  24 ======================================================================================================\r
  25 \r
  26 By default, CasparCG Server will look in the media folder \r
  27 for videos, audio and images files. Flash templates are stored in the\r
  28 templates folder. If you want to change the location (for example to a faster disk)\r
  29 you just change the paths in the casparcg.config file.\r
  30 \r
  31 * How to enable Screen consumer\r
  32 \r
  33 Open casparcg.config and use the following node for consumers:\r
  34 \r
  35 <consumers>\r
  36     <screen/>\r
  37 </consumers>\r
  38 \r
  39 * How to enable a DeckLink card and how to get video in and key output.\r
  40 \r
  41 Open casparcg.config and use the following node for consumers:\r
  42 \r
  43 <consumers>\r
  44     <decklink/>\r
  45 </consumers>\r
  46 \r
  47 # Tip:\r
  48 \r
  49 At the bottom of the casparcg.config file you will find comments which document additional settings.\r
  50 \r
  51 ======================================================================================================\r
  52 LICENSING\r
  53 ======================================================================================================\r
  54 CasparCG is distributed under the GNU General Public \r
  55 License GPLv3 or higher, see the file COPYING.TXT for details. \r
  56 More information, samples and documentation at: \r
  57 http://casparcg.com/\r
  58 http://casparcg.com/forum/\r
  59 http://casparcg.com/wiki/\r
  60 \r
  61 CasparCG uses FFmpeg (http://ffmpeg.org/) under the GPLv2 Licence. \r
  62 FFmpeg is a trademark of Fabrice Bellard, originator of the FFmpeg project.\r
  63 \r
  64 CasparCG uses the Threading Building Blocks (http://www.threadingbuildingblocks.org/) library under the GPLv2 Licence.\r
  65 \r
  66 CasparCG uses FreeImage (http://freeimage.sourceforge.net/) under the GPLv2.\r
  67 \r
  68 CasparCG uses SFML (http://www.sfml-dev.org/) under the zlib/libpng License.\r
  69 \r
  70 CasparCG uses GLEW (http://glew.sourceforge.net) under the modified BSD license.\r
  71 \r
  72 CasparCG uses boost (http://www.boost.org/) under the Boost Software License, Version 1.0.\r
  73 \r
  74 ======================================================================================================\r
  75 AUTHORS - People who have developed the CasparCG Server Software (sorted alphabetically by last name).\r
  76 ======================================================================================================\r
  77 \r
  78     Niklas     Andersson     (Server 1.0-1.8)\r
  79     Andreas    Jeansson    (Template-Host)\r
  80     Robert     Nagy         (Server 1.7-2.x)\r
  81     \r
  82 ==================================================================================================\r
  83 CREDITS - People who have contributed to the CasparCG Project (sorted alphabetically by last name).\r
  84 ==================================================================================================\r
  85 \r
  86     Niklas    Andersson             \r
  87     Jonas     Hummelstrand    (jonas.hummelstrand@svt.se)\r
  88     Andreas Jeansson        (andreas.jeansson@svt.se)\r
  89     Peter     Karlsson        (peter.p.karlsson@svt.se)\r
  90     Robert     Nagy            (ronag89@gmail.com)\r
  91     Olle     Soprani            \r
  92     Thomas     R. Kaltz III \r
  93 \r
  94 ================================================================================\r
  95 CasparCG Server 2.0.3\r
  96 ================================================================================\r
  97 \r
  98 SYSTEM REQUIREMENTS\r
  99 ===================\r
 100 \r
 101 1. Intel processor (while AMD processors should work, CasparCG Server has only\r
 102    been tested on Intel processors.)\r
 103 \r
 104 2. We recommend Windows 7 (64-bit,) but it has also been successfully used on \r
 105    Windows 7 (32-bit) and Windows XP SP2 (32-bit only.)\r
 106    \r
 107 3. An OpenGL 3.0-capable graphics card from NVIDIA is required to run \r
 108    CasparCG Server 2.0. Also make sure that you have installed the latest\r
 109    drivers.\r
 110    Please check your card's capabilities at: \r
 111    http://en.wikipedia.org/wiki/Comparison_of_Nvidia_graphics_processing_units\r
 112    Graphics cards from other manufacturers _may_ work but have not been tested.\r
 113 \r
 114 4. Microsoft Visual C++ 2010 Redistributable Package must be installed.\r
 115    Free download at:\r
 116    http://www.microsoft.com/download/en/details.aspx?id=5555\r
 117 \r
 118 5. You must have Flash Player 10.3 or later installed (an installer can be found\r
 119    in the "Flash Player Installation" folder.)\r
 120 \r
 121 The latest recommendations are available at:\r
 122 http://casparcg.com/wiki/CasparCG_Server#System_Requirements\r
 123 \r
 124 \r
 125 INSTALLATION\r
 126 ============\r
 127 \r
 128 1. Check that your system meets the requirements.\r
 129 \r
 130 2. Unzip and place the CasparCG Server 2.0.3 folder anywhere you like.\r
 131 \r
 132 3. Install "Microsoft Visual C++ 2010 Redistributable Package" from\r
 133    http://www.microsoft.com/download/en/details.aspx?id=5555\r
 134    \r
 135 4. Install "Flash Player 10.3.183.14" from the "Flash Player Installation"\r
 136    folder.\r
 137 \r
 138 5. Make sure you turn off Windows' Aero Theme as it interferes with \r
 139    CasparCG Server's OpenGL features!\r
 140 \r
 141 6. Configure the server settings in the "casparcg.config" text file.\r
 142 \r
 143 7. Start the "CasparCG.exe" program.\r
 144 \r
 145 8. Connect to the server from a client, such as the included CasparCG 2.0 Demo\r
 146    Client (requires Adobe AIR.)\r
 147 \r
 148 \r
 149 DOCUMENTATION\r
 150 =============\r
 151 \r
 152 The most up-to-date documentation is always available at\r
 153 http://casparcg.com/wiki/\r
 154 \r
 155 \r
 156 CONFIGURATION\r
 157 =============\r
 158 \r
 159 By default, CasparCG Server will look in the media folder for videos, audio and\r
 160 images files. Flash templates are stored in the templates folder. If you want to\r
 161 change the location (for example to a faster disk) you just change the paths in\r
 162 the casparcg.config file.\r
 163 \r
 164 * How to enable Screen consumer:\r
 165 \r
 166   Open casparcg.config and use the following node for consumers:\r
 167 \r
 168   <consumers>\r
 169       <screen/>\r
 170   </consumers>\r
 171 \r
 172 * How to enable a DeckLink card and how to get video in and key output:\r
 173 \r
 174   Open casparcg.config and use the following node for consumers:\r
 175 \r
 176   <consumers>\r
 177       <decklink/>\r
 178   </consumers>\r
 179 \r
 180 # Tip:\r
 181 \r
 182 At the bottom of the casparcg.config file you will find comments which document\r
 183 additional settings.\r
 184 \r
 185 \r
 186 LICENSING\r
 187 =========\r
 188 \r
 189 CasparCG Server is distributed under the GNU General Public License GPLv3 or\r
 190 higher, see LICENSE.TXT for details.\r
 191 \r
 192 More information, samples and documentation at: \r
 193 http://casparcg.com/\r
 194 http://casparcg.com/forum/\r
 195 http://casparcg.com/wiki/\r
 196 \r
 197 CasparCG uses FFmpeg (http://ffmpeg.org/) under the GPLv2 Licence. \r
 198 FFmpeg is a trademark of Fabrice Bellard, originator of the FFmpeg project.\r
 199 \r
 200 CasparCG uses the Threading Building Blocks\r
 201 (http://www.threadingbuildingblocks.org/) library under the GPLv2 Licence.\r
 202 \r
 203 CasparCG uses FreeImage (http://freeimage.sourceforge.net/) under the GPLv2.\r
 204 \r
 205 CasparCG uses SFML (http://www.sfml-dev.org/) under the zlib/libpng License.\r
 206 \r
 207 CasparCG uses GLEW (http://glew.sourceforge.net) under the modified BSD license.\r
 208 \r
 209 CasparCG uses boost (http://www.boost.org/) under the Boost Software License,\r
 210 Version 1.0.\r
 211 \r
 212 AUTHORS - People who have developed the CasparCG Server Software\r
 213 ==========(sorted alphabetically by last name)==================\r
 214 \r
 215 Niklas  Andersson   (Server 1.0-1.8)\r
 216 Andreas Jeansson    (Template-Host)\r
 217 Robert  Nagy        (Server 1.7-2.x)\r
 218 Helge   Norberg     (Server 2.x)\r
 219 \r
 220 \r
 221 CREDITS - People who have contributed to the CasparCG Project\r
 222 ==========(sorted alphabetically by last name)===============\r
 223 \r
 224 Niklas  Andersson\r
 225 Jonas   Hummelstrand    (jonas.hummelstrand@svt.se)\r
 226 Andreas Jeansson        (andreas.jeansson@svt.se)\r
 227 Peter   Karlsson        (peter.p.karlsson@svt.se)\r
 228 Jeff    Lafforgue\r
 229 Andy    Mace\r
 230 Robert  Nagy            (ronag89@gmail.com)\r
 231 Helge   Norberg         (helge.norberg@svt.se)\r
 232 Thomas  R. Kaltz III\r
 233 Olle    Soprani\r