![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to README CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [UNIX Amiga Emulator] / uae / docs|
Return to README CVS log | Up to [UNIX Amiga Emulator] / uae / docs |
1.1.1.5 ! root 1: This is version 0.8.5 of UAE, the Un*x Amiga Emulator. ! 2: ! 3: Versions numbered 0.8.x are beta versions, to be used for development only. ! 4: If you are only a user of UAE, you are better off using the latest 0.7.x ! 5: version or waiting for 0.9.0. ! 6: 1.1 root 7: 1.1.1.3 root 8: License 9: ======= 1.1 root 10: 1.1.1.5 ! root 11: UAE is available under the terms of the GNU General Public License. This means ! 12: that it is free software: you are welcome to distribute copies of it and/or ! 13: modify it, under certain conditions. It also means that there is no warranty ! 14: for UAE. ! 15: See the file COPYING that is included in the top level directory of this ! 16: archive for details. 1.1 root 17: 18: 19: Overview 20: ======== 21: 1.1.1.2 root 22: An emulator is a program which enables you to run software for a machine 23: which has non-native hardware and a non-native operating system, on your 24: computer. UAE allows you to run most of the available Amiga software. It is a 25: software emulation, meaning that no extra or special hardware is needed to do 26: this. The hardware of an Amiga is emulated accurately, so that Amiga software 27: is tricked into thinking it is running on the real thing, with your computer's 28: display, keyboard, harddisk and mouse taking the parts of their emulated 29: counterparts. 1.1 root 30: 31: UAE was developed for Unixoid systems. Meanwhile, it has been ported to the 1.1.1.2 root 32: Mac, DOS, the BeBox, NextStep, the XFree86/OS2 environment and the Amigas (it 33: can run itself by now). You should have received several other files along 34: with this document with details on how to install and use the version for your 35: operating system. 1.1 root 36: 37: This section is just what it says: an overview. Please read _all_ of this 1.1.1.2 root 38: file, especially if you have problems. UAE has many, many features and 39: equally many configuration options. If you don't know about them, it's likely 40: that UAE doesn't work for you, or doesn't work as good as it could. 41: 42: Please read also the file "FAQ" which contains some Frequently Asked 1.1.1.3 root 43: Questions (and even the answers!) You should also look for a document 44: describing the specific port of UAE to the operating system you are using, 45: for example "BeOS/README" or "DOS/README". 1.1.1.2 root 46: 47: People have complained that the UAE documentation contains only "weird jargon". 48: Sorry about this. Despite what MessySoft and Tomato tell you, computer 49: programs aren't always easy to use. UAE does require some assistance from you, 50: and therefore you should at least understand a bit about computers. After all, 51: you are an Amiga fan, so you should know what a Workbench is, don't you think? 1.1 root 52: 53: 1.1.1.2 root 54: Features 55: ======== 56: 57: This version of UAE emulates: 1.1 root 58: 1.1.1.5 ! root 59: - A 68000, 68010 or 68020 CPU, optionally a 68881 FPU 1.1.1.2 root 60: - OCS Graphics Chipset, plus big blits from the ECS Chipset 1.1.1.5 ! root 61: - Up to 2MB Chip RAM and up to 8MB Fast RAM, or 8MB Chip RAM without Fast RAM ! 62: - Up to 64MB Zorro III Fast RAM, independent of Chip RAM setting (68020 only) 1.1.1.3 root 63: - Up to 1MB Slow RAM, for extended compatibility with problem software 64: - Up to 8MB of graphics card memory, usable by software that supports 1.1.1.5 ! root 65: Picasso 96 compatible graphics cards ! 66: - 4 x 3.5" floppy disk drives (DF0:, DF1:, DF2: and DF3:). It's not possible to ! 67: read Amiga disks, so these are emulated with disk files. ! 68: - A hard-disk: either a harddisk image file or part of the native filesystem 1.1.1.2 root 69: - Joystick support (with option of mapping joystick to numeric keypad) 70: - Mouse support 71: - Ability to run in various screen modes (for better display quality or 72: better speed) 1.1.1.5 ! root 73: - Full stereo sound support, consisting of 4 x 8bit channels 1.1.1.3 root 74: - Beta parallel and serial port support 1.1.1.2 root 75: - some other things which don't work well enough to mention them here... 76: 77: 78: Requirements (IMPORTANT! READ THIS!)/Limitations 79: ================================================ 80: 81: Not emulated: 1.1.1.3 root 82: - Sprite to playfield collisions (sprite to sprite collisions work) 83: - An MMU (part of 68030/040 CPUs except those that Commodore used). This means 1.1.1.2 root 84: you can't use virtual memory systems or real operating systems like Linux 85: or BSD. 86: - The AGA chipset (A4000/A1200). This chipset has enhanced capabilites for 87: up to 256 colors in all resolutions. 1.1.1.5 ! root 88: - Serial port emulation exists but doesn't work too well (someone tell me when ! 89: that's no longer true, I don't use it). 1.1.1.2 root 90: 91: Since the PC floppy controller can't read Amiga disks (yes, that's a fact), 92: floppy access has to be emulated differently: Floppies are emulated by means 93: of disk files that contain a raw image of the floppy disk you want to emulate. 94: A disk file is an image of the raw data on an Amiga floppy disk, it contains 95: 901120 bytes (880K), which is the standard capacity of an Amiga disk. 96: 97: To actually run the program, you'll need to install the ROM image from your 98: Amiga. You can't run UAE if you don't have this image. It is not included 99: because it is copyrighted software. Don't ask me to send you one. I won't. 100: If you don't have an Amiga and still want to use UAE, you'll have to buy an 101: Amiga or at least the system software (ROM + Workbench) first. 102: The Kickstart image can have a size of either 256K or 512K. It must be named 103: "kick.rom" by default. 104: 105: Read the section "tools" below for information how to create ROM images and 106: disk files. 1.1 root 107: 108: If you don't have a Kickstart file, you may still be able to boot some games 109: and demos. The emulator includes some primitive bootstrap code that will try 110: to read and execute the bootblock of the diskfile you are using, and if that 111: bootblock only uses the one or two Kickstart functions that are supported by 112: the "replacement Kickstart", your program will boot. Don't expect too much, 113: though. 114: 1.1.1.2 root 115: You'll also need some other software to run - why else would you want to 116: emulate an Amiga? There are several ways to make the software accessible to 1.1.1.3 root 117: UAE, either with disk image files or with a harddisk emulation. You should 118: make an image of your Amiga's Workbench disk and install it as "df0.adf" 119: (adf = Amiga Disk File) when you use UAE for the first time. More about how 120: to create these files in the chapter "Transferring software" 121: 122: To use Picasso96 emulation, you need the Picasso96 libraries, which are also 123: not included. They can be obtained (e.g.) from Aminet. 1.1 root 124: 125: 126: Invoking UAE 127: ============ 128: 1.1.1.2 root 129: First, read the system-specific documents for information how to set up UAE. 130: You should have an executable program called "uae". You can simply execute it, 1.1.1.3 root 131: but you can also optionally give it one or more of the following options: 1.1 root 132: 133: General options: 134: -h : Give help on the options. 1.1.1.2 root 135: -A n : Set emulator accuracy to n. The default is n = 2, which means the 136: emulator will try to be as accurate as possible. This no longer 137: does much in this version, and I'll probably remove it. 1.1 root 138: -f n : Sets the frame rate to 1/n. Only every nth screen will be drawn. 139: -a : Add no expansion devices. This will disable fastmem and harddisk 140: emulation, but some extremely badly-written games may need this. 1.1.1.3 root 141: (Kickstart 1.2 needs it, too) 1.1 root 142: -l lang : Set the keyboard language. Currently, the following values can be 143: used for lang: "us" for U.S. keyboard (default), "se" for swedish, 1.1.1.3 root 144: "fr" for french, "it" for italian, "es" for spanish, or "de" for 145: german keyboard. 146: This setting only affects the X11 version. 1.1 root 147: -0 file : Try to use file as diskfile for drive 0 instead of df0.adf. 1.1.1.3 root 148: The options -1, -2 and -3 also exist for the other drives. 1.1 root 149: -r file : Use file instead of kick.rom as Kickstart image. 1.1.1.3 root 150: -J xy : Specify how to emulate joystick port 0 (x) and 1 (y). Both x and y 151: can be one of the following characters: 0 = joystick 0, 1 = 152: joystick 1, M for mouse, and a, b or c stand for various keyboard 153: replacements (a is the numeric pad with '0' as fire button, b the 154: cursor keys with right control as fire button and c is T/F/H/B with 155: Alt as fire button. 156: The default is "-J M0" (mouse and joystick as usual) 1.1 root 157: -G : Disable the user interface (if present). 1.1.1.3 root 158: -n specs: Set blitter emulation. "specs" is a string of characters. If it 1.1.1.2 root 159: contains a "3", the blitter will use 32 bit operations where that 160: seems profitable (note that this will cause bus errors on most 161: RISC machines). If you specify "i", all blits will finish 162: immediately, which can be nice for speed. To enable both options, 163: say "-n 3i" 1.1.1.3 root 164: -w n : Set CPU emulation speed to n. The default value is 4; higher values 165: will give the custom chip emulation a higher priority over the CPU, 166: but some programs crash if this is higher than 4. Setting it to 1 167: is a good way to make the emulator run slower on machines which are 168: too fast. 169: -C specs: Controls how the CPU is emulated. The first letter must be '0' for 170: 68000 emulation, '1' for 68010, '2' for 68020 or '3' for 171: 68020 + 68881. It can be followed by a 'c', which enables a slower 172: but more compatible version of 68000 emulation, or by an 'a', which 173: enables a 24 bit address space for 68020 emulation. Normally you 174: don't want either; use the more compatible emulation if some game or 175: demo does not work. The 24 bit address space option appears to be 176: necessary for some Kickstart ROMs, so try that if things don't work 177: at all. 1.1 root 178: 1.1.1.3 root 179: Emulating external devices (harddisk, CD-ROM, printer, serial port): 1.1 root 180: -M VOLUME:path 181: -m VOLUME:path 1.1.1.3 root 182: Mount the unix file system at "path" as an Amiga filesystem with 1.1 root 183: volume name "VOLUME:". For example, "-M sound:/usr/amiga/modules" 1.1.1.3 root 184: If you use -M instead of -m, the volume will be read only. Use this 185: for mounting CD-ROMs. See below. 186: -W secs:heads:nr:file 187: Mount the hardfile "file" as an emulated harddisk, using a geometry 188: of "secs" sectors per track, "heads" surfaces and "nr" reserved 189: blocks. Can be abused to mount floppy images. See below. 1.1 root 190: -p cmd : Enable printing. See below. 1.1.1.3 root 191: -I dev : Use "dev" as serial device (e.g. /dev/ttyS1 on Linux). 1.1 root 192: 193: Sound options: 1.1.1.3 root 194: -S specs: If your version of UAE supports sound, this option allows you to 195: tell the emulator how to produce sound. The specs parameter is 196: made up as follows: 197: n:stereo:bits:frequency:minimum buffer size:maximum buffer size 198: You can use one of the following values for "n": 1.1 root 199: n = 0: No proper sound emulation at all. May be incompatible 200: (unlikely). This is the default. 201: n = 1: Emulate the sound hardware, but don't output sound. May be 202: needed for compatibility, but can be much slower 203: n = 2: Emulate the sound hardware and output sound. Recommended. 204: n = 3: Emulate the sound hardware _exactly_. I don't think you'll 205: hear a difference. SIDmon modules will be emulated 206: correctly, but painfully slow with this setting. 1.1.1.3 root 207: Unfortunately, this may also be needed to get some programs 208: to work (AIBB, for example). 209: Use either 's' or 'm' to set the "stereo" value. 210: For "bits", common values are 8 (low quality) or 16 (high quality). 211: For "frequency", common values are 22050 or 44100. The quality of 212: sound output increases with the frequency. 213: You can specify the minimum and maximum size of the sound buffer. 214: Smaller buffers reduce latency. 215: You don't need to specify all of the options, you can stop after 216: each subpart. Examples: "-S0" (sound off), "-S2:s" (sound on, 217: stereo), "-S3:m:16:44100" (complete emulation, mono, 16 bits, 218: 44100 Hz). 219: Note: high quality sound requires a lot of computing power, so try 220: with different settings if your machine is not fast enough. 221: 1.1 root 222: Memory options: 223: -s n : Emulate n*256K slow memory at 0xC00000. Some demos/games need this. 224: -F n : Emulate n megabytes of fast memory as an expansion board. 1.1.1.3 root 225: -Z n : Emulate n megabytes of Zorro III fast memory as an expansion board. 1.1 root 226: -c n : Emulate n*512K chip memory. The default is 2MB chipram. Some very 1.1.1.3 root 227: broken programs need "-c 1" to work properly. The largest legal 228: value is "-c 16", which means 8MB chip memory. 229: -4 n : Usually, UAE uses a 24 bit address space when it emulates a 68000, 230: and a 32 bit address space when it emulates a 68020. If n is 1, 231: this option turns on a 24 bit address space in 68020 emulation. It 232: appears to be necessary for some Kickstart images. Careful: this 233: option has harmful side effects, and should be disabled by default. 234: 235: Debugging options (not interesting for most users): 1.1 root 236: -D : Don't start the emulator at once, use the built-in debugger. 237: -i : Print illegal memory accesses 238: 239: Display options: 240: -H mode : Select a color mode to use. 1.1.1.2 root 241: -O specs: Select a display mode, see below how the specs parameter is 242: interpreted. 1.1.1.3 root 243: -U n : Emulate a Picasso 96 compatible graphics card with n MB graphics 244: memory. 245: 1.1 root 246: Color modes: 0 (256 colors, default); 1 (32768 colors); 2 (65536 colors) 247: 3 (256 colors, with dithering to improve color quality) 248: 4 (16 colors, dithered); 5 (16 million colors) 249: 1.1.1.2 root 250: About the "-O" display specs. These consist of the width and height of the 251: mode, plus optional modifiers. One valid option to pass to UAE would be 252: "-O 640:300:" which means use a display 640 pixels wide and 300 pixels high, 253: with no modifiers (nothing after the second ":"). You may specify the 254: following modifiers: 255: l: Tell UAE to omit drawing every second pixel horizontally (for "lores" 256: modes). Example: "-O 320:200:l" 257: x: Tell UAE to try to fit the image horizontally into the displayed 258: window. For example, if you have a mode that is 640 pixels wide, and the 259: displayed image is also 640 pixels wide, the picture may still be 260: partially invisible because it is displayed too wide to the left or to 261: the right. With the "x" modifier, UAE tries to prevent this. 262: You can also specify a capital "X", in that case, UAE tries to be 263: extremely clever when doing this. 264: y: The same thing in green, for fitting the image vertically into the 265: window. (Y also exists) 266: d: Draw every line twice. This allows interlace mode to be emulated nicely, 267: but of course you also need a display that is twice as high 268: c: Correct the aspect. This will omit certain lines of the display to make 269: it fit better into the screen. 270: 271: Whew. You'll probably have to experiment a little to get a feeling for it. 1.1.1.3 root 272: 1.1.1.2 root 273: 1.1 root 274: UAE may choose to ignore and/or refuse some combinations of these two 275: parameters. Some of these modes may also fail to work on your system. 276: 277: You can also put these options into a configuration file in your home 278: directory. Simply create ~/.uaerc and put some of these options in it. On 279: non-Unix systems, the file is called uae.rc and should be located in the 280: current directory. 281: 282: 283: Choosing color and screen modes 284: =============================== 285: 286: As described in the previous paragraph, UAE can run in many different 287: resolutions and color modes. However, few of the color mode options are 288: available if you use the X11 version of UAE, since the X server determines 289: how many colors are available. If you are running a 256 color X server, you 290: can use "-H3" to tell UAE to dither the colors for better results. 291: 292: You will have to experiment which mode gives the best results for you at a 293: satisfying speed. Note that the dithering process consumes time, so even if 294: 256 colors with dithering look better than 256 colors without, remember that 295: UAE will be slower in that mode. 296: 297: The recommended resolution is 800x600. In the lower resolution modes, some 298: overscan pictures the Amiga tries to display may not fit entirely on the 299: screen, others may be off-center and some graphical effects may look weird. 300: For best results, use 800x600 with at least 32768 colors. 1.1.1.3 root 301: For speed, use 400x300 lores with 256 colors. 302: 303: _Don't_ use 24 bit or 32 bit screen modes, unless you absolutely have to. 304: These are way too slow to be usable. 1.1 root 305: 306: 307: Harddisk emulation 308: ================== 309: 1.1.1.3 root 310: Since using diskfiles is awkward, it is necessary to emulate harddisks. There 311: are two ways how you can use large amounts of data with UAE: harddisk files 312: and mounted directories. 313: 314: 1. Harddisk files 315: 316: Harddisk files are large files that contain the image of an Amiga filesystem. 317: They work much the same way as a disk file. You can simply create a large 318: empty file and tell UAE to use it as a hardfile, but you will need to format 319: it from the emulation before you can actually use it. 1.1 root 320: 1.1.1.3 root 321: Under Unix, You can create a (unformatted) harddisk file with 1.1 root 322: dd if=/dev/zero of=hardfile bs=512 count=16384 1.1.1.3 root 323: That will create an 8MB file. Other ports of UAE may come with a utility 324: called "makedisk" or other ways to create such a file. 1.1.1.2 root 325: 1.1.1.3 root 326: To tell the emulator that you want to use a certain file as a hardfile, use 327: the "-W" option, for example 328: uae -W 32:1:2:hardfile 329: The first three numbers are geometry information which tell the AmigaOS how 330: the file is organized. The first number (32) is the number of sectors per 331: track, the second number (1) is the number of heads or surfaces, the third 332: number (2) is the number of reserved blocks. If you use "normal" sizes 333: (powers of two, like 32MB), then you should be OK using the same numbers as 334: in the above example. Using different numbers can make sense if you transfer 335: the image of a real Amiga harddisk which uses a different geometry. The last 336: field of the argument to the "-W" option is the name of the harddisk file. 337: 338: If you are using Kickstart 1.3 or earlier, hardfiles can't currently be 339: mounted at boot time, and therefore you can't boot from it either. You will 340: have to boot either from a floppy disk image or from a filesystem (see below), 341: and mount the hardfile.device later. To do this, add the following to 342: "DEVS:mountlist": 1.1 root 343: 1.1.1.3 root 344: UAE0: Device = uaehf.device 1.1 root 345: Unit = 0 346: Flags = 0 347: Surfaces = 1 348: BlocksPerTrack = 32 349: Reserved = 1 350: Interleave = 0 351: LowCyl = 0 ; HighCyl = 511 352: Buffers = 5 353: DosType = 0x444F5300 354: BufMemType = 1 355: # 356: 1.1.1.3 root 357: (You may need to adjust the values if you specified a different geometry, 358: and/or your hardfile has a different size than 8MB, and/or the hardfile is not 359: mounted as UAE0: because you mounted other harddisks before it.) 360: 1.1 root 361: Then, type "mount UAE0:" (or put that command in your startup-sequence), and 362: you should be able to access it. Don't forget to format it with the AmigaDOS 363: format command: 364: 365: format drive uae0: name Mister_Willwink 366: 1.1.1.3 root 367: b) Accessing native filesystems from the emulator 1.1 root 368: 369: This has some major advantages: 370: - It has no problems with Kickstart 1.3 371: - It is more convenient. 1.1.1.3 root 372: - It is much faster. 1.1 root 373: 1.1.1.2 root 374: If you specify the -M or -m command line arguments, you your native filesystem 375: from the emulator. If you start UAE with 1.1 root 376: 377: uae -m sound:/usr/amiga/modules 1.1.1.2 root 378: 1.1 root 379: you can access all the files in /usr/amiga/modules by reading from the 380: AmigaDOS volume "SOUND:". 381: (DOS users: try "uae -m dh0:C:\" to mount your drive C:\ as DH0:) 382: 1.1.1.3 root 383: You can mount up to 20 devices, either hardfiles or filesystems, by giving 384: either of these options multiple times. The volumes will be named UAE0:, 385: UAE1:, etc. UAE will boot from UAE0: if no diskfile is found for floppy 386: drive 0. 387: You can also use native filesystems to mount Amiga CD-ROMs, and you can 388: abuse the hardfile emulation to mount floppy disks: "uae -W 11:2:2:wb13.adf" 389: will mount the diskfile "wb13.adf". 1.1 root 390: 391: 392: Tools / Transferring files 393: ========================== 394: 1.1.1.2 root 395: As you should know by now, you need to transfer files between your Amiga and 396: the machine you run UAE on. There are several ways how to do this. 397: 398: - Using a null modem cable, and a terminal package running on each machine, 399: you can transfer the file(s) via Zmodem upload/download. 68000 equipped 400: Amigas can normally attain around 3000cps through the null modem cable, 401: using the standard Commodore serial.device. However, by using the device 402: replacement BaudBandit.device, anything up to 5500cps can be attained. 403: BaudBandit can be obtained from Aminet. A second alternative is to use 404: the BASIC program adfi.bas (included with UAE) to transfer a file from the 405: Amiga to the PC via the null modem cable. 406: 407: - If you're using CrossDOS on your Amiga, you can compress the disk or 408: kickstart image using LhA or similar PC compatible archiver and copy it to 409: a 720KB floppy disk. You can now take the disk over to the PC, copy the 410: compressed file to the UAE directory and uncompress it. 411: If you don't have CrossDOS on the Amiga, there is a similar freeware tool 412: called Msh, which can be found on Aminet or on Fish disk 382 or 327. 413: 414: In either case, you ought to read the documentation for the programs that 415: you use for the transfer. These programs can't be explained here. 1.1 root 416: 1.1.1.2 root 417: In the "amiga" subdirectory you'll find two small Amiga programs that will 418: help you to generate the necessary image files. These are called transrom 1.1 root 419: and transdisk. Copy them to your Amiga and make them executable (by typing 1.1.1.2 root 420: "protect transrom rwed" and "protect transdisk rwed" in the Amiga shell 1.1 root 421: window). 422: transrom will dump the contents of your Kickstart ROM, and transdisk will 423: dump an image of a floppy in one of the drives. Both programs write to the 1.1.1.2 root 424: standard output (read: the screen), so you'll want to redirect that. Do 1.1 root 425: 426: transrom >ram:kick.rom 427: 428: to create a file called "kick.rom" in the RAM disk, and 429: 430: transdisk >ram:df0.adf 431: 432: to create a file called "df0.adf" in the RAM disk. These files are pretty 1.1.1.2 root 433: big, 262144 or 524288 bytes for the ROM image and 901120 bytes for a disk 434: image. 1.1.1.3 root 435: 436: NEVER run either of these programs from the Workbench. Always open a Shell 437: or CLI window to do this. 438: 1.1 root 439: transdisk understands the following arguments: 440: 441: -d device unit: Use this device instead of DF0: 1.1.1.2 root 442: -s n: Begin transfer at track n (default: 0) 443: -e n: End transfer at track n (default: 79) 444: -w file: don't read from the floppy, instead write the contents 445: of "file" to the floppy 446: -h: Treat the disk as high-density disk. HD images aren't 447: supported by UAE yet, though. Note that the resulting 448: file will be twice as big. 1.1 root 449: 450: So, to transfer the disk in drive DF1:, you'd give the command: 451: 452: transdisk >ram:df1.adf -d trackdisk 1 453: 454: If you don't have much RAM and can't fit all of a disk image in the RAM disk, 455: you can split up the transfer into multiple parts with the "-s" and "-e" 456: parameters. To transfer the disk in four parts, you'd use the following 457: commands: 458: 459: transdisk >ram:df0_1.adf -s 0 -e 19 460: transdisk >ram:df0_2.adf -s 20 -e 39 461: transdisk >ram:df0_3.adf -s 40 -e 59 462: transdisk >ram:df0_4.adf -s 60 -e 79 463: 464: Of course, you should save each of the four files to another place before 465: transferring the next one with transdisk to make space in your RAM disk. 466: If you have all the files on your PC, you can do the following under Unix: 467: cat df0_1.adf df0_2.adf df0_3.adf df0_4.adf >df0.adf 468: or, under DOS: 1.1.1.2 root 469: COPY /B df0_1.adf+df0_2.adf+df0_3.adf+df0_4.adf df0.adf 1.1 root 470: I've been told there are the following tools for the Mac to join binaries: 471: "ChunkJoiner 2.1.2" found under Info-Mac's <disk> directory or 472: "JoinFiles 1.0.1" under Info-Mac's <text>. 473: 474: The current transdisk can only read the standard AmigaDOS format. This means 475: that most games that rely on some form of copy-protection cannot be 1.1.1.2 root 476: transferred (more about disk formats in the file "FAQ") 1.1 root 477: 1.1.1.2 root 478: **************************************************************************** 1.1 root 479: If you transfer commercial software, you must not distribute the resulting 480: image files, since that would be a violation of copyright law. The Kickstart 481: ROM has to be considered commercial software. You may only use the Kickstart 482: from your own Amiga, and you may not distribute Kickstart ROM files. 483: Please read the license that came with your software for details. 1.1.1.2 root 484: **************************************************************************** 485: 486: 487: Retrieving files from a disk image 488: ================================== 1.1 root 489: 490: If you have a disk image file, and you want to retrieve the files from it, you 491: can use the "readdisk" tool. It is automatically built by "make". If you have 492: a disk image of a disk called "Workbench1.3D" as df0.adf, and you do 493: readdisk df0.adf 494: the whole directory structure of the disk image will be stored in a newly 495: created subdirectory called "Workbench1.3D". You can optionally give a second 496: parameter to specify a directory where to create the output other than the 497: current directory. 498: readdisk only understands about the OFS right now. FFS disks will cheerfully 499: be regarded as being unreadable. Use the unixfs.device from within the 1.1.1.2 root 500: emulator if you want to transfer files from FFS disks. 1.1 root 501: 502: 1.1.1.3 root 503: Picasso 96 graphics card emulation 504: ================================== 505: 506: To use this feature, you must select 68020 emulation with a 32 bit address 507: space. You also need a Kickstart 3.x ROM. 508: 509: To specify how much graphic memory you want to emulate, use the "-U" option, 510: e.g. "-U 4" for 4 megabytes. Then, you need the Picasso 96 software which 511: is not distributed with UAE (There will be a link to the Picasso 96 home page 512: on the UAE Web page soon). Version 1.31 or higher is recommended. 513: Install the Picasso software, and make sure you enable the "uaegfx" driver. 514: After that is complete, reboot, and you should be able to select the new 515: modes from the ScreenModes program. 516: 517: 1.1 root 518: The UAE_CONTROL program 519: ======================= 520: 521: In the "amiga" subdirectory, you will find two programs, uae_control and 522: uaectrl that provide the same functionality as the X11 GUI. uaectrl is 523: shell-based and works with any Kickstart, while uae_control needs the 524: gadtools.library and a recent version of reqtools.library, so it only works 525: with Kick 2.0 and upwards. Copy these two programs to the directory that you 526: use for harddisk emulation. They should be self-explanatory. 527: 528: 529: Quick overview of the debugger commands 530: ======================================= 531: 1.1.1.2 root 532: Some (window-system based) ports of UAE have a built-in debugger. You can 533: press ^C at any time to enter this debugger. 1.1 root 534: Each debugger command consists of a single letter and occasionally some 535: parameters. 536: 537: g: Start execution at the current address. 538: c: Dump state of the CIA and custom chips. 539: r: Dump state of the CPU 540: m <address> <lines>: Memory dump starting at <address> 541: d <address> <lines>: Disassembly starting at <address> 542: t: Step one instruction 543: z: Step through one instruction - useful for JSR, DBRA etc. 544: f <address>: Step forward until PC == <address> 545: q: Quit the emulator. You don't want to use this command. 1.1.1.3 root 546: M: hunt for sound modules 547: S <filename> <address> <len>: 548: save a sound module 1.1.1.5 ! root 549: C <value>: Search for values like energy or lifes in games ! 550: W <address> <value>: Write into Amiga memory 1.1 root 551: 552: 553: Sound 554: ===== 555: 1.1.1.2 root 556: If your version of UAE supports sound, you can pass parameters like frequency 557: or number of bits to use on the commandline; if you don't specify any, sane 558: defaults will be used. If graphics output is enabled while sound is output, 559: the emulator will be much too slow on most systems. The sound will not be 560: continuous. Therefore, a hack to turn off screen updates is provided: Press 561: ScrollLock to disable graphics, press it again to enable them. 1.1 root 562: 563: The quality of the emulation depends on the setting of the "-S" commandline 564: option. With "-S 3", all of the sound hardware is emulated; and some programs 565: (e.g. AIBB) won't run with other settings. "-S 2" should sound just as good as 566: "-S 3" and will be much faster for some programs. "-S 1" tries to emulate most 567: of the sound hardware, but doesn't actually output sound. "-S 0" completely 568: turns off sound. 569: 570: 1.1.1.2 root 571: Pointers 572: ======== 1.1 root 573: 1.1.1.2 root 574: There are a few sites in the Internet that contain helpful information about 575: UAE. 576: 577: The new "official" UAE page is located at 578: 1.1.1.3 root 579: http://www.freiburg.linux.de/~uae 1.1.1.2 root 580: 581: thanks to Stefan Reinauer who is now maintaining it. 582: 583: There, you will find links to other UAE pages. One which is especially useful 584: is the "UAE Discussion Board" set up by Gustavo Goedert, the address is 585: 1.1.1.3 root 586: http://www.netrunner.com.br/dosuae/uaeboard/index.html 1.1 root 587: 1.1.1.2 root 588: Not quite as good as a newsgroup due to braindamaged reader software 589: (Ratscope), but still a blessing. 590: 1.1.1.3 root 591: There is supposedly a newsgroup named "alt.emulators.amiga", but I don't get 592: it here. 593: The newsgroup "comp.sys.amiga.emulations" appears to be a proper place to 594: discuss Amiga emulation, but, strictly speaking, it is _not_ the right place. 595: More appropriate places are "comp.emulators.misc", and, of course, Gustavo's 596: discussion board. 597: 598: Petter Schau has written another Amiga emulator named "Fellow". It's mostly 599: written in x86 assembly and only runs under DOS. It's quite compatible and 600: generally faster than UAE. The Fellow homepage is at 601: 602: http://www.geocities.com/SiliconValley/Peaks/5244/ 1.1 root 603: 604: 605: Thanks & Acknowledgements 606: ========================= 607: 608: Thanks to all who have written me so far with bugreports and success/failure 609: reports when trying to run the emulator on various hardware with different 610: Kickstart versions. A list of everyone who has contributed to the source code 611: can be found in the CREDITS file (this was getting too big to keep it here). 612: 613: Special thanks to: 614: - Jay Miner, Dale Luck, R.J. Mical and all the others who built the Amiga. 615: - Felix Bardos, whose HRM I "borrowed". 616: - Hetz Ben Hamo mailed Peter Kittel from Commodore asking for permission to 617: give Kick 1.3 away. Unfortunately, the response was negative :-( 1.1.1.5 ! root 618: - Stefan Reinauer, for hosting the UAE Web page after the RWTH decided it's ! 619: too dangerous to let students have their own Web pages. ! 620: - Bruno Coste, Ed Hanway, Alessandro Soldo and Marko Nippula provided useful ! 621: documentation about the Amiga 1.1 root 622: - Fabio Ciucci gets the "Best bug reports" award for his help with the 623: blitter line emulation and other problem areas. 1.1.1.3 root 624: - Michael C. Battilana and Cloanto Software, for all their support. 1.1.1.5 ! root 625: - Julian Eggebrecht of Factor 5, for providing several F5 games and a lot ! 626: of valuable input. ! 627: Factor 5 has made Katakis, one of their classic Amiga games, freely ! 628: available for download. There are still some good people left in the ! 629: world... ! 630: - Jens Sch�nfeld, inventor of the Catweasel controller, donated one ! 631: controller card. 1.1 root 632: 633: 1.1.1.2 root 634: Authors/Maintainers 635: =================== 1.1 root 636: 1.1.1.3 root 637: My address is (please read the section "Before you send email" below): 1.1 root 638: 639: [email protected] 640: 641: or, via snailmail 642: 643: Bernd Schmidt 644: Schlossweiherstrasse 14 645: 52072 Aachen 646: Germany 647: 648: Email is more likely to be answered, and will definitely be answered much 649: faster. Please avoid phonecalls if you can. 1.1.1.3 root 650: I won't distribute software, neither PD or commercial. Don't send me floppy 651: disks without at least asking first, you will not get them back. 1.1.1.2 root 652: 653: The following people have ported UAE to different platforms; you should 654: direct system-specific questions to them: 655: 656: DOS port: 1.1.1.3 root 657: Gustavo Goedert <[email protected]> 658: Available: http://www.netrunner.com.br/dosuae 659: Sourecode: available on the above Web page, most of it included in the 660: main source (with some delay) 1.1.1.2 root 661: 662: Mac port: 1.1.1.3 root 663: Originally: Ernesto Corvi <[email protected]> 664: Currently: Arnaud Blanchard <[email protected]> 665: Available: http://www.pratique.fr/~jblancha/ 666: Sourcecode: extra package available. Bits and pieces in the main source, 667: but nothing you could get to compile. 1.1.1.2 root 668: 669: BeBox port: 670: Christian Bauer <[email protected]> 671: Available: The main UAE web page (use the Unix sources) 1.1.1.3 root 672: Sourcecode: Included in the main source. Should compile OK. 673: Notes: Christian says he doesn't have much time to spend on UAE, so if 674: anyone is willing to help maintain this port, please speak up. 1.1.1.2 root 675: 676: NextStep port: 677: Ian Stephenson <[email protected]> 678: Available: The main UAE web page (use the Unix sources) 1.1.1.3 root 679: Sourcecode: Included in the main source. Should compile OK. 680: Notes: Ian says he doesn't have much time to spend on UAE, so if 681: anyone is willing to help maintain this port, please speak up. 1.1.1.2 root 682: 683: Amiga port: 684: Originally: Olaf 'Olsen' Barthel <[email protected]> 685: Currently: Samuel Devulder <[email protected]> 686: Available: Not quite sure yet. Paul Liss' Web page has binaries. 1.1.1.3 root 687: Sourcecode: Included in the main source. Should compile OK. 1.1.1.2 root 688: 1.1.1.3 root 689: pOS port: 690: Samuel Devulder <[email protected]> 691: Available: Not quite sure yet. 692: Sourcecode: Included in the main source. Should compile OK. 693: 1.1.1.2 root 694: XFree86/OS2 port: 695: Krister Bergman <[email protected]> 1.1.1.3 root 696: Available: http://www.kuai.se/~bellman/html/xfreeapps.html 697: Sourcecode: nothing special, apparently the Unix stuff compiles cleanly (?) 1.1.1.2 root 698: 1.1.1.3 root 699: Win32 port: 700: Mathias Ortmann <[email protected]> 701: Brian King <[email protected]> 702: Available: http://www.informatik.tu-muenchen.de/~ortmann 703: http://www.codepoet.com/uae 704: Sourcecode: we're working on it 705: 706: Acorn RISC PC port: 707: Peter Teichmann <[email protected]> 708: Available: http://www.wh1.tu-dresden.de/~sol/acorn.shtml 709: http://www.wh1.tu-dresden.de/~sol/acorne.shtml 710: Sourcecode: Some of it is included in the main source, but since Acorn's OS 711: apparently doesn't have decent file handling, you can't even 712: use the same source layout. Also needs lots of additional files. 713: 1.1.1.2 root 714: Since I generally don't have the possibility to test or improve these ports, 715: it is a good idea to contact their respective authors if you have questions. 716: 717: 1.1.1.3 root 718: Before you send email... 719: ======================== 1.1.1.2 root 720: 721: Before you contact me with a problem that you have, make sure you have read 722: _all_ of the above. Please read also the file "FAQ", which contains a lot of 1.1.1.3 root 723: helpful information, and the README file for your specific system. 1.1.1.2 root 724: 1.1 root 725: I can't answer _every_ question. If you have trouble understanding this 726: README, either because you don't speak English very well or because you have 1.1.1.2 root 727: no clue at all about computers, please try to find some friend of yours who 728: does understand this file and who can translate/explain it for you. I simply 729: can't explain (for example) how to use terminal programs or CrossDOS because 730: I don't use either, and it would be much too time-consuming anyway. This file 731: and the file FAQ contains about every piece of information I can give you. I 732: try to help people who have questions, but sometimes it takes too much time. 733: 734: Please don't ask for Kickstart ROM files or other copyrighted software. Don't 735: _send_ me stuff like this either. If you want to send me something else which 736: is big (>= 50K), ask me before or put it somewhere in Webspace. 1.1.1.3 root 737: If I get 3MB of screen shots or a core dump ("it doesn't work, it generates 738: this file"), I'm very likely to get extremely angry, I might complain to your 739: sysadmin, and you might lose your account. Think twice. 740: 741: I'm also going to be extremely annoyed if you send email in HTML format. 742: Fight this disease! 1.1 root 743: 744: Oh, and another thing: If I promise to do things (like implement new 745: features), and forget about them, pester me. That happens occasionally, it's 746: a known bug in my brain. I'll have it replaced.
This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.