--- uae/docs/README 2018/04/24 16:56:13 1.1.1.15 +++ uae/docs/README 2018/04/24 16:59:47 1.1.1.17 @@ -1,4 +1,4 @@ -This is version 0.8.15 of UAE, the Un*x Amiga Emulator. +This is version 0.8.17 of UAE, the Un*x Amiga Emulator. Versions numbered 0.8.x are beta versions, to be used for development only. If you are only a user of UAE, you are better off using the latest 0.7.x @@ -15,9 +15,6 @@ for UAE. See the file COPYING that is included in the top level directory of this archive for details. -The SCSI code distributed with UAE is also available under the terms of the -GPL and was written by J. Schilling. - Overview ======== @@ -159,13 +156,18 @@ autoconfig=bool [default=yes] kbd_lang=lang [default=us] Set the keyboard language. Currently, the following values can be used: "us" for U.S. keyboard (default), "se" for swedish, "fr" for french, "it" for - italian, "es" for spanish, or "de" for german keyboard. + italian, "es" for spanish, "dk" for danish, or "de" for german keyboard. This setting only affects the X11 version. floppy0=file [default=df0.adf] Try to use the specified file as diskfile for drive 0 instead of df0.adf. The options floppy1, floppy2, and floppy3 also exist. kickstart_rom_file=file [default=kick.rom] Use the specified file instead of kick.rom as Kickstart image. +kickstart_key_file=file [default=none] + For some strange licensing reasons, Cloanto had to encrypt the ROM images + they ship with the Amiga Forever package. This option lets you select the + key file; this is only necessary if you are using one of the ROMs from + Amiga Forever. joyport0=mode [default=mouse] Specify how to emulate joystick port 0. You can use "mouse", "joy0", or "joy1" to use the corresponding input devices of your machine, or you can @@ -190,6 +192,14 @@ use_gui=bool [default=yes] immediate_blits=bool [default=no] If enabled, all blits will finish immediately, which can be nice for speed, but may cause incompatibilities. +collision_level=level [default=sprites] + This can have a value of "none", "sprites", "playfields", or "full". If + set to "sprites", the emulator will only compute collisions between sprites. + If set to "playfields", it will additionally compute collisions between + sprites and the background. This is much slower and used only rarely. When + "full" level is selected, collisions of the background with itself are also + computed. This is also used very rarely, and makes the emulator even slower. + Using "sprites" or "none" will almost always be enough. cpu_speed=speed [default=4] This can have a value of "real", "max", or an integer between 1 and 20. "real" will try to give the CPU emulation exactly as many cycles, relative @@ -198,6 +208,12 @@ cpu_speed=speed [default=4] specify a fixed relation between CPU and custom chip emulation, where lower values prioritize CPU emulation, while higher values prioritize custom chip emulation. +finegrain_cpu_speed=speed + Like cpu_speed, but only accepts numeric values. These numeric values are + equivalent to the ones given to cpu_speed multiplied by 512. This means + that "cpu_speed=2" and "finegrain_cpu_speed=1024" have the same effect. + Using this option you can give the CPU emulation a much higher priority by + using small values. cpu_type=type [default=68000] Controls which CPU is emulated. This can be "68000", "68010", "68020" or "68020/68881". In some cases, you may need to use "68ec020" or @@ -238,7 +254,14 @@ sound_output=type [default=none] slightly more accurate emulation that may be necessary in some cases, but can also be slower). sound_channels=type [default=mono] - Can be "mono" or "stereo". + Can be "mono", "stereo", or "mixed". If set to "stereo", the left and right + channels produce the same output as on a real Amiga - two of the four audio + channels are audible on the left, and the other two on the right. This is + exactly what you want, except if you're using headphones - having the sound + split so strictly can lead to a strange listening experience at times. This + is what "mixed" is trying to solve: it mixes the left channel with a low + volume into the right channel and vice versa. (This mixing operation loses + a bit of precision in the output). sound_bits=n [default varies across UAE versions on different OS types] Common values are 8 (low quality) or 16 (high quality) sound_frequency=n [default varies across UAE versions on different OS types] @@ -507,7 +530,7 @@ If you don't have much RAM and can't fit you can split up the transfer into multiple parts with the "-s" and "-e" parameters. To transfer the disk in four parts, you'd use the following commands: - + transdisk >ram:df0_1.adf -s 0 -e 19 transdisk >ram:df0_2.adf -s 20 -e 39 transdisk >ram:df0_3.adf -s 40 -e 59 @@ -556,7 +579,7 @@ Picasso 96 graphics card emulation ================================== To use this feature, you must select 68020 emulation with a 32 bit address -space. You also need a Kickstart 3.x ROM. +space (i.e. _not_ 68ec020). You also need a Kickstart 3.x ROM. To specify how much graphic memory you want to emulate, use the "-U" option, e.g. "-U 4" for 4 megabytes. Then, you need the Picasso 96 software which @@ -567,10 +590,32 @@ After that is complete, reboot, and you modes from the ScreenModes program. +Saving and restoring snapshots +============================== + +From version 0.8.17 onwards, the emulator has the capability to save the +current state of the emulation into a "snapshot" file that can be restored +later on. This functionality is available through the GUI on some ports. +It is mainly useful for computer games that either have no save game +feature, or whose save game feature does not work on UAE (often, games try +to save in a non-standard disk format, this can be tricky to emulate). + +There are several restrictions that apply to the save state feature: + + - It is at the moment experimental. It is not guaranteed that the + emulator can correctly restore every snapshot. It is not guaranteed + that future versions of the emulator will be able to restore snapshots + saved by this version. + - The state of the harddisk emulation cannot be saved. This makes it + essentially useless for applications, but remember it's designed for + games. Be careful with games that have been installed to the harddisk. + - Neither ROM contents nor floppy disk contents are saved right now. + + UAE SCSI device =============== -To enable SCSI support, use --enable-scsi-device when running configure. +To enable SCSI support, use --enable-scsi-device when running configure. The emulator provides a uaescsi.device. This device only supports direct SCSI, which is sufficient to run applications like MakeCD. The device does not support reading or writing with the normal Exec commands, @@ -728,7 +773,7 @@ Special thanks to: - Michael C. Battilana and Cloanto Software, for all their support. - Julian Eggebrecht of Factor 5, for providing several F5 games and a lot of valuable input. - Factor 5 has made Katakis, one of their classic Amiga games, freely + Factor 5 has made several of their classic Amiga games freely available for download. There are still some good people left in the world... - Jens Schönfeld, inventor of the Catweasel controller, donated one @@ -751,9 +796,9 @@ crux@pool.informatik.rwth-aachen.de or, via snailmail Bernd Schmidt -Schlossweiherstrasse 14 -52072 Aachen -Germany +21 St Stephen's Place +Cambridge CB3 0JE +UK Email is more likely to be answered, and will definitely be answered much faster. Please avoid phonecalls if you can.