Rename assemble.bat to assemble.jpcrrinit as its not DOS batch file
[jpcrr.git] / build-files / BRIEF-INSTALLATION-INSTRUCTIONS
blobfc01c1fb26b63f8c4e6fe05c769b765e959b054f
1 JPC-RR quick installation instructions (binary):
3 1) Ensure you have JRE6 installed, if not, install it (no JRE5 is not
4 sufficient)
6 2) Get BIOS/DOS disk images. Original JPC source code
7 (http://www-jpc.physics.ox.ac.uk/download_download.html) is good place
8 to rip those from. They are files bios.bin, vgabios.bin and floppy.img.
10 3) Change directory to top of source tree.
12 4) Launch the emulator
14 Set CLASSPATH to point to jpcrr JAR and possibly other locations if you
15 want to add some extensions.
17 'java -jar jpcrr-<version>.jar -library disklibrary -autoexec assemble.jpcrrinit'
19 disklibrary is directory where disk images are found and stored
20 (if it doesn't exist, it will be created).
21 assemble.jpcrrinit contains reasonable set of initialization commands.
23 First time you start, you may get complaint about being unable
24 to find BIOS image. Just dismiss it.
26 5) Convert the images:
28 Import BIOS image: Select Drives  -> Import Image and input
30 Image Name: BIOS
31 Image File: <path-to-bios.bin>
32 Image Type: BIOS image
34 Then hit "import". Pop-up should say that image was imported.
36 Then same thing for VGABIOS, this time values are:
38 Image Name: VGABIOS
39 Image File: <path-to-vgabios.bin>
40 Image Type: BIOS image
42 Import FreeDOS image, values are:
44 Image Name: FreeDOS
45 Image File: <path-to-floppy.img>
46 Image Type: Floppy disk
47 Standard geometry: Checked
49 Note that BIOS should be named 'BIOS' and vgabios should be named
50 'VGABIOS' as those are the defaults for main system BIOS / VGA BIOS.
52 If the boot floppy is oddly sized, you may have to specify geometry
53 manually.
55 6) Grab game files and make images out of these:
57 File -> Import image and fill the form. The image file may be directory.
59 I use 16 sides,63 sectors,16 tracks if game fits into that (it provodes
60 ~8MB space). If it doesn't then bump tracks to 128 (~64MB) or even 1023
61 (~512MB).
63 The emulator should now be set up (File->Assemble)
65 7) To relaunch the emulator, use the same command as in 4)
67 'java -jar jpcrr-<version>.jar -library disklibrary -autoexec assemble.jpcrrinit'
69 Replace parameters with appropriate values if needed (and set CLASSPATH
70 if needed, see 4)).
72 Hints:
74 - DOSIDLE interferes with emulator. Either skip autoexec.bat coming
75 on FreeDOS that comes with JPC or confirm line by line and leave
76 that out.
77 - Putting the HD as HDD (4th hard drive) avoids BIOS having to timeout
78 HDD, speeding up boot.