Special-case no-resize dump->raw conversion
[jpcrr.git] / BRIEF-INSTALLATION-INSTRUCTIONS
blob8a41462b872e2d142f45981da88d97f132a2b8b5
1 JPC-RR quick installation instructions:
3 1) Ensure you have JDK6 installed, if not, install it (no, JRE or JDK5 is
4 not sufficient)
6 2) Compile the source. './build.sh' (Unix) or 'build' (windows).
8 3) Get BIOS/DOS disk images. Original JPC source code
9 (http://www-jpc.physics.ox.ac.uk/download_download.html) is good place
10 to rip those from. They are files bios.bin, vgabios.bin and floppy.img.
12 4) Change directory to top of source tree and make directory named
13 'library' (or something like that).
15 5) Convert the images:
17 'java ImageMaker --BIOS library/BIOS <path-to-bios.bin>'
18 'java ImageMaker --BIOS library/VGABIOS <path-to-vgabios.bin>'
19 'java ImageMaker --floppy1440 library/FreeDOS <path-to-floppy.img>'
21 Note that BIOS should be named 'BIOS' and vgabios should be named
22 'VGABIOS' as those are the defaults for main system BIOS / VGA BIOS.
24 If the floppy image is not for 1.44MB floppy, that --floppy1440 option
25 may need adjusting (e.g. use --floppy2880 for 2.88MB images).
27 6) Grab game files and make images out of these:
29 'java ImageMaker --HDD=16,63,16 library/somegame <directory-of-game-files>'
31 I use 16,63,16 if game fits into that (it provodes ~8MB space). If it
32 doesn't then 128,63,16 (~64MB) or even 1023,63,16 (~512MB).
34 The emulator should now be set up.
36 7) Launch the emulator
38 'java JPCApplication -library library -autoexec assemble.bat'
40 Autoexec.bat contains reasonable set of initialization commands.
42 If you run emulator from directory other than the source tree, then:
44 -Set CLASSPATH to '<directory-jpcrr-source-is>:.' (Unix) or
45 '<directory-jpcrr-source-is>;.' (Windows)
46 - Replace 'library' with path to library directory.
47 - Replace 'assemble.bat' with path to corresponding file.
49 Hints:
51 - DOSIDLE interferes with emulator. Either skip autoexec.bat coming
52 on FreeDOS that comes with JPC or confirm line by line and leave
53 that out.
54 - Putting the HD as HDD (4th hard drive) avoids BIOS having to timeout
55 HDD, speeding up boot.