compile as C
[rofl0r-GfxRip.git] / readme.txt
blob6b62a369311b826bee09df344ffd254d4a68bfd2
1    Graphics Ripper   by TC\r
2 ===============================\r
3 v 1.08  Released on 06.jul.2007\r
4 -------------------------------\r
5     email: tomcat@sgn.net\r
6 -------------------------------\r
7 New in 1.08: Palette searching now uses WinUAE way of setting values\r
8 New in 1.07: Added CTRL + INSERT to copy the first image to ClipBoard\r
9 New in 1.06: Added R/F + SHIFT to quickly add/remove Skip bytes\r
10              Added P + SHIFT to do an incremental Save\r
11 New in 1.05: Added two new Palette search modes - WinUAE Snapshot direct\r
12              Copper List searching for ECS and AGA palettes. Will set the\r
13              palette to the one that was active when the UNCOMPRESSED\r
14              Snapshot (SaveState) was taken in WinUAE.\r
15 New in 1.04: Key 'U' turns on/off a zoom window at the bottom/right\r
16              corner. Just a quick 'fix ... for EAB people ;-)\r
18 NOTE: You must know atleast some basics about how amiga displays the\r
19       pictures on the screen! Since the program like this cannot be\r
20       automatic at all you are on your own ! The only automatic thing\r
21       is palette searching (and even that fails on some occasions).\r
22       There is a little guide for those who don't exactly know what\r
23       they are doing... hope that one helps !\r
25 Q/A                - X Size by 8 pixels\r
26 W/S                - Y Size by 1 pixel\r
27 W/S + SHIFT        - Y Size by 8 pixels\r
28 E/D                - Bits (Number of colors)\r
29 R/F                - Skip Bytes between pictures or bitplanes\r
30 R/F + SHIFT        - Skip Bytes Faster (by 8 bytes)\r
31 LEFT/RIGHT         - Picture Left/Right by 8 pixels (Offset by 1 byte)\r
32 UP/DOWN            - Picture Up/Down by 1 line (Offset by X Size/8)\r
33 UP/DOWN + SHIFT    - Picture Up/Down by 8 lines (Offset by X Size)\r
34 LEFT/RIGHT + SHIFT - Next/Previous Picture (Offset by X Size * Y Size)\r
35 G                  - Set Offset\r
36 H                  - Set Skip Value\r
37 X                  - Set Skip Mode (P - Pictures , B - Bitplanes)\r
38 P                  - Save picture(s)\r
39 P + SHIFT          - Save picture(s) with Auto-Incremental Name\r
40 L                  - Search for Amiga Palette (Press again for more)\r
41 Z                  - Palette search mode (look below for description)\r
42 K                  - Revert to standard Palette\r
43 J                  - Revert to last found Amiga palette\r
44 B                  - Set colour 0 to Magenta (255,0,255) - Transparent\r
45 N                  - Normal or Reverse order of bitplanes\r
46 0-7                - Select which picture goes into which bitplane\r
47 0-7 + SHIFT        - Same as above only in reverse direction\r
48 M                  - Bitplane Mode , see below !\r
49 C                  - Get Colour palette from a file\r
50 U                  - Turns on/off a Zoom window on the bottom/right corner\r
51 ESC                - Go out\r
52 CTRL + INSERT      - Copy the first image to Clipboard\r
54 Command Line Arguments:\r
55 -----------------------\r
56 Only one - Name of the file you want to process. If none is given then\r
57 a file selector will pop up where you can select the file.\r
59 Save Pictures:\r
60 --------------\r
61 Will save into current directory.\r
62 You can save any number of pictures to this filename. Instead of\r
63 number of pictures you specify how many of them will fit into X and\r
64 Y direction. The actual number of saved pictures is X*Y (ofcourse).\r
65 Also you can specify the direction in which the pictures will be\r
66 put into the file. The left->right direction is the same as you see\r
67 them on the screen. The up->down will do the opposite.\r
69 Bitplane Mode:\r
70 --------------\r
71 AM = Amiga standard : Each bitplane is in its own picture,\r
72 ST = ST standard :    Same picture holds all bitplanes - each other line\r
73                       is a new bitplane - some tiles are in this format)\r
74 SP = Amiga Sprite :   This is a special mode to rip the AMIGA format\r
75                       sprites in 16 colours (4 bitplanes). The sprites are\r
76                       always 16 pixels wide (X Size) and can be any Y size.\r
77                       You can spot them by seeing two bitmaps with 2\r
78                       pictures in each bitmap (if looking in AM mode).\r
79 C+ = CPC Double :     CPC Standard Double Byte mode. One Character is one\r
80                       bitplane - the Bytes follow each other for Plane 0,1.\r
81                       (Head Over Heels, Batman)\r
82 C- = CPC Single :     CPC Standard Single Byte mode. One Character holds\r
83                       BOTH bitplanes (4 pixels per Byte). This is used in\r
84                       many games. Sometimes Bitplanes are mirrored.\r
85                       (Amaurote, Ultimate games, etc.)\r
86 Palette Search:\r
87 ---------------\r
88 By pressing this button the file is searched for a possible copperlist.\r
89 Bu default the Mode E is selected which basically extracts the ECS\r
90 palette from the UAE SaveState snapshot. If the palette was not found in\r
91 this mode then you will have to use one of the other three modes.\r
93 There are four palette search modes:\r
95 E = ECS UAE SaveState - The DEFAULT mode : the palette is extracted from the\r
96     UAE SaveState snapshot (if found). ECS (upto 64 colours) only !\r
97 A = AGA UAE SaveState - the palette is extracted from the UAE SaveState\r
98     snapshot (if found). AGA colours (upto 256) are extracted !\r
99 S = Simple - Doesn't find so many palettes, and it is fast, searches whole\r
100     memory for possible palette entries (2 possible entries, always in\r
101     sequence).\r
102 X = Advanced - The copperlist is searched in a way that when 4 possible\r
103     colour entries (not needed to be in sequence) are found it is reported\r
104     as a valid palette.\r
106 Make sure you save the Snapshots (SaveStates) as UNCOMPRESSED in WinUAE !!!\r
108 If you want to set colour 0 to allegro standard transparent then press 'B' !\r
110 Bitplane Order:\r
111 ---------------\r
112 Normal bitplane order has first picture for bit 0, Reverse bitplane order\r
113 has last picture for bit 0. You can also press numbers 0-7 on your\r
114 keyboard to have a totally manual order of bitplanes (press it with\r
115 SHIFT and you will decrease picture number of that bitplane) !\r
117 Skip Mode:\r
118 ----------\r
119 If the skip mode is 'P' it will skip number of bytes between each picture.\r
120 All bitplanes follow each other in this mode. If the skip mode is set to\r
121 'B' it will skip a number of bytes between each bitplane for the picture.\r
123 A bit of help if you can't start with it:\r
124 -----------------------------------------\r
125 Use amiga memory dumps which can be done with WinUAE (Misc section).\r
126 They can be a bit big, since they are uncompressed, but they are exactly\r
127 what you need !\r
129 The main thing is that you don't set the Bitplanes in the beginning -\r
130 first you find the pictures in 2 colour mode and after that you fiddle\r
131 with the bitplanes. \r
133 The other thing is that you must have a sense of what is a bitmap. If\r
134 you think that tiles are 16 pixels wide that almost never means that \r
135 they are stored like that in the memory, infact they are mostly stored \r
136 in some totally bogus width. \r
137 For this reason it is vital that you can "SPOT" the bitmap in any \r
138 X-size... this can only be done with doing this thing a lot. But \r
139 normally you can spot it when diagonal lines in the bitmap start \r
140 appering. But if you don't know what i am talking about then it is best \r
141 to put your X- Size (with Q/A) keys to some normal value for amiga \r
142 graphics - like 320 for example. Set the Y-Size to 200 or so, so that \r
143 you can go quickly through the memory - with SHIFT left/right arrows. \r
145 Now when you spot something you *think* might be tiles or bitmap or \r
146 something then use thr Q/A keys to alter the X-Size and then it will \r
147 show up (probably - again you need practice for this to work ).\r
149 Now you got your X-size down you have to adjust the Y-Size and \r
150 position (size with W/S and position with UP/DOWN (and with SHIFT)) ... \r
151 when you have done that you have it mostly done....\r
153 Now you can see the picture on the screen and bitmaps are aligned one \r
154 next to each other. Sometimes there is some rubbish between them and \r
155 here you can use the R/F keys to adjust skip bytes between bitmaps.\r
157 Now you can select number of bitplanes with E/D keys... when the \r
158 picture comes up in desired number of bitplanes (you will see when \r
159 the rubbish starts to appear - then it is too many ;-) ) - after \r
160 that you can start searching for the pallete - first use simple mode \r
161 (normally it works) and after that the advanced if the simple mode \r
162 didn't work. Sometimes you cannot find the pallete.\r
164 OK, in about half games the tiles/sprites are stored separately and \r
165 in the other half the tiles/sprites are on the same bitmap (which is \r
166 much bigger) - if they are stored separately then you can select how \r
167 many tiles you want to save at once in your file (and how many in x/y \r
168 direction).\r
170 I think this should explain the most of the inner workings of the \r
171 tool... as I said, since it is fully manual you must have some \r
172 practice to "spot" the bitmap when it doesn't have the right X-size.\r
174 And then there are other things, like interleaved bitmaps (i.e. ST \r
175 type of bitmaps) where each other bitmap is in each other line... and\r
176 the Amiga format sprites, but this is advanced already (look above) ;-)\r
179 Have fun with this one !\r