home *** CD-ROM | disk | FTP | other *** search
/ PC World 2007 April / PCWorld_2007-04_cd.bin / multimedia / taksi / taksi-0.7.6.msi / _8D5FD7AD06165589B24FBADFB2F3FB86 / _0723204639144775B786B18144055A9D next >
Text File  |  2006-06-07  |  10KB  |  225 lines
  1. ; TODO - this is out of date! update it
  2. TAKSI manual v0.5.1-dev                                      December 08, 2004
  3. ==============================================================================
  4.  
  5.  
  6. 0. About:
  7. ---------
  8. Taksi is a screenshot/video-capture program for 3D applications (games, and 
  9. etc.) Currently, it works with DirectX 8, DirectX 9, and OpenGL applications.
  10. (Support for older DirectX interfaces may be implemented in the future)
  11. Taksi is free software.
  12.  
  13.  
  14. 1. Current state / What's new:
  15. ------------------------------
  16. BETA. DirectX 8 / DirectX 9 / OpenGL support implemented.
  17. This is a "bug-fixing/internal enhancements" release. Changes made include:
  18.  
  19. New in 0.5.1-dev:
  20. Early experiments with using codec to write compressed video while
  21. capturing it. Works somewhat (at least with some codecs), but still a lot 
  22. of details to figure out and implement properly.
  23.  
  24.  
  25. 2. Supported operating systems:
  26. -------------------------------
  27. Windows 95, Windows 98, Windows ME,
  28. Windows NT 4.0, Windows 2000, Windows XP.
  29.  
  30.  
  31. 3. Capture specifications:
  32. --------------------------
  33. Screenshot format: 24 bit BMP files.
  34. Video: compressed or uncompressed AVI-files (no audio).
  35.  
  36.  
  37. 4. Games/Apps tested with:
  38. --------------------------
  39. Direct3D 8: 
  40.    Pro Evolution Soccer 3, Winning Eleven 7 International,
  41.    F1 2001, FIFA 2003, WarCraft III.
  42.    Unreal Tournament 2003, Unreal Tournament 2004,
  43.    3DMark2001 SE.
  44. Direct3D 9:
  45.    Prince of Persia: Sands of Time,
  46.    Leisure Suit Larry: Magna Cum Laude,
  47.    3DMark03.
  48. OpenGL:
  49.    DOOM 3, Return To Castle Wolfenstein (demo),
  50.    Tennis Critters (demo), PyOpenGL bindings.
  51.  
  52.  
  53. 5. Usage:
  54. ---------
  55.  
  56. STEP 1. Run taksi.exe
  57. STEP 2. Run a game that uses one of the supported APIs (DX8, DX9 or OpenGL)
  58.         (The order of these two steps is not important for taksi. It should be
  59.         able to hook on the game in either case.)
  60.  
  61. STEP 3. Look at left top corner of the screen. 
  62.         If you see a green rectangle in there, then Taksi was able
  63.         to sucessfully hook on the game.
  64.  
  65.  
  66. 6. Default keys:
  67. ----------------
  68.  
  69. F5: Turn visual indicator ON/OFF.
  70. F6: Toggle system-wide hook mode. When ON (indicator turns blue), allows 
  71.      for mapping into multiple applications, but may have a strong negative
  72.      effect on the overall performance of the system. Recommended state: OFF.
  73.      (The hot-key is disabled, when Taksi uses DirectInput for keyboard
  74.      handling.)
  75. F7: Small screenshot (WIDTH/2 x HEIGHT/2).
  76. F8: Regular screenshot (WIDTH x HEIGHT).
  77. ScrollLock: Video capture ON/OFF (Writes an uncompressed AVI-file).
  78.      (Dimensions of the video are WIDTH/2 x HEIGHT/2.)
  79.  
  80.  
  81. 7. IMPORTANT DISK SPACE CONSIDERATIONS:
  82. ---------------------------------------
  83. Taksi writes uncompressed AVI files. Basically, this means you need a lot
  84. of free disk space. (Once captured, the AVI-files can be compressed into
  85. much smaller files, using the tools like an excellent free software
  86. program, called VirtualDub by Avery Lee.) However, at the time of
  87. capture, for performance reasons, no compression is done, which means that
  88. video files grow large very fast.
  89.  
  90. There is no time limit in the video capture mode, so the only constraint
  91. is the available disk space. Keep this in mind, when setting the directory
  92. for you captured videos.
  93.  
  94.  
  95. 8. Configuration:
  96. -----------------
  97. Taksi uses configuration file, called "taksi.INI". It is optional, so the 
  98. program can operate without it, using built-in default settings. 
  99. The configuration file is managed automatically by Taksi (it is read
  100. on start-up, and updated when "Save And Apply" button is clicked.).
  101. However, it can be edited manually as well.
  102.  
  103. The following options exist:
  104.  
  105. 1) Basic capture options:
  106. =========================
  107.  
  108. Capture directory ("CaptureDir"): 
  109. This is the directory, where your screenshots and video will be stored. 
  110. IMPORTANT: This directory must exist before any capture is attempted.
  111.  
  112. Target frame rate ("MovieFrameRateTarget"):
  113. Desired frame rate of the captured video. So-called "Adaptive" algorithm
  114. uses this setting. When Adaptive algorithm is used, Taksi will try to 
  115. capture the video that will run at specified frame rate, and appear to 
  116. be of the same speed as the actual game. 
  117. NOTE: This doesn't always work well. It seems to work fine for applications
  118. with high frame rate, but often poorly for low frame rate apps. This
  119. Adaptive algorithm is still work-in-progress, so hopefully, i'll be able
  120. to improve it.
  121. If it fails to deliver decent videos, try using "Custom settings", which
  122. are described below.
  123.  
  124. 2) Hot-key mappings:
  125. ====================
  126. Define keys that trigger the actions: screen shot capture, video capture,
  127. indicator appear/disappear, global hook mode.
  128.  
  129. NOTE: Sometimes, the hot-keys may be slow to respond, or not-responsive
  130. at all. First thing to try is to re-assign the hot-keys as they may clash
  131. with some other actions in the game that are triggered by these keys.
  132. If that doesn't help, try changing the value for "useDirectInput"
  133. configuration option, described in the next section.
  134.  
  135. 3) Advanced options:
  136. ====================
  137. These options you may never need to change. 
  138. That said, there are certainly use cases, when you might want (or need)
  139. to modify them.
  140.  
  141. "startup.hookMode.systemWide" : 0/1
  142. Takes boolean values, where 0 - means that taksi should go into 
  143. "exclusive" mode once an application is hooked, effectively meaning that 
  144. no other application will be hooked until this application exits, or 
  145. taksi exits and unhooks from it. 1 - means stay in system wide mode, 
  146. allowing many apps to be hooked in parallel. Typically, you would
  147. want Taksi to go to exclusive mode as soon as possible, because
  148. system-wide mode requires extra message processing by the OS, and
  149. may slow down the whole system. However, system-wide mode is useful 
  150. when you want to run many windowed apps at the same time and hook them 
  151. all with Taksi. (Remember that HOOK_MODE hot-key can still be used from 
  152. any of those applications to switch back-and-forth between the modes)
  153. Recommended default: 0
  154.  
  155. "keyboard.useDirectInput" : 0/1
  156. Takes boolean values. Allows to pick one of two methods of handling 
  157. hot-keys: either through a keyboard hook procedure (value 0), or by 
  158. using DirectInput interface from DirectX 8 API (value 1). Typically
  159. you would want to use DirectInput, because it allows to correctly
  160. handle hot-keys across wider range of applications. In fact, for 
  161. some apps (like 3DMark2001 SE), using DirectInput may be the only way
  162. to capture hot-key toggles. Using keyboard hook can be a better 
  163. alternative when you want to hook multiple applications at the same
  164. time (i.e. "system-wide" mode), and want to send hot-key commands
  165. separately to each application: in other words, the one with
  166. keyboard focus will receive the hot-key toggles, but others will not.
  167. (When DirectInput is used, all hooked apps will receive and process
  168. the hot-key events simultaneously, which may not be desirable).
  169. Recommended default: 1
  170.  
  171. "movie.fullSize" : 0/1
  172. Takes boolean values. Allows to capture video in either "half-size"
  173. mode, when frames are reduced by half in each dimension, or in 
  174. "full-size" mode, when frames are kept as they are in the game.
  175. Warning: performance issues exist with full-size video capture, if 
  176. used in high-resolution modes (1024x768 and higher). Use it only 
  177. if you really need to, and you have a very fast graphics card, and
  178. you have tons of hard drive space.
  179. Recommended default: 0
  180.  
  181. NOTE: There is no way to modify the values of these settings via GUI,
  182. so in order to make a change, you need to manually edit the config file
  183. (using any text editor), and then restart Taksi.
  184.  
  185. 4) Custom video settings:
  186. =========================
  187. This is the alternative to Adaptive mode.
  188. Custom settings come in groups, with each group having a unique id. 
  189. There are 3 settings in a group: pattern, frame rate, and frame weight.
  190. Pattern allows you to select which application(s) should be handled by
  191. this custom settings group. When taksi.dll is mapped into an application,
  192. it checks if any part of applications's full executable filename matches
  193. the pattern of any group. Usually, you can just specify the name of
  194. the game's main executable file, but sometimes you may wish to be more
  195. or less specific. Frame rate is the frame rate of captured video.
  196. Frame Weight specifies how much each game frame should contribute to
  197. captured video frame. 
  198. Examples of weight setting:
  199. 1.0  - every frame of the game will be captured in the video. 
  200. 4.0  - every frame of the game will be duplicated 4 times in the 
  201.        captured video. (You rarely would wanna use something like 
  202.        that though). 
  203. 0.33 - approximately every 3rd frame of the game is captured in the video.
  204. 0.4  - 2 out of 5 frames are captured.
  205.  
  206. Keep in mind that custom settings may deliver very weird results of
  207. either very slow or very fast videos. You may need to experiment with 
  208. the settings. However, i found out that for some applications, good
  209. custom settings can deliver much better (and smaller) videos than the ones
  210. captured in Adaptive mode.
  211.  
  212.  
  213. 9. Credits:
  214. -----------
  215. Taksi is written by Anton Jouline (Juce)
  216.  
  217.  
  218. 10. License:
  219. ------------
  220. This program is distributed under BSD-style license.
  221. See license.txt file for exact information about copying and redistribution.
  222.  
  223. ==============================================================================
  224.  
  225.