]> git.sesse.net Git - casparcg/blob - README.txt
Merge pull request #134 from cambell-prince/master_dshow
[casparcg] / README.txt
1 ================================================================================\r
2    CasparCG Server 2.0.3\r
3 ================================================================================\r
4 \r
5 Thank you for your interest in CasparCG Server, a professional \r
6 software used to play out and record professional graphics, audio and video \r
7 to multiple outputs. It has been in 24/7 broadcast production since 2006.\r
8 \r
9 This release is considered tested and stable, and is intended for use in\r
10 professional production.\r
11 \r
12 More information is available at http://casparcg.com/\r
13 \r
14 \r
15 SYSTEM REQUIREMENTS\r
16 ===================\r
17 \r
18 1. Intel processor capable of using SSSE3 instructions. Please refer to\r
19    http://en.wikipedia.org/wiki/SSSE3 for a complete list.\r
20    While AMD processors should work, CasparCG Server has only\r
21    been tested on Intel processors.\r
22 \r
23 2. We recommend Windows 7 (64-bit,) but this software has also been used\r
24    successfully on Windows 7 (32-bit) and Windows XP SP2 (32-bit only.) \r
25    Using CasparCG Server on Windows 8 and Windows Vista is untested and \r
26    is not recommended!\r
27    \r
28 3. An NVIDIA graphics card (GPU) capable of OpenGL 3.0 or higher is required! \r
29    Please check your card's capabilities at: \r
30    http://en.wikipedia.org/wiki/Comparison_of_Nvidia_graphics_processing_units\r
31 \r
32 Also make sure that you have the latest drivers installed:\r
33    http://www.nvidia.com/Download/index.aspx?lang=en-us%20nVidia%20drivers\r
34    \r
35    Graphics cards from other manufacturers _may_ work but have not been tested!\r
36 \r
37 4. Microsoft Visual C++ 2010 Redistributable Package must be installed.\r
38    Free download at:\r
39    http://www.microsoft.com/download/en/details.aspx?id=5555\r
40 \r
41 5. You must have Flash Player 10.3 or later installed (an installer can be found\r
42    in the "Flash Player Installation" folder.)\r
43 \r
44 6. Make sure you turn off Windows' "Aero" theme and "ClearType" font smoothing \r
45    as they have been known to interfere with transparency in Flash templates, \r
46    and can also cause problems with Vsync when outputting to computer screens.\r
47 \r
48 The latest system recommendations are available at:\r
49 http://casparcg.com/wiki/CasparCG_Server#System_Requirements\r
50 \r
51 \r
52 INSTALLATION\r
53 ============\r
54 \r
55 1. Check that your system meets the requirements.\r
56 \r
57 2. Unzip and place the "CasparCG Server 2.0.3" folder anywhere you like.\r
58 \r
59 3. Install "Microsoft Visual C++ 2010 Redistributable Package" from\r
60    http://www.microsoft.com/download/en/details.aspx?id=5555\r
61    \r
62 4. Install "Flash Player 10.3.183.14" from the "Flash Player Installation"\r
63    folder.\r
64 \r
65 5. Make sure you turn off Windows' "Aero Theme" and ClearTyper as they can interfere \r
66    with CasparCG Server's OpenGL features!\r
67 \r
68 6. Configure the server settings in the "casparcg.config" text file.\r
69 \r
70 7. Start the "CasparCG.exe" program.\r
71 \r
72 8. Connect to the server from a client, such as the included CasparCG 2.0 Demo\r
73    Client (requires Adobe AIR) or the CasparCG Client 2.0 (available as a separate\r
74    download.)\r
75 \r
76 \r
77 DOCUMENTATION\r
78 =============\r
79 \r
80 The most up-to-date documentation is always available at\r
81 http://casparcg.com/wiki/\r
82 \r
83 \r
84 CONFIGURATION\r
85 =============\r
86 \r
87 By default, CasparCG Server will look in the media folder for videos, audio and\r
88 images files. Flash templates are stored in the templates folder. If you want to\r
89 change the location (for example to a faster disk) you just change the paths in\r
90 the casparcg.config file.\r
91 \r
92 * How to enable Screen consumer:\r
93 \r
94   Open casparcg.config and use the following node for consumers:\r
95 \r
96   <consumers>\r
97       <screen/>\r
98   </consumers>\r
99 \r
100 * How to enable a DeckLink card and how to get video in and key output:\r
101 \r
102   Open casparcg.config and use the following node for consumers:\r
103 \r
104   <consumers>\r
105       <decklink/>\r
106   </consumers>\r
107 \r
108 # Tip:\r
109 \r
110 At the bottom of the casparcg.config file you will find comments which document\r
111 additional settings.\r
112 \r
113 \r
114 LICENSING\r
115 =========\r
116 CasparCG Client is distributed under the GNU General Public License GPLv3 or\r
117 higher, see LICENSE.TXT for details.\r
118 \r
119 The included software is provided as-is by Sveriges Televison AB.\r
120 More information is available at http://casparcg.com/