Added mac levels info
[fp-git.git] / poprecog / crash_course.txt
1 CRASH COURSE OF
2 PRINCE OF PERSIA SCREENSHOTS RECOGNIZER
3 (c) Copyright 2005 Princed Development Team
4 Programmed by peter_k
5
6 Q. What is this tool for?
7 A. This tool is mainly for pop developers. It can "tell" you what is the
8 frame order in animation, what is the pixel position and the screen, what
9 is the layer number and if this bitmap is "mirrored" or not.
10
11 Q. How to recognize something?
12 A. If you want to start recognize something, first you should make few dirs:
13  - Screen shots dir -> only one dir. In this dir you can put up to 99999
14    bitmap files, all sized 320x200.
15  - Bitmaps to recognize -> as many dirs as you want. In each dir you should
16    put images from one category, for example "kid", "vizier", "swords", but
17    it is not order.
18
19 In this dirs you can also put file "bitmaps.cfg" (neither it is in order).
20
21 Here is an example content of this file:
22 1
23 1
24 10
25 1
26
27 First number means if this bitmaps have "two directions". A number 1 means
28 true (bitmaps have two directions), a number 0 means false. The default
29 value is 1.
30 Second number means good number of recognized object.
31 Here you should use only this values:
32 0 - if this object is not important (it can be recognized, but it won't be
33     on debug files; only in trans_*.bmp). Use it for the things that can
34     exist in a front of the sprites
35 1 - use this for kid, vizier, pop1 guards etc
36 99999 - use this for pop1 swords, tiles etc
37 The default value is 99999.
38 The third number represents the minimum allowed percentile of
39 "good pixels" to recognize something. By default it is 30 (so 30%). For 
40 pop1 swords use 10%, for other items some value over 30%. The bigger number
41 you use will result in the faster it runs ;)
42 The fourth and last number means if bitmaps in this dir are transparent.
43 If "1" than yes (R:0,G:0,B:0 is transparent), if "0" than no.
44
45 Ok, so you have screen shots in the "screen" dir and you want to detect kid
46 fight with jaffar ;) So you need kid.dat, prince.dat and vizier.dat frames.
47 You can extract them using for example PR. But remember that in bitmaps dir,
48 background dir is not read!
49 So run "poprecog.exe" now ;) For the first you should type screen shots dir.
50 After this press [ENTER] to confirm. Then type each dir, in which there are
51 bitmaps to recognize, confirm them also by pressing [ENTER]. At the end type
52 "END"[ENTER]. Now type the maximum number of layers. If you'll type "0" here
53 than it means that poprecog should recognize as long as it won't be new
54 recognized items. Confirm with [ENTER] key ;) And last thing, type dir, in
55 which there will be results. This dir don't have to exist, but if it is now,
56 please empty it. I advise to use prefix before the folder name, for example
57 "__fight_with_jaffar", to differentiate this dir from other dirs (with
58 screen shots and bitmaps). Now you only have to wait ... ;)
59
60 Q. What are this files in the results dir?
61 A. In results dir you'll see many output files:
62
63 all_results.txt
64   Everything that was in the console window
65
66 small_results.txt
67   This is the "smaller" file of all_results.txt. It contains only information
68   about what screenshot is recognized, and what are the founded items. This
69   program can be used by other programs, for example to recognized animation.
70
71 colour_[SCREENSHOT_FILE_NAME].bmp
72   Here are good results to check if everything was recognized correctly.
73   The recognized things are coloured with random colors.
74
75 show_[SCREENSHOT_FILE_NAME].bmp
76   The same as above but images are displayed, not colored.
77
78 trans_[SCREENSHOT_FILE_NAME].bmp
79   Every pixel which was recognized is [R:255,G:0,B:255]. This is good for
80   debug pop1 swords.
81
82 movie_[SCREENSHOT_FILE_NAME].bmp
83   The same as show_*.bmp but this is 320x200 bitmap without text results.
84
85 Q. How can I made this screen shots?
86 A. Download RECORD from http://www.princed.com.ar (it only works in dos mode,
87 win95 or win98) or try any other program ;)
88
89 I hope this tool will be useful :)
90
91 ---
92 2005.06.30
93