README
1 Free and portable Atari 800 Emulator for everybody, Version 3.1.0
2 -----------------------------------------------------------------
3
4 Copyright (C) 1995 David Firth. E-Mail: david@signus.demon.co.uk
5 Copyright (C) 1998-2013 Atari800 Development Team.
6 http://atari800.sourceforge.net/
7
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2, or (at your option)
11 any later version.
12
13This is the emulator of Atari 8-bit computer systems and the 5200 console
14for Unix, Linux, Amiga, MS-DOS, Atari TT/Falcon, MS Windows, MS WinCE,
15Sega Dreamcast, Android and systems running the SDL library.
16Our main objective is to create a freely distributable portable emulator
17(i.e. with source code available).
18It can be configured to run in the following ways :-
19
20 1. "simple" version (many platforms) - uses only the standard C library
21 2. curses (many platforms)
22 3. X Window + Optional XVIEW or MOTIF User Interface
23 4. CBM Amiga
24 5. MS-DOS (DJGPP)
25 6. Atari Falcon/TT and compatible machines
26 7. MS Windows (DirectX)
27 8. SDL (running on _many_ platforms)
28 9. WinCE
29 10. Sega Dreamcast
30 11. JVM (Java applet)
31 12. Android
32 13. Raspberry Pi
33
34The "simple" version is only useful for running programs such as MAC65,
35Atari BASIC etc. I have had this version running on Linux,
36SunOS 4.1.3, Solaris 2.4, Silicon Graphics, VAX/VMS, CBM Amiga
37(Dice C and GNU C), DOS/DJGPP and the HP-UX 9000/380.
38
39When using curses, the emulator is similar to the "simple" version, but it
40also enables full screen editing capability. Some computer don't seem to
41support curses fully - SunOS 4.1.3, VAX/VMS, LINUX (but ncurses is OK).
42
43The X Window version supports graphics and has an optional XVIEW
44or MOTIF user interface. The Linux X Window version can be built with
45joystick and mouse support.
46
47The Amiga version supports graphics but currently lacks Paddle support.
48
49The MS-DOS version supports 320x200, 320x240 and even 320x480 interlaced
50graphics, sound (SoundBlaster compatible sound cards, 8bit),
51keyboard, one joystick connected to game port and up to three additional
52digital joysticks connected to parallel (printer) ports and mouse.
53
54The Atari Falcon030/040 version supports 320x240 and 336x240 Falcon/TT
558-bit planes graphics modes, NOVA graphics cards, DMA sound and both
56joysticks (old CX-40, Atari800 compatible - not the new paddle-like ones).
57
58The SDL version should compile on Unix, Win32, BeOS, etc... It's optimized for
598, 16 and 32 color depth. Of course it will work fastest in 8bit. If you use it
60in XFree86 - please set "Depth=8" in XF86Config to gain maximum speed.
61Includes support for joystick and mouse.
62
63All versions supporting bitmapped graphics have a User Interface implemented
64on the emulator's "screen". The User Interface is enter by pressing F1 at any
65time. ESC is used to return to the previous screen.
66
67---------------------------------------------------------------------------
68
69Features
70--------
71
72Note: Not all features are supported on all platforms.
73
74o Emulated machines: Atari 400, 800, 1200XL, 600XL, 800XL, 65XE, 130XE, 800XE,
75 XE Game System, 5200 SuperSystem.
76
77o Configurable 400/800 RAM size, between 8 and 48 KB.
78
79o Optional 4K RAM between 0xc000 and 0xcfff in 400/800 mode.
80
81o Axlon and Mosaic memory expansions for the 400/800.
82
83o 600XL memory expansions to 32 or 48 KB.
84
85o 130XE compatible memory expansions: 192K, 320K, 576K, 1088K.
86
87o MapRAM memory enhancement for the XL/XE.
88
89o Cycle-exact 6502 emulation, all unofficial instructions.
90
91o Cycle-exact NMI interrupts, scanline-based POKEY interrupts.
92
93o Cycle-exact ANTIC and GTIA emulation, all display modes.
94
95o Player/Missile Graphics, exact priority control and collision detection.
96
97o Exact POKEY shift registers (sound and random number generator).
98
99o 8 disk drives, emulated at computer-to-drive communication
100 and fast patched SIO levels.
101
102o ATR, XFD, DCM, ATR.GZ, XFD.GZ and .PRO disk images.
103
104o Direct loading of Atari executable files and Atari BASIC programs.
105
106o 59 cartridge types, raw and CART format.
107
108o Cassette recorder, raw and CAS images.
109
110o Printer support.
111
112o Files can be stored directly on your host computer via the H: device.
113
114o Current emulation state can be saved in a state file.
115
116o Sound support on Unix using "/dev/dsp".
117
118o Stereo (two POKEYs) emulation.
119
120o Joystick controller using numeric keypad.
121
122o Real joystick support.
123
124o Paddles, Atari touch tablet, Koala pad, light pen, light gun,
125 ST/Amiga mouse, Atari trak-ball, joystick and Atari 5200 analog
126 controller emulated using mouse.
127
128o R-Time 8 emulation using host computer clock.
129
130o Atari palette read from a file or calculated basing on user-defined
131 parameters.
132
133o Screen snapshots (normal and interlaced) to PCX and PNG files.
134
135o Sound output may be written to WAV files.
136
137o User interface on all versions supporting bitmapped graphics.
138
139o R: device (the Atari850 serial ports) mapped to net or real serial port.
140
141o Recording input events to a file and playing them back
142
143o MIO and Black Box emulation
144
145o 1400XL and 1450XLD emulation
146
README.RPI
README.android
1Build instructions for the Android port
2---------------------------------------
3
4If you are looking for instructions on how to use the Android port, what the
5preferences mean etc. you should check out instead:
6
7http://pocketatari.atari.org/android
8
9To compile the android port, you are going to need:
10
11* The Android SDK
12* The Android NDK
13* The Java JDK
14* A working autotools/make environment (i.e. Cygwin on Windows)
15
16Setup the environment correctly: create an environment variable called
17ANDROID_NDK_ROOT which points to the root of the NDK
18(f.ex.:export ANDROID_NDK_ROOT="/android-ndk/").
19Next, add the NDK root, gcc and android tools paths to PATH (f.ex. export PATH=
20"$ANDROID_NDK_ROOT:$ANDROID_NDK_ROOT/build/prebuilt/windows/arm-eabi-4.4.0/bin/:
21/android-sdk-windows/tools/:/android-sdk-windows/platform-tools/:$PATH").
22Don't forget to also add the proper Java environment vars too (f.ex.
23export PATH="/ant/bin:$PATH"; export JAVA_HOME='c:\Java\jdk1.6.0_21\';).
24
25Unpack the source tarball or get the CVS module. Go to the src directory and
26update the project thusly:
27android update project --path android/ --name colleen
28Configure the build. I use this setup:
29autoheader && autoconf && ./configure --target=android --disable-monitorbreak --enable-pagedattrib --enable-seriosound --disable-crashmenu --disable-monitorasm --disable-monitorhints --without-readline --enable-clipsound
30Then just type make and your apk package should appear in:
31android/bin/colleen-debug.apk
32
33Cheers,
34Kostas
35
README.dc
1Atari800 for SEGA Dreamcast
2===========================
3
4Usage
5-----
6
7The mapping of the connected DC controllers to the Atari joysticks is
8as follows:
9
10The leftmost controller is joystick #1. Then, while going to the
11right, the next controller is joystick #2. The next one is joystick
12#3. Joystick #4 is the rightmost controller if all 4 controller jacks
13are in use.
14
15The 1st (leftmost) controller is used to provide the console keys
16(start, select, etc).
17
18The mapping for the 1st controller is as follows (for computers, not
195200):
20
21 B - START
22 (maps to ESC key while being in the
23 emulator menu)
24 Y - SELECT
25 X - OPTION
26 A - joystick button
27
28 L - emulator menu
29 R - enter keyboard emulation screen
30
31 Start - warm boot (reset key)
32 Start + X - cold boot (power cycle)
33
34 joypad - joystick directions
35
36On the other controllers only the joypad and A are used.
37
38L and R are mapped to Z and C buttons on the Arcade Stick.
39While in the emulator menu, pressing Start causes the Dreamcast to
40reboot.
41
42The Dreamcast keyboard is also supported:
43 F1 - emulator menu
44 ESC - leave menu/go back
45
46 F2 - OPTION
47 F3 - SELECT
48 F4 - START
49
50 F5 - cold boot (power cycle)
51 F12 - Dreamcast reboot
52
53 End - HELP
54 Pause - break
55 S3 - Atari key
56
57In 5200 mode the A, B, X, and Y buttons of the controllers are
58redefined:
59 Y - Start key (only the 1st controller)
60 B - 4 (starts some games, " " " " )
61 X - joystick button #2
62 A - joystick button #1
63
64In 800 mode up to 4 paddles are supported (only 2 tested by
65me). A is the paddle trigger.
66
67Also in 800 mode, X, Y, and B can be redefined to generate keys from
68the keyboard. If this is enabled, Option, Select, and Start keys can
69be entered in the keyboard emulation screen.
70
71In order to use paddles, you have to switch on the "Emulate paddles"
72setting in the "AtariDC Settings" menu.
73
74
75Compiling
76---------
77
78You will need a SH4 cross compiler and the KallistiOS library
79(http://cadcdev.sourceforge.net).
80
81Please follow the instructions at
82http://gamedev.allusion.net/softprj/kos/dcsetup.php to build the cross
83compiler and KOS library.
84
85After you have installed the cross compiler and compiled KOS, adapt
86src/dc/Makefile.dc to your environment. You'll probably have to change
87the SHBASE and KOS variables in dc/Makefile.dc to point to your
88compiler and KOS locations, respectively.
89
90Then you can build the executable, "atari800.elf". In the atari800 src
91directory type
92
93 make -f dc/Makefile.dc
94
95to compile it. Use GNU make.
96
97
98CD setup
99--------
100
101After you have compiled the atari800.elf file, you may want to make a
102CD image which contains the a8 binary files and disk images you'd like
103to use.
104
105If you don't want to burn a CD, but have a serial, broadband, or lan
106adapter, then you can use the dc-load tool to transfer the ELF
107executable to the Dreamcast and run it. (For dc-load see
108http://adk.napalm-x.com/dc.) You need to create a CD ISO image, as
109described below, and use the -i switch to dc-load, to emulate this
110image over the the dc-load connection.
111
112If you create a real CD, there is one more step needed additionally to
113the steps described below: You need to put the atari800 executable
114file as boot file onto the CD. For information to create Dreamcast
115bootable CDs see http://mc.pp.se/dc/cdr.html. Convert the atari800.elf
116to a plain binary file with something like "sh-elf-objcopy -O binary
117atari800.elf atari800.bin" and then scramble it.
118
119The CD must contain the atari800.cfg file in the root directory. If
120you use the supplied demo atari800.cfg file, the Atari BIOS ROMS also
121have to be in the CD root directory. If you don't like this layout,
122change it and adapt the atari800.cfg file accordingly.
123
124Please note that paths in the atari800.cfg must start with /cd to
125reference the CD, so for a /roms directory on the CD the atari800.cfg
126entry must be ROM_DIR=/cd/roms.
127
128If you like to have a .com/.exe/.atr to be started automatically, copy
129it into the CD root directory and name it autorun.com / autorun.exe /
130autorun.atr, respectively.
131
132
133Saving/restoring state to VMU
134-----------------------------
135
136Be careful, since the VMU code is only beta, use only VMUs where there
137are no important data files.
138
139
140Bugs/ToDos
141----------
142
143* There are still sound glitches on some games. Fix them.
144* Save state to vmu and/or run ATRs rw from vmu. (*** save state
145 implemented ***)
146* More than 2 controllers are not well tested.
147* Improve keyboard support
148* Mouse support?
149
150
151Help/Problems/Bugs/Suggestions
152------------------------------
153
154Please contact me at chris@groessler.org or cpg@aladdin.de.
155
156The newest version is at
157
158 ftp://ftp.groessler.org/pub/chris/dreamcast/atari800dc
159
160
161In the mean time have fun with it,
162Christian Groessler
163chris@groessler.org, 30-Jan-2006
164
165
README.ps2
1This document assumes you are already familiar with
2the standard atari documentation.
3
4INSTALL Information is in DOC/INSTALL.ps2
5
6The following ps2 controller keys are mapped thus:
7
8During Emulation:
9Circle=Enter
10Cross=Fire
11Square=spacebar
12Triangle=UI (user interface)
13L1=Cold Start
14R1=Warm Start
15pad=Joystick
16start=Atari Start
17select=Atari Select
18
19While in UI:
20Circle=cancel/back
21Cross=select/enter
22Square=spacebar
23L1=Cold Start
24R1=Warm Start
25
26USB Keyboard is supported.
27
28TODO is located in src/atari_ps2.c itself.
29
30Thanks Piotr of atari800!
31Thanks ps2dev.org! Esp NeoVanglist, author of gsKi, and Oopo for the ps2dev toolchain.
32
33
readme.html.in
1<html>
2<head>
3<title>
4Atari800 emulator readme
5</title>
6</head>
7<body>
8
9<center><h1>
10Atari800 emulator version $A800VERSION
11</h1></center>
12
13<h2>Table Of Contents:</h2>
14
15<menu>
16<li><a href="#intro">INTRODUCTION</a>
17<li><a href="#install">INSTALLATION</a>
18<li><a href="#keys">KEYS</a>
19<li><a href="#run">RUNNING ATARI800</a>
20<li><a href="#bugs">REPORTING BUGS</a>
21<li><a href="#copy">COPYRIGHT</a>
22<li><a href="#contact">CONTACT</a>
23</menu>
24
25
26<a name="intro">
27<h3>INTRODUCTION</h3>
28This is the version $A800VERSION of Atari800 for MS Windows.
29Atari800 is a free (you don't pay for it, you can get source code and you are
30welcome to develop it) and portable (can run on many weird machines
31and different operating systems) emulator of Atari 8-bit computer systems and
32the 5200 console, developed by <A HREF="DOC/CREDITS">many people</A> under the <A HREF="COPYING">GPL</A>. More information you find
33in the <A HREF="DOC/README">README</A> file.
34
35<a name="install">
36<h3>INSTALLATION</h3>
37To install this Atari800 package you will need the following:
38<menu>
39<li> Windows 9x<br>
40<li> DirectX<br>
41<li> Atari 800 ROM files (see <A HREF="DOC/INSTALL.dos">INSTALL</A> file for more info)<br>
42<li> Seperate folder to put the emulator and ROM files in<br>
43</menu>
44
45Extract Atari800 zip file to destination folder and copy ROM files to the same
46folder.
47Run atari800 and you will be prompted for several config values, if you don't
48know the correct value just press Enter.
49
50<a name="keys">
51<h3>KEYS</h3>
52<menu>
53<li>F1 Menu (built in User Interface)
54<li>F2 Option
55<li>F3 Select
56<li>F4 Start
57<li>F5 Warm Reset
58<li>Shft+F5 Cold Reset
59<li>F8 Monitor
60<li>F9 Exit Emulator
61<li>F10 Screenshot
62<li>F11 Change autofire mode
63</menu>
64
65Joystick 0 is operated by the numeric keypad:<br>
66<menu>
67<li>7 - forward/left
68<li>8 - forward
69<li>9 - forward/right
70<li>4 - left
71<li>6 - right
72<li>1 - back/left
73<li>2 - back
74<li>3 - back/right
75<li>0 - fire key
76</menu>
77
78<a name="run">
79<h3>RUNNING ATARI800</h3>
80You can use some command line parameters to atari800.
81To add command line parameter create a shortcut to atari800 and append them
82to Properties/Shortcut/Target window.<br>
83If you need '-mouse pad' option you should have something like:<br>
84"C:\Program Files\Atari800\Atari800.exe -mouse pad"<br>
85
86Available command line options are: (see <A HREF="DOC/USAGE">USAGE</A> for more)
87<menu>
88
89$HELPMENU
90
91</menu>
92
93<a name="bugs">
94<h3>REPORTING BUGS</h3>
95If you have a problem running this emulator please read <A HREF="DOC/FAQ">FAQ</A> first.<br>
96Look at <A HREF="DOC/BUGS">BUGS</A> first to not report same bug hundred times, please.<br>
97If the problem persists you can contact Atari800 developers at
98<a href="mailto:atari800-users@lists.sourceforge.net">
99atari800-users mailing list</a>
100or you can use <a href="http://sourceforge.net/projects/atari800/">
101sourceforge.net interface</a>.
102
103<a name="copy">
104<h3>COPYRIGHT</h3>
105<blockquote>
106 Copyright © 1995
107 <a href="mailto:david@signus.demon.co.uk">David Firth.</a><br>
108 Copyright © 2002
109 <a href="mailto:atari800-users@lists.sourceforge.net">
110 Atari800 development team</a>
111</blockquote>
112<blockquote>
113 This program is free software; you can redistribute it and/or modify
114 it under the terms of the GNU General Public License as published by
115 the Free Software Foundation; either version 2 of the License, or
116 (at your option) any later version.
117</blockquote>
118<blockquote>
119 This program is distributed in the hope that it will be useful,
120 but WITHOUT ANY WARRANTY; without even the implied warranty of
121 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
122 GNU General Public License for more details.
123</blockquote>
124<blockquote>
125 You should have received a copy of the GNU General Public License
126 along with this program; if not, write to the Free Software
127 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
128</blockquote>
129
130See <A HREF="COPYING">COPYING</A> file for details.<br><br>
131All trademarks are the property of their respective companies.
132
133<a name="contact">
134<h3>CONTACT</h3>
135Atari800 Windows port maintainer:
136<a href="mailto:knik@poczta.onet.pl">Krzysztof Nikiel</a><br>
137You can find more info at <a href="http://atari800.atari.org/">
138Atari800 home page</a>.<br>
139<br><br<br>
140<center><h6>Page by Krzysztof Nikiel</h6></center>
141
142</body>
143</html>
144