README

   1 PUAE
   2 ---------------------------------------------------
   3 PUAE tries to continue where E-UAE left off..
   4 PUAE versioning is based on the merged WinUAE version..
   5
   6 Work until 2.8.1 was done by:
   7         Mustafa 'GnoStiC' TUFAN (mustafa.tufan@gmail.com)
   8
   9 GnoStiC disappeared from github a couple years ago,
  10 so I (rofl0r) am maintaining it now.
  11
  12 GIT
  13 ---------------------------------------------------
  14 http://github.com/rofl0r/PUAE
  15
  16
  17 PUAE Binaries
  18 ---------------------------------------------------
  19 I don't supply binaries for any OS.
  20
  21 You should also check FS-UAE: http://fengestad.no/wp/fs-uae
  22                   and WinUAE: http://www.winuae.net
  23
  24
  25 PUAE Ports (those i'm aware of)
  26 ---------------------------------------------------
  27 Pandora    : http://apps.openpandora.org/cgi-bin/viewapp.pl?/Emulator/puae.inf
  28 XBOX360    : http://lantus360.com
  29 Android    : http://droidpuae.blogspot.com
  30            : https://github.com/pelya/commandergenius/tree/sdl_android/project/jni/application/puae
  31 PS3        : http://metaneutrons.blogspot.com/2011/07/porting-puae-to-playstation-3.html
  32 Raspberry  : http://www.valvers.com/raspberry-pi#toc-amiga-emulation-puae
  33 PNaCl      : http://pnacl-amiga-emulator.appspot.com
  34 AROS       : http://aminet.net/package/misc/emu/p-uae.i386-aros
  35 Retroarch  : https://github.com/libretro/libretro-uae
  36
  37 About PUAE
  38 ---------------------------------------------------
  39
  40 PUAE (and EUAE) traditionally offered tons of configuration options,
  41 which resulted in a maintenance nightmare, with most of the untested
  42 combinations broken.
  43 recently the build system was refactored to allow only a minimal set
  44 of configurable options, in the hope that this will ease the situation.
  45
  46 At this time, only a GTK+2 and SDL frontend are supported, as well as
  47 a subset of host operating systems and machines.
  48
  49 Development is mainly focused on linux and SDL 1.2.
  50 Since SDL2 was supported at some point it should be possible to make it
  51 work again with some minor tweaks. File a PR if you're interested.
  52
  53 See also the docs directory (might be partially outdated).
  54
  55 Difference to FS-UAE
  56 ---------------------------------------------------
  57
  58 UAE was originally written in C, and WinUAE basically continued
  59 using only the C subset of C++ but renamed files to .cc so MSVC's
  60 C++ compiler could be used instead of its crippled C compiler
  61 which produces abysmally bad code.
  62 When merging changes from WinUAE, PUAE renames the files to .c before
  63 diffing and compiles everything as C.
  64
  65 FS-UAE otoh embraces C++ and its new features which leads to a lot
  66 longer compile times. Additonally it makes heavy use of OpenGL and 3D
  67 effects for its UI, so if your GPU isn't that great or you don't have
  68 OpenGL at all, it's unusable.
  69 Additionally FS-UAE introduced a dependency on GLib.
  70
  71 PUAE works just fine without OpenGL.
  72
  73 Compiling PUAE
  74 ---------------------------------------------------
  75
  76 check out the sources from git, then run `autoreconf -i` to
  77 generate the configure script.
  78
  79 run `./configure --help` to read which `--with-...` options
  80 are available.
  81
  82 then run `./configure` with the options you require, followed
  83 by `make -jN` where N is the number of CPU cores.
  84
  85 See also docs/compiling.txt (which may be outdated).
  86
  87 Tested environment:
  88 Linux, x86_64, GCC 6.5.0.
  89
  90 Using PUAE
  91 ----------
  92
  93 after build, cd to src, and put your kickstart roms into `roms` and
  94 your adf files into `disks`. then run `./uae`.
  95 in the SDL gui you may now select a ROM (confirm selection with `b`
  96 button either on keyboard or joypad), and an adf file.
  97 using button b will put the file into DF0, while button a will put
  98 it into DF1.
  99 you can get back into the menu using `F12` key - while inside the
 100 menu you can save/load savestates and toggle fullscreen mode with
 101 (right)ALT-enter.
 102 Note that PUAE sometimes gets stuck when selecting `exit` - therefore
 103 it's a good idea to quit fullscreen mode before doing that.
 104
 105 About the JIT
 106 ---------------------------------------------------
 107
 108 The JIT featured by {P/FS/Win}UAE is mostly useless - unless you want
 109 to run an Amiga Workbench. Even though very fast, due to timing issues
 110 it's not very compatible to games, and it requires to use a CPU >= 68030
 111 and is only implemented for x86[_64] archs.
 112 Also compiling support for it increases build time by about 2x - so you
 113 are probably better off not enabling it.
 114
 115 Bug Reports/Contact
 116 ---------------------------------------------------
 117 Open an issue here on github.
 118
 119