mirror of
https://github.com/libretro/stella2023.git
synced 2024-11-27 02:40:37 +00:00
2ad8f1efac
generic joystick buttons. Added complete keyboard/joystick support for all 4 paddles. Associated paddle resistance decrease/increase/fire to joystick events in the 'spirit' of z26 (ie, joy0 left/right/fire is paddle 0, joy1 left/right/fire is paddle 2, etc). These events can still be remapped independently of joystick events, of course. First real attempt at adding 4A50 bankswitch support, which is currently being modelled on the E0 scheme (they're somewhat similar). The code still doesn't work, of course. Fixed bug in FASC scheme whereby reading from a write port didn't generate an associated write as a side-effect. Thanks to Kroko of AtariAge for the advice and partial code. git-svn-id: svn://svn.code.sf.net/p/stella/code/trunk@1388 8b62c5a3-ac7e-4cc8-8f21-d9a121418aba
2815 lines
86 KiB
HTML
2815 lines
86 KiB
HTML
<html>
|
|
<head>
|
|
<title>Stella - A multi-platform Atari 2600 VCS emulator</title>
|
|
<meta name="AppleTitle" content="docs">
|
|
</head>
|
|
|
|
<body bgcolor="#FFFFFF">
|
|
|
|
<center><b><font size="7">Stella</font></b></center>
|
|
<br><br>
|
|
<center><h2><b>A multi-platform Atari 2600 VCS emulator</b></h2></center>
|
|
|
|
<center><h4><b>Release 2.4.1</b></h4></center>
|
|
<br><br>
|
|
|
|
<center><h2><b>User's Guide</b></h2></center>
|
|
<br><br>
|
|
|
|
<ol>
|
|
<li><a href="#Introduction">Introduction</a></li>
|
|
<li><a href="#Requirements">What You Will Need</a></li>
|
|
<li><a href="#Installation">Installation</a></li>
|
|
<li><a href="#Games">Games</a></li>
|
|
<li><a href="#Starting">Starting A Game</a></li>
|
|
<li><a href="#Options">Changing Options</a></li>
|
|
<li><a href="#Keyboard">Keyboard Layout</a></li>
|
|
<li><a href="#Remapping">Event Remapping</a></li>
|
|
<li><a href="#Adaptor">Stelladaptor Support</a></li>
|
|
<li><a href="#Debugger">Integrated Debugger</a></li>
|
|
<li><a href="#Settings">Settings File</a></li>
|
|
<li><a href="#Cheats">Cheatcode Manager</a></li>
|
|
<li><a href="#Properties">Game Properties</a></li>
|
|
<li><a href="#Palette">Palette Support</a></li>
|
|
<li><a href="#Acknowledgments">Acknowledgments</a></li>
|
|
<li><a href="#License">License and Disclaimer</a></li>
|
|
</ol>
|
|
|
|
<br><br><br>
|
|
|
|
<center><b>February 1999 - August 2007</b></center>
|
|
<center><b>The Stella Team</b></center>
|
|
<center><b><a href="http://stella.sourceforge.net">Stella Homepage</a></b></center>
|
|
|
|
<br><br><br>
|
|
|
|
<br><br>
|
|
<h1><b>A Brief History of the Atari 2600</b></h1>
|
|
<hr>
|
|
|
|
<p><a><img src="graphics/console.png" ALIGN=RIGHT></a>
|
|
In the early 1970's, video arcade games gained commercial success for the
|
|
first time. The American public was introduced to Pong, Tank, and other
|
|
interactive video games which populated amusement parks, bars, and arcades.
|
|
The games were successful enough to create interest for home versions, so in
|
|
1975 Atari released Home Pong and it was a smash hit. Other companies such as
|
|
Magnavox and Coleco followed suit and released their own dedicated console
|
|
games. Then in 1976, Fairchild Camera and Instrument introduced the Channel F
|
|
system, the first cartridge based home video game system. The industry
|
|
recognized that cartridge systems were the future of video gaming, and began
|
|
development in that direction. In January 1977, RCA released the Studio II,
|
|
another cartridge based system, although it only projected in black and white
|
|
and seemed to be focused on educational titles. Then, in October 1977, Atari
|
|
released the Atari VCS (Video Computer System) with an initial offering of nine
|
|
games. This system, later renamed the Atari 2600, took the industry by storm
|
|
and dominated the marketplace for years to come.
|
|
</p>
|
|
|
|
<p><a><img src="graphics/chucky_cheese.png" ALIGN=LEFT></a>
|
|
Because of oversupply, the Christmas season of 1977 was very rough on the
|
|
video game industry, and the Atari 2600 was the only system that managed to
|
|
emerge unscathed. Atari enjoyed strong sales in 1978 and a fantastic holiday
|
|
season, as Atari released more games such as Outlaw, Spacewar, and Breakout.
|
|
Internally however, Atari was at odds. Nolan Bushnell, the inventor of pong and
|
|
founder of Atari, wound up leaving the company and purchased Pizza Time Theater,
|
|
which later became the successful Chuck E. Cheese! In 1979 Atari continued
|
|
their trend and released 12 more games which met with continued success.
|
|
However, Atari was now facing some stiffer competition from the Mattel
|
|
Intellivision and the Magnavox Odyssey2.
|
|
</p>
|
|
|
|
<p><a><img src="graphics/space_invaders.png" ALIGN=RIGHT></a>
|
|
Atari needed a mega-hit in 1980 in order to squash the competition, and they
|
|
found it in the home version of a game from Japan called Space Invaders. It was
|
|
so popular that people were buying the Atari 2600 just so they could play Space
|
|
Invaders at home. Following that, Atari released Adventure, which was the first
|
|
video game to contain an Easter Egg - placing an object in a certain area
|
|
revealed the programmer's name, Warren Robinett. 1980 was important for another
|
|
reason - the creation of the first ever third party software producer, Activision.
|
|
The company was formed by four Atari employees who were unsatisfied with the
|
|
working conditions at the company. They released four games initially: Dragster,
|
|
Fishing Derby, Checkers and Boxing. The games were very well received by the
|
|
public, and revealed that the Atari 2600 was capable of better games than
|
|
Atari themselves had been producing. Atari tried to prevent Activision from
|
|
selling games, but they failed and Activision grossed $70 million that year.
|
|
</p>
|
|
|
|
<p>
|
|
By 1981, the video game industry was basically a horse race between the 2600
|
|
and the Intellivision. While the Intellivision was technologically superior in
|
|
some respects, the 2600 continued to lead in sales. Atari released the home
|
|
version of Asteroids, which was a huge success. Inspired by the success of
|
|
Activision, another software development group called Imagic was formed. They
|
|
would not release any games until 1982 however. Another company, Games by Apollo,
|
|
was formed in Texas and released several games that year.
|
|
</p>
|
|
|
|
<p>
|
|
Coleco entered the market in 1982 with the release of the graphically
|
|
superior Colecovision. To combat this new system, Atari produced the 5200,
|
|
a technologically comparable system. The 2600 dropped $100 in price in order
|
|
to remain competitive. Then a company called Arcadia released a peripheral
|
|
called the Supercharger which played games in an audio cassette medium. This
|
|
allowed for multiple loads and expanded the 2600's capabilities.
|
|
<p><a><img src="graphics/pacman.png" ALIGN=LEFT></a>
|
|
Atari released Pac-Man and E.T. that year, two incredibly hyped games which
|
|
were critical flops.
|
|
Although Pac-Man sold many copies, it was considered to be a poor
|
|
translation of the arcade hit. However, there were many fantastic games
|
|
produced for the 2600 during this period, and it was still selling strong.
|
|
</p>
|
|
|
|
<p>
|
|
Ever since the inception of Activision, Atari had been fighting to keep third
|
|
parties from producing cartridges which they felt were stealing profits from
|
|
them. Finally the issue was settled when Atari agreed to allow third party
|
|
manufacturing in exchange for a royalty. Suddenly software companies began
|
|
popping up all over, and 1982 saw releases from companies like Venturevision,
|
|
Spectravision, Telesys, CBS, 20th Century Fox, US Games, M Network, Tigervision,
|
|
Data Age, Imagic and Coleco. There was even a company that released a line of
|
|
X-Rated games for the 2600 called Mystique. The year was financially successful
|
|
for Atari, however there seemed to be a glut of software. Although there were
|
|
many quality titles still produced, there was an increasing number of rushed
|
|
games as manufacturers attempted to cash in on the craze.
|
|
</p>
|
|
|
|
<p>
|
|
More companies jumped on the band wagon in 1983. Zimag, Ultravision, Amiga,
|
|
and others were also producing games and peripherals. It seemed as if there was
|
|
just too much product to meet the demand, and as it turned out there was. By
|
|
the end of the year, companies began folding. US Games, Data Age, Games by
|
|
Apollo, Telesys and others all closed their doors from poor sales. A video
|
|
game crash was occurring, and all companies were taking it on the chin.
|
|
</p>
|
|
|
|
<p>
|
|
1984 was a much more subdued year for the Atari 2600, and the price of the
|
|
system had now dropped to $40-$50. Many were saying that the video game
|
|
industry was dead. However, Atari surprised everyone by announcing the release
|
|
of the 7800, and also promising more 2600 games with improved graphics and
|
|
sound. Unfortunately, neither of these things happened in 1984 because Atari
|
|
sold their home video game division to Jack Tramiel who believed that home
|
|
computers would replace video game systems. No further mention of the 2600 or
|
|
7800 was made that year, and it appeared that they might be dead.
|
|
</p>
|
|
|
|
<p>
|
|
1985 was another very quiet year for Atari and video games in general, and only
|
|
a few games were released for the 2600. Activision produced Cosmic Commuter and
|
|
Ghostbusters, but with little fanfare or marketing, these games did not sell
|
|
well. However, because of the huge game library and cheap price, Atari still
|
|
sold over a million 2600 consoles in 1985.
|
|
</p>
|
|
|
|
<p>
|
|
There were very few plans for home video game systems by any company in 1986,
|
|
since the market appeared to be dead. Then, to most people's surprise, Nintendo
|
|
brought the NES to America and it was a smash hit, proving that video games
|
|
still had a place in the US. Atari decided that maybe it would be a good idea
|
|
to release the 7800 units it had in storage, and produce some more 2600 games.
|
|
The 7800 was released with only 3 games initially available, although it was
|
|
compatible with the 2600 library. They also redesigned the 2600 as the 2600 Jr.,
|
|
a machine with the same abilities, but a new look and marketing campaign. It
|
|
was sold for less than $50.
|
|
</p>
|
|
|
|
<p><a><img src="graphics/jr_pacman.png" ALIGN=RIGHT></a>
|
|
Video games were once again selling phenomenally in 1987. Atari released
|
|
several new titles, including Jr. Pac-Man, and also licensed a number of games
|
|
from other companies such as Donkey Kong and Q*Bert. These new titles sold for
|
|
$10-$15. Interestingly, a number of titles began appearing again from third
|
|
part companies such as Epyx, Froggo, and Exus. It seemed that the 2600 was not
|
|
dead yet!
|
|
<p><a><img src="graphics/secret_quest.png" ALIGN=LEFT></a>
|
|
In 1988, Atari rehired Nolan Bushnell and announced a number of new
|
|
titles, including Secret Quest, a game written by Mr. Bushnell himself. Atari
|
|
continued to manufacture these games even until 1989. However, it was apparent
|
|
that the 2600, after its introduction over a decade ago, was finally at the end
|
|
of its run. Although it was still produced and marketed outside of the US, the
|
|
Atari 2600 finished its run in America. No other console has had such a long
|
|
history or sold as many systems in the U.S.
|
|
</p>
|
|
|
|
<p>
|
|
Today, the 2600 still has a large number of fans who remember the countless
|
|
games played over the years, and the years to come. There are even games being
|
|
produced by hobbyists, some of them quite professionally, being released on
|
|
newly burnt cartridges with labels and manuals. And the recent trend in
|
|
retrogaming has brought many more video game fans to rediscover the 2600, and
|
|
it continues to live on 22 years after its release!
|
|
</p>
|
|
|
|
<p><i>Alexander Bilstein<br>February 1999</i></p>
|
|
|
|
|
|
<!-- ///////////////////////////////////////////////////////////////////////// -->
|
|
<br><br>
|
|
<p><h1>
|
|
<a name="Introduction">1. Introduction</a></h1>
|
|
<hr>
|
|
|
|
<p>
|
|
Stella is a freely distributed multi-platform Atari 2600 VCS emulator; originally
|
|
developed for Linux by Bradford W. Mott. Stella allows you to enjoy all of
|
|
your favorite 2600 games once again by emulating the 2600's hardware with
|
|
software. Stella is written in C++, which allows it to be ported to other
|
|
operating systems and architectures. Since its original release Stella has
|
|
been ported to AcornOS, AmigaOS, DOS, FreeBSD, Linux, MacOS, OpenStep, OS/2,
|
|
Sega Dreamcast, Unix, and Windows.
|
|
</p>
|
|
|
|
<h2><b>New in Release 2.4.1</b></h2>
|
|
|
|
<ul>
|
|
<li>Re-added OpenGL aspect ratio setting ('gl_aspect' commandline argument).</li>
|
|
|
|
<li>Re-added non-browser mode to the ROM launcher.</li>
|
|
|
|
<li>For the Linux/UNIX port; fixed OpenGL vsync issue with Nvidia video cards.</li>
|
|
</ul>
|
|
|
|
<p>
|
|
<h2><b>Features</b></h2>
|
|
|
|
<ul>
|
|
<li>High speed emulation using optimized C++ code</li>
|
|
<li>Supports high quality sound emulation using code derived from Ron Fries'
|
|
TIA Sound Emulation library, including stereo sound support</li>
|
|
<li>Emulates the Atari 2600 Joystick Controllers using your computer's keyboard
|
|
or joysticks</li>
|
|
<li>Emulates the Atari 2600 Keyboard Controllers using your computer's keyboard</li>
|
|
<li>Emulates one Atari 2600 Paddle Controller using your computer's mouse</li>
|
|
<li>Support for real Atari 2600 controllers using the
|
|
<a href="http://www.pixelspast.com/products">Stelladaptor</a></li>
|
|
<li>Emulates the Atari 2600 Driving Controllers using your computer's keyboard
|
|
or joysticks</li>
|
|
<li>Emulates the CBS Booster-Grip Controller using your computer's keyboard or
|
|
joysticks</li>
|
|
<li>Supports cartridges using Atari's standard 2K and 4K format</li>
|
|
<li>Supports cartridges using Atari's 8K, 16K, and 32K bank-switching schemes</li>
|
|
<li>Supports cartridges using Activision's 8K bank-switching scheme
|
|
(Robot Tank and Decathlon)</li>
|
|
<li>Supports cartridges using CBS Electronics' 12K bank-switching scheme</li>
|
|
<li>Supports cartridges using Chris Wilkson's Megacart 128K bank-switching
|
|
scheme</li>
|
|
<li>Supports cartridges using Commavid bank-switching scheme</li>
|
|
<li>Supports cartridges using M-Network's 16K bank-switching scheme</li>
|
|
<li>Supports cartridges using Parker Brothers' 8K bank-switching scheme</li>
|
|
<li>Supports cartridges using Tigervision's bank-switching scheme with up to
|
|
512K ROM</li>
|
|
<li>Supports cartridges using UA Limited bank-switching scheme</li>
|
|
<li>Supports Supercharger single-load and multi-load games</li>
|
|
<li>Supports property file for setting the properties associated with games</li>
|
|
<!-- <li>Supports user specified frame rate</li> -->
|
|
<li>Supports the NTSC, PAL, PAL60 and SECAM television standards</li>
|
|
<li>Supports several "undocumented features" of the TIA graphics chip used by
|
|
some games</li>
|
|
<li>TIA emulation supports full collision checking</li>
|
|
</ul>
|
|
|
|
|
|
<!-- ///////////////////////////////////////////////////////////////////////// -->
|
|
<br><br>
|
|
<p><h1>
|
|
<a name="Requirements">2. What You Will Need</a></h1>
|
|
<hr>
|
|
|
|
<p>The following sections outline the basic system requirements for running
|
|
Stella under various operating systems.
|
|
</p>
|
|
|
|
<p>Note that for this version of Stella, you are <b>not required</b> to have a
|
|
stella.pro file. ROM properties are built in, and defaults will be used
|
|
whenever necessary.</p>
|
|
|
|
<p>
|
|
<h2><b>General (required for all versions of Stella)</b></h2>
|
|
<ul>
|
|
<li>Enough RAM for the OS + 16MB RAM for the emulation; 32MB highly recommended</li>
|
|
<li>15 bit color minimum; 16 bit color graphics card highly recommended</li>
|
|
<li>SDL version 1.2.10 or greater, latest version highly recommended</li>
|
|
<li>Latest version of the zlib library</li>
|
|
<li>Joysticks or gamepads are highly recommended</li>
|
|
<li>Mouse or Stelladaptor with real paddles required for paddle emulation</li>
|
|
<li>Some ROM images (See <a href="http://www.atariage.com">AtariAge</a> for more information)</li>
|
|
</ul>
|
|
|
|
<p>
|
|
<h2><b>Linux/UNIX</b></h2>
|
|
<p>The Linux version of Stella is designed to work on a Linux Workstation with
|
|
the following:</p>
|
|
<ul>
|
|
<li>Linux Kernel 2.4.x, Linux Kernel 2.6.x is highly recommended</li>
|
|
<li>GNU C++ compiler version 2.95 and the make utility are required for compiling
|
|
the Stella source code; GNU C++ compiler version 3.2.x/4.x or later is highly
|
|
recommended</li>
|
|
<li>x86 or PowerPC class machine, in either 32 or 64-bit mode</li>
|
|
</ul>
|
|
|
|
<p>
|
|
<h2><b>Macintosh</b></h2>
|
|
|
|
<p>The Mac version of Stella is designed to work on a Power Macintosh with
|
|
the following:</p>
|
|
<ul>
|
|
<li>Mac OSX 10.2 or Above</li>
|
|
<li>500 MHz G4 PPC/Intel processor or above (Stella <b>may</b> work with a G3
|
|
processor, but this is still a work-in-progress)</li>
|
|
<li>OpenGL capable video card. Software rendering mode is still available,
|
|
but as of OSX 10.4 is substandard compared to OpenGL.</li>
|
|
</ul>
|
|
|
|
<p>
|
|
<h2><b>Windows</b></h2>
|
|
|
|
<p>The Windows version of Stella is designed to work on Windows 98/ME/2000/XP/Vista
|
|
with the following:</p>
|
|
|
|
<ul>
|
|
<li>Visual C++ 7 or MinGW compiler is required to compile the Stella
|
|
source code</li>
|
|
<li>Pentium class machine required; OpenGL accelerated video card highly
|
|
recommended</li>
|
|
</ul>
|
|
|
|
|
|
<!-- ///////////////////////////////////////////////////////////////////////// -->
|
|
<br><br>
|
|
<p><h1>
|
|
<a name="Installation">3. Installation</a></h1>
|
|
<hr>
|
|
<p>Stella is distributed in both source and binary form. Once you have a Stella
|
|
distribution you should follow the instructions for your operating system given
|
|
below.</p>
|
|
|
|
<p>If you have a supported joystick and driver installed and SDL can access the device,
|
|
you can play games using joysticks.</p>
|
|
|
|
<p>Currently, sound is supported using SDL. As long as SDL can detect your sound card,
|
|
Stella will be able to produce sound.</p>
|
|
|
|
<p>
|
|
<h2><b>Linux/UNIX</b></h2>
|
|
<ul>
|
|
<li><b>Compressed tarball</b> (stella-<i>release</i>-src.tar.gz)</li>
|
|
<ol>
|
|
<li>Extract files from the distribution:
|
|
<pre> tar zxvf stella-release-src.tar.gz</pre></li>
|
|
<li>Change directories to the stella-<i>release</i> directory</li>
|
|
|
|
<li>Configure the build with the following command:
|
|
<pre> ./configure (--help for list of options)</pre></li>
|
|
<li>Build the executable with the following command:
|
|
<pre> make</pre></li>
|
|
<li>Install the executable with the following command:
|
|
<pre> make install</pre></li>
|
|
</ol>
|
|
<li><b>Binary DEB</b> (stella-<i>release</i>-1_arch.deb)</li>
|
|
<ol>
|
|
<li>Install the binary DEB with the following command:
|
|
<pre> dpkg -i stella-<i>release</i>-1_arch.deb</pre></li>
|
|
</ol>
|
|
<li><b>Binary RPM</b> (stella-<i>release</i>-1.ix86.rpm)</li>
|
|
<ol>
|
|
<li>Install the binary RPM with the following command:
|
|
<pre> rpm -Uvh stella-<i>release</i>-1.ix86.rpm</pre></li>
|
|
</ol>
|
|
</ul>
|
|
|
|
<p>
|
|
<h2><b>Macintosh</b></h2>
|
|
|
|
<p>To install the Mac binary, simply download the DMG disk
|
|
image. Mount the disk image, then copy the StellaOSX<i>release</i> folder to
|
|
your hard drive.<br>
|
|
</p>
|
|
|
|
<p>
|
|
<h2><b>Windows</b></h2>
|
|
<ul>
|
|
<li><b>Compressed tarball</b> (stella-<i>release</i>-src.tar.gz)</li>
|
|
<ol>
|
|
<li>Extract files from the distribution using <b>Winzip</b>,
|
|
<b>Total Commander</b>, or some other archiving program that supports
|
|
gzipped tar files</li>
|
|
<li>If compiling the Stella executable using MinGW, use the same commands
|
|
as specified under <i>Linux/UNIX - Compressed tarball</i></li>
|
|
<li>If compiling using Visual C++ 7:</li>
|
|
<ul>
|
|
<li>Open the <b>stella-<i>release</i>/src/win32/Stella.sln</b>
|
|
file using Visual C++ 7</li>
|
|
<li>Build the 'Stella' solution</li>
|
|
<li>Copy the <b>Stella.exe</b> file to some directory</li>
|
|
</ul>
|
|
</ol>
|
|
<li><b>Binary ZIP file</b> (stella-<i>release</i>-win32.zip)</li>
|
|
<ol>
|
|
<li>Unzip the binary ZIP file using <b>Winzip</b> or <b>Total Commander</b>
|
|
and copy that directory somewhere</li>
|
|
</ol>
|
|
<li><b>Binary EXE installer</b> (stella-<i>release</i>-win32.exe)</li>
|
|
<ol>
|
|
<li>Double-click on the installer and follow the onscreen instructions</li>
|
|
</ol>
|
|
</ul>
|
|
|
|
|
|
<!-- ///////////////////////////////////////////////////////////////////////// -->
|
|
<br><br>
|
|
<p><h1>
|
|
<a name="Games">4. Games</a></h1>
|
|
<hr>
|
|
|
|
<p>Stella allows you to play games using ROM images of cartridges and cassettes.</p>
|
|
|
|
<p>
|
|
<h2><b>Cartridges</b></h2>
|
|
|
|
<p>Most games for the Atari 2600 came on cartridges. A cartridge usually
|
|
consists of a single Read Only Memory (ROM) chip which contains the data and
|
|
code for the game. Plugging a cartridge into the Atari 2600 allows the 2600's
|
|
microprocessor to access the program stored on the cartridge.</p>
|
|
|
|
<p>In a similar way you must "plug" a copy of a cartridge into Stella when you
|
|
want to play it. Having a ROM image, BIN file, of the cartridge allows you to
|
|
do this. A ROM image is a file, which contains the actual data and code read
|
|
from the cartridge. There are several ways to obtain a ROM image of a
|
|
cartridge:</p>
|
|
|
|
<ol>
|
|
<li>If you're handy with a soldering iron then you can design and build a
|
|
device that plugs into the printer port of a PC and read the data from the
|
|
cartridge</li>
|
|
|
|
<li>You can purchase the Atari 2600 Action Packs by Activision and use
|
|
their ROM images</li>
|
|
|
|
<li>You can search around the internet and find ROM images to download</li>
|
|
</ol>
|
|
|
|
<p><b>WARNING:</b> It is illegal to use ROM images of games that you do not
|
|
actually own since these games are still copyrighted.</p>
|
|
|
|
<p>
|
|
<h2><b>Supercharger Cassettes</b></h2>
|
|
|
|
<p>Supercharger games were not stored on cartridges instead they were stored
|
|
on cassette tapes. The Supercharger, which plugged into the Atari 2600's
|
|
cartridge slot, loaded games into its 6K of Random Access Memory (RAM) using a
|
|
standard audio cassette player. The Supercharger also supported multi-loading,
|
|
which allowed games to be broken into several segments and loaded at different
|
|
times. This was useful for large games which had distinct parts such as role
|
|
playing games.</p>
|
|
|
|
<p>Most of the available Supercharger ROM images are stored in 8448 bytes files.
|
|
However, ROM images of multi-load games are sometimes stored in a set of 8448
|
|
byte files. The names of these files have a two character sequence number in
|
|
them which indicates what load they are. The sequence starts with zero, skips
|
|
a few numbers and then increments by one.</p>
|
|
|
|
<p>Stella supports multi-load games, however, the set of ROM images must be
|
|
combined into a single ROM image file. For example to create a multi-load ROM
|
|
image file for Survival Island you would do the following under Unix:
|
|
|
|
<pre> % cat survivl0.bin survivl6.bin survivl7.bin > survivl.bin</pre>
|
|
|
|
or to create it under DOS you would:
|
|
|
|
<pre> % copy /b survivl0.bin+survivl6.bin+survivl7.bin survivl.bin</pre>
|
|
|
|
<p>Once you have the multi-load ROM image file, survivl.bin in this case, you
|
|
can play the game using it.</p>
|
|
|
|
|
|
<!-- ///////////////////////////////////////////////////////////////////////// -->
|
|
<br><br>
|
|
<p><h1>
|
|
<a name="Starting">5. Starting A Game</a></h1>
|
|
<hr>
|
|
|
|
<p>Once Stella is installed and you have some ROM images you're ready to start
|
|
playing.</p>
|
|
|
|
<p>
|
|
<h2><b>Integrated GUI</b></h2>
|
|
|
|
<p>As of Stella version 2.0, there is an integrated GUI for all ports. This means
|
|
that using the commandline is no longer required (but commandline support is still
|
|
included for those who want to use it).</p>
|
|
|
|
<p>If you start Stella and do not specify a ROM image, it will start in
|
|
'ROM Launcher' mode:<br><br>
|
|
<img src="graphics/launcher.png"></p>
|
|
|
|
<p>The ROM browser, snapshot, and external file settings may be changed by
|
|
clicking the 'Options / Config Files' button:<br><br>
|
|
<img src="graphics/launcher_options_files.png"></p>
|
|
|
|
<p>Selecting a new path for an item is done by clicking the appropriate button(s):<br><br>
|
|
<img src="graphics/rom_browser.png"></p>
|
|
|
|
<p>You can start emulation by selecting a ROM and pressing 'Enter' or
|
|
clicking 'Play', or double-clicking a ROM.</p>
|
|
|
|
<p>
|
|
<h2><b>Command Line</b></h2>
|
|
|
|
<p>Stella can also be used from the commandline (assuming your operating system
|
|
has a commandline). When using this mode and specifying a ROM, the ROM launcher
|
|
is disabled.</p>
|
|
|
|
<p>To run Stella from the commandline, use the following format:</p>
|
|
|
|
<pre> stella [options ...] ROM_FILENAME</pre>
|
|
|
|
<p><b>Options</b> ('0' or 'false' indicates false, '1' or 'true' indicates true,
|
|
others are self-explanatory):</p>
|
|
|
|
<table BORDER=2>
|
|
<tr>
|
|
<th>Argument</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-video <soft|gl></pre></td>
|
|
<td>Use SDL software or OpenGL rendering mode.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-gl_lib <filename></pre></td>
|
|
<td>OpenGL mode only. Specify the OpenGL library to use (only use
|
|
this if you know what you're doing). For OSX, this should
|
|
probably be left blank.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-gl_filter <nearest|linear></pre></td>
|
|
<td>OpenGL mode only. Use GL_NEAREST or GL_LINEAR filtering.
|
|
GL_NEAREST results in a scaled, pixelated image, while
|
|
GL_LINEAR introduces blurring.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-gl_aspect <number></pre></td>
|
|
<td>OpenGL mode only. Specify the amount (as a percentage) to scale the
|
|
image width. Since many video modes do not use square pixels, you can
|
|
reduce width until the pixels appear square. Allowable values are
|
|
50 - 100; I find 85 - 90 gives the most authentic look.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-gl_fsmax <never|always|ui|tia></pre></td>
|
|
<td>OpenGL mode only. Stretch fullscreen image while in the given mode.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-gl_vsync <0|1></pre></td>
|
|
<td>OpenGL mode only. Synchronize screen updates to the vertical blank
|
|
period. This can result in smoother updates, and eliminate tearing.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-zoom_tia <scaler></pre></td>
|
|
<td>Use the specified zoom level while in TIA/emulation mode.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-zoom_ui <scaler></pre></td>
|
|
<td>Use the specified scaler while in non-emulation mode (currently, the ROM
|
|
launcher and debugger).</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-fullscreen <0|1></pre></td>
|
|
<td>Play the game in fullscreen mode.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-fullres <WxH></pre></td>
|
|
<td>Use this resolution in fullscreen mode.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-center <0|1></pre></td>
|
|
<td>Centers game window (if possible).</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-grabmouse <0|1></pre></td>
|
|
<td>Keeps the mouse in the game window.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-palette <standard|z26|user></pre></td>
|
|
<td>Set the palette to either normal Stella, the one used in the z26
|
|
emulator, or a user-defined palette.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-colorloss <1|0></pre></td>
|
|
<td>Enable/disable the PAL color-loss effect.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-framerate <number></pre></td>
|
|
<td>Display the given number of frames per second. Normally, Stella
|
|
will determine framerate based on ROM format.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-sound <1|0></pre></td>
|
|
<td>Enable or disable sound generation.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-channels <1|2></pre></td>
|
|
<td>Enable mono or stereo sound.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-fragsize <number></pre></td>
|
|
<td>Specify the sound fragment size to use. Linux/Mac seems to work
|
|
with 512, Windows may need 2048.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-freq <number></pre></td>
|
|
<td>Set sound sample output frequency (0 - 48000).
|
|
Default is 31400.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-tiafreq <number></pre></td>
|
|
<td>Set sound sample generation frequency (0 - 48000).
|
|
Default is 31400.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-volume <number></pre></td>
|
|
<td>Set the volume (0 - 100).</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-clipvol <1|0></pre></td>
|
|
<td>Enable volume clipping (eliminates popping).</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-cheat <code></pre></td>
|
|
<td>Use the specified cheatcode (see Cheat section for description).</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-showinfo <0|1></pre></td>
|
|
<td>Shows some game info while Stella is running.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-paddle <0|1|2|3></pre></td>
|
|
<td>Indicates which paddle the mouse should emulate (defaults to paddle 0).</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-sa1 <left|right></pre></td>
|
|
<td>Stelladaptor 1 emulates specified joystick port.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-sa2 <left|right></pre></td>
|
|
<td>Stelladaptor 2 emulates specified joystick port.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-p0speed <number></pre></td>
|
|
<td>Speed of digital emulation for paddle 0 (0-100).</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-p1speed <number></pre></td>
|
|
<td>Speed of digital emulation for paddle 1 (0-100).</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-p2speed <number></pre></td>
|
|
<td>Speed of digital emulation for paddle 2 (0-100).</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-p3speed <number></pre></td>
|
|
<td>Speed of digital emulation for paddle 3 (0-100).</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-pthresh <number></pre></td>
|
|
<td>Set threshold for eliminating paddle jitter.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-rombrowse <1|0></pre></td>
|
|
<td>Use browser mode (shows files and folders) in ROM launcher.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-autoslot <1|0></pre></td>
|
|
<td>Automatically switch to the next available save state slot after
|
|
saving a ROM state file.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-ssdir <path></pre></td>
|
|
<td>The directory to save snapshot files to.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-sssingle <0|1></pre></td>
|
|
<td>Generate single snapshot instead of many.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-listrominfo</pre></td>
|
|
<td>Prints relevant contents of the Stella ROM database, one ROM per line,
|
|
and then exit Stella. This can be used for external frontends.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-rominfo <rom></pre></td>
|
|
<td>Display detailed information about the given ROM, and then exit
|
|
Stella.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-launcherres <WxH></pre></td>
|
|
<td>Set the size of the ROM launcher.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-uipalette <1|2></pre></td>
|
|
<td>Used the specified palette for UI elements. This isn't yet
|
|
complete.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-mwheel <lines></pre></td>
|
|
<td>Set the number of lines a mousewheel will scroll in the UI.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-statedir <dir></pre></td>
|
|
<td>Set the directory in which to save state files.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-cheatfile <file></pre></td>
|
|
<td>Set the full pathname of the cheatfile database.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-palettefile <file></pre></td>
|
|
<td>Set the full pathname of the user-defined palette file.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-propsfile <file></pre></td>
|
|
<td>Set the full pathname of the ROM properties file.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-help</pre></td>
|
|
<td>Prints a help message describing these options, and then
|
|
exit Stella.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p>The following are useful to developers. Only use them if you know what
|
|
you're doing! Note that in all cases, the values supplied to the arguments
|
|
are <b>not</b> case sensitive.</p>
|
|
|
|
<table BORDER=2>
|
|
<tr>
|
|
<th>Argument</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-debuggerres <WxH></pre></td>
|
|
<td>Set the size of the debugger window.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-break <address></pre></td>
|
|
<td>Set a breakpoint at specified address.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-debug</pre></td>
|
|
<td>Immediately jump to debugger mode when starting Stella.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-holdreset</pre></td>
|
|
<td>Start the emulator with the Game Reset switch held down.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-holdselect</pre></td>
|
|
<td>Start the emulator with the Game Select switch held down.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-holdbutton0</pre></td>
|
|
<td>Start the emulator with the left joystick button held down.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-type <type></pre></td>
|
|
<td>Set "Cartridge.Type" property. See the <i>Game Properties</i> section
|
|
for valid types.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-channels <Mono|Stereo></pre></td>
|
|
<td>Set "Cartridge.Sound" property.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-ld <A|B></pre></td>
|
|
<td>Set "Console.LeftDifficulty" property.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-rd <A|B></pre></td>
|
|
<td>Set "Console.RightDifficulty" property.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-tv <Color|BlackAndWhite></pre></td>
|
|
<td>Set "Console.TelevisionType" property.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-sp <Yes|No></pre></td>
|
|
<td>Set "Console.SwapPorts" property.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-lc <type></pre></td>
|
|
<td>Set "Controller.Left" property, where type is one of Booster-Grip,
|
|
Driving, Keyboard, Paddles, or Joystick.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-rc <type></pre></td>
|
|
<td>Set "Controller.Right" property, where type is one of Booster-Grip,
|
|
Driving, Keyboard, Paddles, or Joystick.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-bc <type></pre></td>
|
|
<td>Sets both "Controller.Left" and "Controller.Right" properties, where
|
|
type is one of Booster-Grip, Driving, Keyboard, Paddles, or Joystick.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-cp <Yes|No></pre></td>
|
|
<td>Set "Controller.SwapPaddles" property.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-format <NTSC|PAL|PAL60|SECAM></pre></td>
|
|
<td>Set "Display.Format" property.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-ystart <number></pre></td>
|
|
<td>Set "Display.YStart" property (0 - 64).</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-height <number></pre></td>
|
|
<td>Set "Display.Height" property (100 - 256).</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-pp <Yes|No></pre></td>
|
|
<td>Set "Display.Phosphor" property.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-ppblend <number></pre></td>
|
|
<td>Set "Display.PPBlend" property, used for phosphor effect (0-100).
|
|
Default is 77.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><pre>-hmove <Yes|No></pre></td>
|
|
<td>Set "Emulation.HmoveBlanks" property.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
<!-- ///////////////////////////////////////////////////////////////////////// -->
|
|
<br><br>
|
|
<p><h1>
|
|
<a name="Options">6. Changing Options</a></h1>
|
|
<hr>
|
|
|
|
<p>As of version 2.0, all settings can be changed within the integrated Options
|
|
GUI while Stella is running. The options are documented elsewhere in this manual
|
|
and are generally self-explanatory. The Options menu can be accessed from
|
|
the ROM launcher by clicking the 'Options' button, or in-game by pressing the
|
|
'Tab' key.</p>
|
|
|
|
<p><b>Options Menu</b> dialog:<br><br>
|
|
<img src="graphics/options.png">
|
|
|
|
<p><b>Video Options</b> dialog:<br><br>
|
|
<img src="graphics/options_video.png">
|
|
|
|
<p><b>Audio Options</b> dialog:<br><br>
|
|
<img src="graphics/options_audio.png">
|
|
|
|
<p><b>Game Information</b> dialog:<br><br>
|
|
<img src="graphics/options_gameinfo.png">
|
|
|
|
<p><b>Help</b> dialog:<br><br>
|
|
<img src="graphics/options_help.png">
|
|
|
|
<p><b>About</b> dialog:<br><br>
|
|
<img src="graphics/options_about.png">
|
|
|
|
<!-- ///////////////////////////////////////////////////////////////////////// -->
|
|
<br><br>
|
|
<p><h1>
|
|
<a name="Keyboard">7. Keyboard Layout</a></h1>
|
|
<hr>
|
|
|
|
<p>The Atari 2600 console controls and controllers are mapped to the computer's
|
|
keyboard as shown in the following tables.</p>
|
|
|
|
<p>As of Stella 1.4, most of these events can be remapped to other keys on your keyboard
|
|
or buttons on your joystick (see <b>Section 8 -
|
|
<a href="#Remapping">Event Remapping</a></b>). The tables below show the default
|
|
settings.</p>
|
|
|
|
<p><b>Console Controls (can be remapped)</b></p>
|
|
|
|
<table BORDER=2 cellpadding=5>
|
|
<tr>
|
|
<th>Function</th>
|
|
<th>Key (Standard)</th>
|
|
<th>Key (OSX)</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Exit emulator</td>
|
|
<td>Control + q</td>
|
|
<td>Cmd + q</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Exit game mode/enter launcher mode</td>
|
|
<td>Escape</td>
|
|
<td>Escape</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Enter/exit options mode</td>
|
|
<td>Tab</td>
|
|
<td>Tab</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Enter/exit command mode</td>
|
|
<td>Backslash (\)</td>
|
|
<td>Backslash (\)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Enter/exit debugger</td>
|
|
<td>Backquote (`)</td>
|
|
<td>Backquote (`)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Select Game</td>
|
|
<td>F1</td>
|
|
<td>F1</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Reset Game</td>
|
|
<td>F2</td>
|
|
<td>F2</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Color TV</td>
|
|
<td>F3</td>
|
|
<td>F3</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Black/White TV</td>
|
|
<td>F4</td>
|
|
<td>F4</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Left Player Difficulty B</td>
|
|
<td>F5</td>
|
|
<td>F5</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Left Player Difficulty A</td>
|
|
<td>F6</td>
|
|
<td>F6</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Right Player Difficulty B</td>
|
|
<td>F7</td>
|
|
<td>F7</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Right Player Difficulty A</td>
|
|
<td>F8</td>
|
|
<td>F8</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Save state to current slot</td>
|
|
<td>F9</td>
|
|
<td>F9</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Change current state slot</td>
|
|
<td>F10</td>
|
|
<td>F10</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Load state from current slot</td>
|
|
<td>F11</td>
|
|
<td>F11</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Save PNG snapshot</td>
|
|
<td>F12</td>
|
|
<td>F12</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Pause/resume emulation</td>
|
|
<td>Pause</td>
|
|
<td>Pause</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
<p><b>Joystick / Booster-Grip Controller (can be remapped)</b></p>
|
|
|
|
<table BORDER=2>
|
|
<tr>
|
|
<th>Left Joystick (Joy0)</th>
|
|
<th>Right Joystick (Joy1)</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>
|
|
<table BORDER=1 cellpadding=5>
|
|
<tr>
|
|
<th>Function</th>
|
|
<th>Key</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Joystick Up</td>
|
|
<td>Up arrow</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Joystick Down</td>
|
|
<td>Down arrow</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Joystick Left</td>
|
|
<td>Left arrow</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Joystick Right</td>
|
|
<td>Right arrow</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Fire Button</td>
|
|
<td>Space</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Trigger Button</td>
|
|
<td>4</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Booster Button</td>
|
|
<td>5</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
|
|
<td>
|
|
<table BORDER=1 cellpadding=5>
|
|
<tr>
|
|
<th>Function</th>
|
|
<th>Key</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Joystick Up</td>
|
|
<td>Y</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Joystick Down</td>
|
|
<td>H</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Joystick Left</td>
|
|
<td>G</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Joystick Right</td>
|
|
<td>J</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Fire Button</td>
|
|
<td>F</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Trigger Button</td>
|
|
<td>6</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Booster Button</td>
|
|
<td>7</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><b>Paddle Controller digital emulation (can be remapped independently of joystick controller)</b></p>
|
|
|
|
<table BORDER=2>
|
|
<tr>
|
|
<th>Left Paddles</th>
|
|
<th>Right Paddles</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>
|
|
<table BORDER=1 cellpadding=5>
|
|
<tr>
|
|
<th>Function</th>
|
|
<th>Key</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Paddle 0 decrease</td>
|
|
<td>Same as 'Joy0 Left'</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Paddle 0 increase</td>
|
|
<td>Same as 'Joy0 Right'</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Paddle 0 Fire</td>
|
|
<td>Same as 'Joy0 Fire'</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Paddle 1 decrease</td>
|
|
<td>Same as 'Joy0 Up'</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Paddle 1 increase</td>
|
|
<td>Same as 'Joy0 Down'</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Paddle 1 Fire</td>
|
|
<td>Same as 'Joy0 Booster'</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
|
|
<td>
|
|
<table BORDER=1 cellpadding=5>
|
|
<tr>
|
|
<th>Function</th>
|
|
<th>Key</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Paddle 2 decrease</td>
|
|
<td>Same as 'Joy1 Left'</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Paddle 2 increase</td>
|
|
<td>Same as 'Joy1 Right'</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Paddle 2 Fire</td>
|
|
<td>Same as 'Joy1 Fire'</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Paddle 3 decrease</td>
|
|
<td>Same as 'Joy1 Up'</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Paddle 3 increase</td>
|
|
<td>Same as 'Joy1 Down'</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Paddle 3 Fire</td>
|
|
<td>Same as 'Joy1 Booster'</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><b>Driving Controller (cannot be remapped, always associated with joystick controller)</b></p>
|
|
|
|
<table BORDER=2>
|
|
<tr>
|
|
<th>Left Driving</th>
|
|
<th>Right Driving</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>
|
|
<table BORDER=1 cellpadding=5>
|
|
<tr>
|
|
<th>Function</th>
|
|
<th>Key</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Left Direction</td>
|
|
<td>Same as 'Joy0 Left'</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Right Direction</td>
|
|
<td>Same as 'Joy0 Right'</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Fire Button</td>
|
|
<td>Same as 'Joy0 Fire'</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
|
|
<td>
|
|
<table BORDER=1 cellpadding=5>
|
|
<tr>
|
|
<th>Function</th>
|
|
<th>Key</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Left Direction</td>
|
|
<td>Same as 'Joy1 Left'</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Right Direction</td>
|
|
<td>Same as 'Joy1 Right'</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Fire Button</td>
|
|
<td>Same as 'Joy1 Fire'</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><b>Keypad Controller (can be remapped)</b></p>
|
|
|
|
<table BORDER=2>
|
|
<tr>
|
|
<th>Left Keypad</th>
|
|
<th>Right Keypad</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>
|
|
<table BORDER=1 cellpadding=5>
|
|
<tr>
|
|
<th>Pad Button</th>
|
|
<th>Key</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>1</td>
|
|
<td>1</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>2</td>
|
|
<td>2</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>3</td>
|
|
<td>3</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>4</td>
|
|
<td>Q</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>5</td>
|
|
<td>W</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>6</td>
|
|
<td>E</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>7</td>
|
|
<td>A</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>8</td>
|
|
<td>S</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>9</td>
|
|
<td>D</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>.</td>
|
|
<td>Z</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>0</td>
|
|
<td>X</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>#</td>
|
|
<td>C</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
|
|
<td>
|
|
<table BORDER=1 cellpadding=5>
|
|
<tr>
|
|
<th>Pad Button</th>
|
|
<th>Key</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>1</td>
|
|
<td>8</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>2</td>
|
|
<td>9</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>3</td>
|
|
<td>0</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>4</td>
|
|
<td>I</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>5</td>
|
|
<td>O</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>6</td>
|
|
<td>P</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>7</td>
|
|
<td>K</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>8</td>
|
|
<td>L</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>9</td>
|
|
<td>;</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>.</td>
|
|
<td>,</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>0</td>
|
|
<td>.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>#</td>
|
|
<td>/</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><b>Developer Keys (cannot be remapped)</b></p>
|
|
|
|
<table BORDER=2 cellpadding=5>
|
|
<tr>
|
|
<th>Function</th>
|
|
<th>Key (Standard)</th>
|
|
<th>Key (OSX)</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Set "Display.YStart" to next <i>larger</i> value</td>
|
|
<td>Alt + PageUp</td>
|
|
<td>Shift-Cmd + PageUp</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Set "Display.YStart" to next <i>smaller</i> value</td>
|
|
<td>Alt + PageDown</td>
|
|
<td>Shift-Cmd + PageDown</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Set "Display.Height" to next <i>larger</i> value</td>
|
|
<td>Control + PageUp</td>
|
|
<td>Cmd + PageUp</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Set "Display.Height" to next <i>smaller</i> value</td>
|
|
<td>Control + PageDown</td>
|
|
<td>Cmd + PageDown</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><b>Other Keys (cannot be remapped, except those marked with '*')</b></p>
|
|
|
|
<table BORDER=2 cellpadding=5>
|
|
<tr>
|
|
<th>Function</th>
|
|
<th>Key (Standard)</th>
|
|
<th>Key (OSX)</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Switch to next <i>larger</i> zoom level</td>
|
|
<td>Alt + =</td>
|
|
<td>Cmd + =</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Switch to next <i>smaller</i> zoom level</td>
|
|
<td>Alt + -</td>
|
|
<td>Cmd + -</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Toggle fullscreen/windowed mode</td>
|
|
<td>Alt + Enter</td>
|
|
<td>Cmd + Enter</td>
|
|
</tr>
|
|
|
|
<!--
|
|
<tr>
|
|
<td>Toggle OpenGL filtering modes</td>
|
|
<td>Alt + f</td>
|
|
<td>Shift-Cmd + f</td>
|
|
</tr>
|
|
-->
|
|
<tr>
|
|
<td>Decrease volume (*)</td>
|
|
<td>Alt + [</td>
|
|
<td>Shift-Cmd + [</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Increase volume (*)</td>
|
|
<td>Alt + ]</td>
|
|
<td>Shift-Cmd + ]</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Grab mouse (keep mouse in game window)</td>
|
|
<td>Control + g</td>
|
|
<td>Cmd + g</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Toggle display palette (<i>NTSC/PAL/SECAM</i>)</td>
|
|
<td>Control + f</td>
|
|
<td>Cmd + f</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Save current properties to a new properties file</td>
|
|
<td>Control + s</td>
|
|
<td>Cmd + s</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Set mouse to emulate paddle 0</td>
|
|
<td>Control + 0</td>
|
|
<td>Cmd + 0</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Set mouse to emulate paddle 1</td>
|
|
<td>Control + 1</td>
|
|
<td>Cmd + 1</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Set mouse to emulate paddle 2</td>
|
|
<td>Control + 2</td>
|
|
<td>Cmd + 2</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Set mouse to emulate paddle 3</td>
|
|
<td>Control + 3</td>
|
|
<td>Cmd + 3</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Reload current ROM</td>
|
|
<td>Control + r</td>
|
|
<td>Cmd + r</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Emulate 'frying' effect</td>
|
|
<td>Backspace</td>
|
|
<td>Backspace</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Toggle 'phosphor' effect</td>
|
|
<td>Alt + p</td>
|
|
<td>Shift-Cmd + p</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Toggle palette</td>
|
|
<td>Control + p</td>
|
|
<td>Cmd + p</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Toggle PAL color-loss effect</td>
|
|
<td>Control + l</td>
|
|
<td>Cmd + l</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<!-- ///////////////////////////////////////////////////////////////////////// -->
|
|
<br><br><br>
|
|
<p><h1>
|
|
<a name="Remapping">8. Event Remapping</a></h1>
|
|
<hr>
|
|
|
|
<p>This version of Stella has event remapping. Almost every event in the emulator
|
|
can be remapped to another key on the keyboard or to buttons on up to eight
|
|
joysticks/gamepads (see <b>Section 7 - <a href="#Keyboard">Keyboard Layout</a></b>
|
|
for those events which can/cannot be remapped).</p>
|
|
|
|
<p>Note that there are currently two separate event modes in Stella; emulation
|
|
mode and user-interface (UI) mode. Each mode has separate mappings, so (for example)
|
|
while in emulation mode, the left arrow could mean 'joystick 0 left', while in UI
|
|
mode it could mean 'move cursor left'. Emulation mode occurs whenever you're
|
|
actually playing a game. UI mode occurs whenever a user interface is present
|
|
(ROM launcher, debugger, settings menu, etc). Because of these different modes,
|
|
there are two separate mapping areas.
|
|
|
|
<p>To remap an event:
|
|
<ol>
|
|
<li>Enter options menu and click the 'Input Settings' button.</li>
|
|
<li>If you wish to remap emulation events, click the 'Emul. Events' tab.
|
|
Otherwise, click the 'UI Events' tab for user interface events.</li>
|
|
<li>Select event you want to remap and click the 'Map' button.</li>
|
|
<li>Press a key or a joystick button, and that key/button will be bound
|
|
to the selected event. If nothing seems to happen, either Stella
|
|
can't see the input device, or the selected event doesn't support being
|
|
remapped to the input device.</li>
|
|
<li>Erase a mapping by clicking 'Erase', or cancel a remap in progress
|
|
by clicking 'Cancel'.</li>
|
|
<li>Reset default mappings by clicking 'Defaults'.</li>
|
|
</ol>
|
|
|
|
<p>The following screenshots illustrate the event remapping process:<br><br>
|
|
<img src="graphics/eventmapping.png">
|
|
<p>
|
|
<img src="graphics/eventmapping_remap.png">
|
|
|
|
<p>Virtual devices can be configured under the 'Virtual Devs' tab, shown below:<br><br>
|
|
<img src="graphics/eventmapping_virtualdevs.png"></p>
|
|
|
|
<p>Stelladaptor devices can be configured to either the left or right virtual
|
|
ports. See the section 'Stelladaptor Support' for more information.</p>
|
|
|
|
<p>Paddle settings are also configured here. The mouse can emulate either paddle
|
|
0, 1, 2, or 3. Note that for games which don't normally default to paddle 0,
|
|
their ROM properties take care of that remapping. So, for example, a ROM that
|
|
defaults to paddle 1 (Demons to Diamonds) will use paddle 0, as will a ROM
|
|
that defaults to paddle 3 (Tac-Scan). So you never have to worry which paddle
|
|
a ROM will use; it will always default to paddle 0.</p>
|
|
|
|
<p>Paddle threshold is used to eliminate 'jitter', whereby the onscreen paddle
|
|
object seems to move slightly even when no input is present. It specifies the amount
|
|
by which a paddle input has to move before it's considered a real event. Hence,
|
|
it eliminates small movements (default of 600).</p>
|
|
|
|
<p>Paddle x speed is used when emulating a paddle using a digital device
|
|
(keyboard, digital joystick, etc). Because of the on/off nature of digital
|
|
devices, there are no smooth analog values as would be present on a real
|
|
paddle. When using digital devices, the paddle is moved a certain amount
|
|
each frame. These speeds specify how much movement will occur.</p>
|
|
|
|
|
|
<!-- ///////////////////////////////////////////////////////////////////////// -->
|
|
<br><br>
|
|
<p><h1>
|
|
<a name="Adaptor">9. Stelladaptor Support</a></h1>
|
|
<hr>
|
|
|
|
<p>Stella supports real Atari 2600 joysticks, paddles and driving controllers
|
|
using the <a href="http://www.pixelspast.com/products">Stelladaptor</a> device.</p>
|
|
|
|
<p>Stella can use up to <b>two</b> Stelladaptors; any extra ones are ignored.
|
|
Stelladaptor devices will be automatically detected and configured. Devices
|
|
can be plugged/unplugged while the emulation is running; Stella will detect the
|
|
change and act accordingly.</p>
|
|
|
|
<p>The detection and configuration is as follows:
|
|
|
|
<ul>
|
|
<li>The first Stelladaptor found will act as the <b>left game port</b>
|
|
on a real Atari. Depending on the device, Stella will detect it as
|
|
either the left joystick, paddles 0 & 1, or the left driving controller.</li>
|
|
|
|
<li>The second Stelladaptor found will act as the <b>right game port</b>
|
|
on a real Atari. Depending on the device, Stella will detect it as
|
|
either the right joystick, paddles 2 & 3, or the right driving controller.</li>
|
|
|
|
<li>Any other Stelladaptors will be ignored.</li>
|
|
|
|
<li>The assignment ordering of Stelladaptor to port can be redefined with
|
|
'sa1' and 'sa2' (see description in 'Starting a Game').</li>
|
|
</ul>
|
|
|
|
|
|
<!-- ///////////////////////////////////////////////////////////////////////// -->
|
|
<br>
|
|
<p><h1>
|
|
<a name="Debugger">10. Integrated Debugger</a></h1>
|
|
<hr>
|
|
|
|
<p>Have a look at <a href="debugger.html">this page</a> for integrated debugger
|
|
documentation.
|
|
|
|
|
|
<!-- ///////////////////////////////////////////////////////////////////////// -->
|
|
<br><br>
|
|
<p><h1>
|
|
<a name="Settings">11. Settings File</a></h1>
|
|
<hr>
|
|
|
|
<p>Stella will remember when you change a setting either at the command line
|
|
or while the emulation is running, and use the settings the next time
|
|
you start the emulator. The settings are saved in a text file which can
|
|
be edited outside of Stella. This file can contain your default options,
|
|
and eliminates the need to specify them on the command line. Any
|
|
options specified on the command line will override those in the settings file.</p>
|
|
|
|
<p>The syntax for the settings file is very straightforward. Any line starting with
|
|
a ';' character is considered a comment and is ignored. Other lines must be of
|
|
the form: <b>command = value</b>, where <i>command</i> is the same as that
|
|
specified on the command line (without the '-' character), and <i>value</i>
|
|
is dependent on the command.</p>
|
|
|
|
<p>For example, the following table illustrates how command line and settings entries
|
|
are similar:</p>
|
|
|
|
<table BORDER=2>
|
|
<tr>
|
|
<th>Command Line</th>
|
|
<th>Settings File</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>-video gl</td>
|
|
<td>video = gl</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>-volume 75</td>
|
|
<td>volume = 75</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>-showinfo 1</td>
|
|
<td>showinfo = 1 (or showinfo = true)</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p>The settings file has a special name/location depending on which version of Stella
|
|
you use, which is currently not configurable:</p>
|
|
|
|
<p><table cellpadding="5" border="1">
|
|
<tr>
|
|
<td><b>Linux/Unix</b></td>
|
|
<td><i>$HOME/.stella/stellarc</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><b>Macintosh</b></td>
|
|
<td>Not applicable; settings are saved in <i>$HOME/Library/Preferences/StellaOSX.plist</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><b>Windows</b></td>
|
|
<td><i>stella.ini (in same directory as the application)</i></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
<!-- ///////////////////////////////////////////////////////////////////////// -->
|
|
<br><br>
|
|
<p><h1>
|
|
<a name="Cheats">12. Cheatcode Manager</a></h1>
|
|
<hr>
|
|
|
|
<p>Stella 2.0 contains support for Bob Colbert's Cheetah cheat codes, as
|
|
well as an extended Stella-specific type of cheat code that works on
|
|
bankswitched ROMs.</p>
|
|
|
|
<p>To add/remove/edit a cheat code, enter the 'Cheat Code' dialog:<br><br>
|
|
<img src="graphics/cheat.png">
|
|
|
|
<p>Currently, there are three types of cheatcodes available, all of which
|
|
must be entered in hexidecimal format:
|
|
<ul>
|
|
<li><p>Per-frame RAM cheats:<br>
|
|
Evaluated each frame, and apply to RAM only. Format as follows:
|
|
<pre>
|
|
4-digit code: c041
|
|
c0 = address
|
|
41 = data
|
|
</pre>
|
|
</li>
|
|
|
|
<li>Cheetah codes, which are explained in detail on
|
|
<a href="http://members.cox.net/rcolbert/">Bob Colbert's web page</a>,
|
|
along with a list of codes for various games. Cheetah codes
|
|
don't support bankswitched ROMs, so they only work for 2K or 4K ROMs.
|
|
Format as follows:
|
|
<pre>
|
|
6-digit (cheetah) code: aaaddc
|
|
aaa = address - $f000
|
|
dd = data
|
|
c = count - 1
|
|
</pre>
|
|
</li>
|
|
|
|
<li>Stella extended cheats are similar to Cheetah codes, except that
|
|
they can be 7 or 8 digits long, with the extra digits used for the
|
|
bank number:
|
|
<pre>
|
|
7-digit (stella) code: baaaddc
|
|
b = bank (0 to $f)
|
|
aaa = address - $f000
|
|
dd = data
|
|
c = count - 1
|
|
|
|
8-digit (stella) code: bbaaaddc
|
|
bb = bank (0 to $ff)
|
|
aaa = address - $f000
|
|
dd = data
|
|
c = count - 1
|
|
</pre>
|
|
</li>
|
|
</ul>
|
|
|
|
<p>There's also the concept of <i>one shot</i> codes. These codes work
|
|
exactly the same as above, except they aren't saved. They are evaluated
|
|
once and immediately discarded.
|
|
|
|
<p>Here are a few cheat codes we've found:</p>
|
|
<pre>
|
|
Pitfall (standard Cheetah codes):
|
|
5b0ea1 - infinite lives
|
|
723ea1 - infinite time
|
|
aa5??0 - set starting level, ?? = 01 to ff (d0 is kinda neat)
|
|
|
|
Battlezone (Stella extended codes):
|
|
1236ea1 - infinite lives
|
|
|
|
Ms Pac-Man (Stella extended codes):
|
|
108fea1 - infinite lives
|
|
</pre>
|
|
|
|
<p>The name of the cheat database file is configurable through the
|
|
'<i>-cheatfile</i>' commandline argument and within the application itself
|
|
(see <b>Section 5 - <a href="#Starting">Starting a Game</a></b>). If the
|
|
path for this file hasn't been set, the default filename will depend on the
|
|
version of Stella, as follows:</p>
|
|
|
|
<p><table cellpadding="5" border="1">
|
|
<tr>
|
|
<td><b>Linux/Unix</b></td>
|
|
<td><i>$HOME/.stella/stella.cht</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><b>Macintosh</b></td>
|
|
<td><i>$HOME/.stella/stella.cht</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><b>Windows</b></td>
|
|
<td><i>stella.cht</i> (in same directory as the application)</td>
|
|
</tr>
|
|
</table>
|
|
<p>Stella will require a restart for changes to this file to take effect.</p>
|
|
|
|
|
|
<!-- ///////////////////////////////////////////////////////////////////////// -->
|
|
<br><br>
|
|
<p><h1>
|
|
<a name="Properties">13. Game Properties</a></h1>
|
|
<hr>
|
|
|
|
<p>Stella uses game properties to specify the "best" emulator settings for a
|
|
game. As of version 2.2 of Stella, a default database of properties are
|
|
built-in, but you may modify these through the use of a <b>stella.pro</b> file.
|
|
This per-user file will contain all properties modified by the user. So this
|
|
means that when you upgrade Stella, your personal properties settings are
|
|
preserved.</p>
|
|
|
|
<p>
|
|
<h2><b>Property File</b></h2>
|
|
|
|
<p>A property file consists of some number of blocks. Each block in the file
|
|
contains the properties for a single game. For example the general format of
|
|
a property file is:</p>
|
|
|
|
<p>
|
|
<pre>
|
|
; Comments
|
|
"Cartridge.MD5" "Value"
|
|
"Property" "Value"
|
|
""
|
|
|
|
; Comments
|
|
"Cartridge.MD5" "Value"
|
|
"Property" "Value"
|
|
""
|
|
|
|
. . .
|
|
|
|
; Comments
|
|
"Cartridge.MD5" "Value"
|
|
"Property" "Value"
|
|
""</pre>
|
|
|
|
<p>Every block in the property file must have a unique value for the
|
|
<i>Cartridge.MD5</i> property.</p>
|
|
|
|
<p>
|
|
<h2><b>Properties</b></h2>
|
|
|
|
<p>Each block in a property file consists of a set of properties for a single
|
|
game. Stella supports the properties described below:</p>
|
|
|
|
<table CELLSPACING="10">
|
|
<tr>
|
|
<td VALIGN="TOP"><i>Cartridge.MD5:</i></td>
|
|
<td>This property indicates the MD5 checksum of the ROM image as a
|
|
string of hexadecimal digits. Stella uses this property while
|
|
attempting to match a game with its block of properties. If the
|
|
value of the property matches the MD5 checksum of the ROM image then
|
|
Stella uses that block of properties for the game. You can use the
|
|
GNU md5sum program, which is included with most Linux distributions,
|
|
to calculate the MD5 checksum of a ROM image.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP"><i>Cartridge.Manufacturer:</i></td>
|
|
<td>This property indicates the game's manufacturer. Currently this
|
|
property is not being used, however, future versions of Stella will
|
|
probably allow the user to view this information.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP"><i>Cartridge.ModelNo:</i></td>
|
|
<td>This property indicates the manufacturer's model number for the
|
|
game. Currently this property is not being used, however, future
|
|
versions of Stella will probably allow the user to view this information.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP"><i>Cartridge.Name:</i></td>
|
|
<td>This property indicates the actual name of the game.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP"><i>Cartridge.Note:</i></td>
|
|
<td>This property contains any special notes about playing the game.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP"><i>Cartridge.Rarity:</i></td>
|
|
<td>This property indicates how rare a cartridge is, based on the scale
|
|
described on AtariAge.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP"><i>Cartridge.Sound:</i></td>
|
|
<td>This property determines if the game should use 1 or 2 channels for
|
|
sound output. All original Atari 2600 machines supported 1 channel only,
|
|
but some homebrew games have been written to take advantage of stereo
|
|
sound. The value of this property must be Mono or Stereo.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP"><i>Cartridge.Type:</i></td>
|
|
<td>This property indicates the bank-switching type for the game.
|
|
The value of this property must be: Auto-detect, 2K, 3E, 3F, 4K, AR,
|
|
CV, DPC, E0, E7, F4, F4SC, F6, F6SC, F8, F8SC, FASC, FE, MB, MC or UA.
|
|
For more information about bank-switching see Kevin Horton's 2600
|
|
bank-switching document.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP"><i>Console.LeftDifficulty:</i></td>
|
|
<td>This property indicates the default difficulty setting for the left
|
|
player. The value of this property must be A or B.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP"><i>Console.RightDifficulty:</i></td>
|
|
<td>This property indicates the default difficulty setting for the
|
|
right player. The value of this property must be A or B.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP"><i>Console.TelevisionType:</i></td>
|
|
<td>This property indicates the default television setting for the
|
|
game. The value of this property must be Color or BlankAndWhite.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP"><i>Console.SwapPorts:</i></td>
|
|
<td>This property indicates that the left and right ports should be
|
|
swapped internally. This is used for ROMs like 'Raiders' where the
|
|
Player 0 joystick is plugged into the right joystick port.
|
|
The value of this property must be Yes or No.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP"><i>Controller.Left:</i></td>
|
|
<td>This property indicates what type of controller the left player
|
|
uses. The value of this property must be Booster-Grip, Driving,
|
|
Keyboard, Paddles, or Joystick.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP"><i>Controller.Right:</i></td>
|
|
<td>This property indicates what type of controller the right player
|
|
uses. The value of this property must be Booster-Grip, Driving,
|
|
Keyboard, Paddles, or Joystick.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP"><i>Controller.SwapPaddles:</i></td>
|
|
<td>This property indicates that the left and right paddles in
|
|
a particular port should be swapped. This is used for ROMs like
|
|
'Demons to Diamonds' where the default paddle is paddle 1, not
|
|
paddle 0. Other ROMs such as 'Tac-Scan' default to paddle 3,
|
|
which can be set using both 'Controller.SwapPaddles' and
|
|
'Console.SwapPorts'. The value of this property must be Yes or No.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP"><i>Display.Format:</i></td>
|
|
<td>This property indicates the television format the game was
|
|
designed for. The value of this property must be Auto-detect, NTSC,
|
|
PAL or PAL60.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP"><i>Display.YStart:</i></td>
|
|
<td>This property indicates the scan-line to start displaying at.
|
|
The value of this property must be <i>n</i> such that
|
|
0 <= <i>n</i> <= 64.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP"><i>Display.Height:</i></td>
|
|
<td>This property indicates the number of scan-lines to display.
|
|
The value of this property must be <i>n</i> such that
|
|
100 <= <i>n</i> <= 256.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP"><i>Display.Phosphor:</i></td>
|
|
<td>This property indicates whether the phosphor effect should be
|
|
emulated or not. The value of this property must be Yes or No.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP"><i>Display.PPBlend:</i></td>
|
|
<td>This property indicates the amount of blending which will occur
|
|
while using the phosphor effect. The value of this property must be
|
|
<i>n</i> such that 0 <= <i>n</i> <= 100. The default value
|
|
is 77.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP"><i>Emulation.HmoveBlanks:</i></td>
|
|
<td>This property indicates whether the TIA HMOVE blank bug should be
|
|
emulated or not. The value of this property must be Yes or No.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><b>Note:</b> Items marked as '*' are deprecated, and will probably be
|
|
removed in a future release.</p>
|
|
|
|
<p>The name of the properties file is configurable through the
|
|
'<i>-propsfile</i>' commandline argument and within the application itself
|
|
(see <b>Section 5 - <a href="#Starting">Starting a Game</a></b>). If the
|
|
path for this file hasn't been set, the default filename will depend on the
|
|
version of Stella, as follows:</p>
|
|
|
|
<p><table cellpadding="5" border="1">
|
|
<tr>
|
|
<td><b>Linux/Unix</b></td>
|
|
<td><i>$HOME/.stella/stella.pro</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><b>Macintosh</b></td>
|
|
<td><i>$HOME/.stella/stella.pro</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><b>Windows</b></td>
|
|
<td><i>stella.pro</i> (in same directory as the application)</td>
|
|
</tr>
|
|
</table>
|
|
<p>Stella will require a restart for changes to this file to take effect.</p>
|
|
|
|
|
|
<!-- ///////////////////////////////////////////////////////////////////////// -->
|
|
<br><br>
|
|
<p><h1>
|
|
<a name="Palette">14. Palette Support</a></h1>
|
|
<hr>
|
|
|
|
<p>An Atari 2600 palette consists of 128 colours, which are different
|
|
for the three major television standards (NTSC, PAL/PAL60, SECAM).
|
|
Stella supports two built-in palettes and one user-defined palette for each format.
|
|
These are set using the '-palette' option, and are described as follows:</p>
|
|
<p><table cellpadding="5" border="1">
|
|
<tr>
|
|
<td><b>standard</b></td>
|
|
<td>The default palette from Stella 1.4 onwards.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><b>z26</b></td>
|
|
<td>The palette from the z26 emulator.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><b>user</b></td>
|
|
<td>An external palette file, supplied by the user.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p>Support for a user-defined palette is a new feature for Stella 2.3, and
|
|
is further described as follows:
|
|
<ul>
|
|
<li>The palette file must be at least 792 bytes long. Colours are stored
|
|
in 24-bit RGB, with the first byte for red, the second for green, the
|
|
third for blue, for a total of 3 bytes per colour.</li>
|
|
<li>The first 384 bytes of the file (128 * 3) will be used for the NTSC
|
|
palette. The next 384 bytes (128 * 3) will be for the PAL/PAL60 palette.
|
|
The next 24 bytes (8 * 3) will be for the SECAM palette, which
|
|
consists of eight distinct colours. Any extra data in the file
|
|
will be ignored.</li>
|
|
<li>The PAL colour-loss effect is calculated within Stella. You do not
|
|
need to specify those colours in the palette file.
|
|
</ul>
|
|
|
|
<p>The name of the palette file is configurable through the
|
|
'<i>-palettefile</i>' commandline argument and within the application itself
|
|
(see <b>Section 5 - <a href="#Starting">Starting a Game</a></b>). If the
|
|
path for this file hasn't been set, the default filename will depend on the
|
|
version of Stella, as follows:</p>
|
|
|
|
<p><table cellpadding="5" border="1">
|
|
<tr>
|
|
<td><b>Linux/Unix</b></td>
|
|
<td><i>$HOME/.stella/stella.pal</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><b>Macintosh</b></td>
|
|
<td><i>$HOME/.stella/stella.pal</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><b>Windows</b></td>
|
|
<td><i>stella.pal</i> (in same directory as the application)</td>
|
|
</tr>
|
|
</table>
|
|
<p>Note that to actually use the external palette, the palette file must
|
|
exist and be valid, <b>and</b> the palette should be set to <i>user</i>.
|
|
The current ROM will have to be reloaded for changes to this file to take
|
|
effect.</p>
|
|
|
|
|
|
<!-- ///////////////////////////////////////////////////////////////////////// -->
|
|
<br><br>
|
|
<p><h1>
|
|
<a name="Acknowledgments">15. Acknowledgments</a></h1>
|
|
<hr>
|
|
|
|
<p>Bradford W. Mott started developing Stella during the fall of 1995 and since
|
|
then a number of people from around the world have contributed to the project.
|
|
Some people have provided technical help while others have offered suggestions
|
|
and praise. The Stella Team is grateful for all the help and support it has
|
|
received over the years. The following is an incomplete list of the people who have
|
|
played a part in bringing Stella to you:</p>
|
|
|
|
<table CELLSPACING="15">
|
|
<tr>
|
|
<td VALIGN="TOP">Stephen Anthony</td>
|
|
<td>Ported Stella 1.1 to SDL. Added extra command line options to X11/SDL
|
|
versions. Added INI file support, faster startup, snapshot support,
|
|
and pause functionality to core. Converted Stella 1.1 manual to HTML.
|
|
Ported codebase to SDL for Windows/MacOSX. Added OpenGL support and
|
|
Stelladaptor support. Current maintainer for the Linux and Windows versions.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP">David Aspell</td>
|
|
<td>Ported release 0.7 of Stella to Java</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP">Christopher Bennett</td>
|
|
<td>Helped discover a Superchanger emulation bug in release 1.0 of Stella</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP">Alexander Bilstein</td>
|
|
<td>Provided "A Brief History of the Atari 2600" for this manual</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP">Dan Boris</td>
|
|
<td>Provided technical information on the Supercharger</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP">Piero Cavina</td>
|
|
<td>Allowed "Oystron" to be included in the Stella distribution</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP">Bob Colbert</td>
|
|
<td>Allowed "Okie Dokie" to be included in the Stella distribution</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP">Joe D'Andrea</td>
|
|
<td>Author of the IRIX port of Stella until release 1.2</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP">Renato Ferreira</td>
|
|
<td>Provided code to support private colormaps under Unix</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP">Ron Fries</td>
|
|
<td>Author of the awesome TIA Sound library</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP">Aaron Giles</td>
|
|
<td>Author of the Power Macintosh version of Stella until release 1.1</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP">Mark Grebe</td>
|
|
<td>Author of the Macintosh OSX version of Stella starting with the
|
|
1.4 release. Helped with Stelladaptor support.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP">Mark Hahn</td>
|
|
<td>Allowed "Elk Attack" to be included in the Stella distribution and
|
|
provided help with the TIA HMOVE blank bug</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP">Kevin Horton</td>
|
|
<td>Author of the definitive Atari 2600 bank-switching document</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP">Thomas Jentzsch</td>
|
|
<td>Provided updated NTSC palette and many ideas</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP">Kostas Nakos</td>
|
|
<td>Author/maintainer of the WinCE version of Stella starting with the
|
|
2.0 release</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP">Erik Kovach</td>
|
|
<td>Author of the property file for release 0.7, 1.0, 1.1, and 1.2 of Stella</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP">Daniel Marks</td>
|
|
<td>Provided improved keyboard joystick support for Stella release 0.1</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP">James Mcclain</td>
|
|
<td>Provided patches for the 1.2 release to get Stella to compile with GCC 3.0</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP">David McEwen</td>
|
|
<td>Author of the Acorn version of Stella</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP">Jeff Miller</td>
|
|
<td>Author of the Windows version of Stella until release 1.2</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP">Dan Mowczan</td>
|
|
<td>Provided a Supercharger to help with Stella's development</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP">Jack Nutting</td>
|
|
<td>Author of the OpenStep version of Stella</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP">Manuel Polik</td>
|
|
<td>Author of the Windows version of Stella starting with the 1.2 release</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP">Jim Pragit</td>
|
|
<td>Author of the "Game Menu" emulator game shell</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP">John Saeger</td>
|
|
<td>Participated in a helpful discussion on understanding the TIA's
|
|
RESPx multi-sprite trick</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP">Chris Salomon</td>
|
|
<td>Provided information and code to help implement Supercharger support</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP">Jason Scott</td>
|
|
<td>Organizer of the property file archive for early versions of
|
|
Stella; now he's helping with the web site</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP">David Shaw</td>
|
|
<td>Provided make targets for the BSDI platform</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP">Raul Silva</td>
|
|
<td>Helped with design and graphics for an early version of the Stella
|
|
web site</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP">Chris Snell</td>
|
|
<td>Maintained a mirror of the Stella FTP site</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP">Darrell Spice Jr.</td>
|
|
<td>Author of the OS/2 version of Stella</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP">John Stiles</td>
|
|
<td>Maintained the Macintosh version of Stella until release 1.2</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP">Eckhard Stolberg</td>
|
|
<td>Provided a description of the TIA bug that produces the star field
|
|
effect in Cosmic Ark, provided the PAL television palette, and
|
|
participated in a helpful discussion on understanding the TIA's RESPx
|
|
multi-sprite trick. He also provided the Commavid and Megaboy support
|
|
for Stella as well as some improved Supercharger BIOS code.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP">Matthew Stroup</td>
|
|
<td>Author of the Amiga version of Stella</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP">Joel Sutton</td>
|
|
<td>Author of the FreeBSD version of Stella</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP">Greg Troutman</td>
|
|
<td>Allowed "This Planet Sucks" to be included in the Stella distribution</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP">Curt Vendel</td>
|
|
<td>Provided schematics of the TIA which are being used to improve the
|
|
TIA emulation.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP">David Voswinkel</td>
|
|
<td>Maintainer of the PSP version of Stella starting with the 2.0 release</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP">Brian Watson</td>
|
|
<td>Helped with getting the illegal CPU instruction support working with Stella.
|
|
Brian also submitted a number of other changes, such as debugger support, which
|
|
have been finally integrated into the 2.0 release of Stella. Without
|
|
a doubt, there would be no debugger support in Stella if not for the
|
|
tireless work of Brian.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP">Keith Wilkins</td>
|
|
<td>Maintained the DOS version of Stella until release 0.7</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP">Jeff Wisnia</td>
|
|
<td>Provided technical data sheet for the 6532 RIOT chip</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td VALIGN="TOP">Alex Zaballa</td>
|
|
<td>Maintainer of the GP2X version of Stella starting with the 2.1 release</td>
|
|
</tr>
|
|
|
|
</table>
|
|
|
|
|
|
<!-- ///////////////////////////////////////////////////////////////////////// -->
|
|
<br><br>
|
|
<p><h1>
|
|
<a name="License">16. License and Disclaimer</a></h1>
|
|
<hr>
|
|
|
|
<p>
|
|
<H2>GNU GENERAL PUBLIC LICENSE</h2>
|
|
<P>
|
|
Version 2, June 1991
|
|
|
|
</P>
|
|
|
|
<PRE>
|
|
Copyright (C) 1989, 1991 Free Software Foundation, Inc.
|
|
59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
|
|
|
|
Everyone is permitted to copy and distribute verbatim copies
|
|
of this license document, but changing it is not allowed.
|
|
</PRE>
|
|
|
|
|
|
|
|
<H2>Preamble</H2>
|
|
|
|
<P>
|
|
The licenses for most software are designed to take away your
|
|
freedom to share and change it. By contrast, the GNU General Public
|
|
License is intended to guarantee your freedom to share and change free
|
|
software--to make sure the software is free for all its users. This
|
|
General Public License applies to most of the Free Software
|
|
Foundation's software and to any other program whose authors commit to
|
|
using it. (Some other Free Software Foundation software is covered by
|
|
the GNU Library General Public License instead.) You can apply it to
|
|
your programs, too.
|
|
|
|
</P>
|
|
<P>
|
|
When we speak of free software, we are referring to freedom, not
|
|
price. Our General Public Licenses are designed to make sure that you
|
|
have the freedom to distribute copies of free software (and charge for
|
|
this service if you wish), that you receive source code or can get it
|
|
if you want it, that you can change the software or use pieces of it
|
|
in new free programs; and that you know you can do these things.
|
|
|
|
</P>
|
|
<P>
|
|
To protect your rights, we need to make restrictions that forbid
|
|
anyone to deny you these rights or to ask you to surrender the rights.
|
|
These restrictions translate to certain responsibilities for you if you
|
|
distribute copies of the software, or if you modify it.
|
|
|
|
</P>
|
|
<P>
|
|
For example, if you distribute copies of such a program, whether
|
|
gratis or for a fee, you must give the recipients all the rights that
|
|
you have. You must make sure that they, too, receive or can get the
|
|
source code. And you must show them these terms so they know their
|
|
rights.
|
|
|
|
</P>
|
|
<P>
|
|
We protect your rights with two steps: (1) copyright the software, and
|
|
(2) offer you this license which gives you legal permission to copy,
|
|
distribute and/or modify the software.
|
|
|
|
</P>
|
|
<P>
|
|
Also, for each author's protection and ours, we want to make certain
|
|
that everyone understands that there is no warranty for this free
|
|
software. If the software is modified by someone else and passed on, we
|
|
want its recipients to know that what they have is not the original, so
|
|
that any problems introduced by others will not reflect on the original
|
|
authors' reputations.
|
|
|
|
</P>
|
|
<P>
|
|
Finally, any free program is threatened constantly by software
|
|
patents. We wish to avoid the danger that redistributors of a free
|
|
program will individually obtain patent licenses, in effect making the
|
|
program proprietary. To prevent this, we have made it clear that any
|
|
patent must be licensed for everyone's free use or not licensed at all.
|
|
|
|
</P>
|
|
<P>
|
|
The precise terms and conditions for copying, distribution and
|
|
modification follow.
|
|
|
|
</P>
|
|
|
|
|
|
<H2>TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION</H2>
|
|
|
|
|
|
<P>
|
|
|
|
<STRONG>0.</STRONG>
|
|
This License applies to any program or other work which contains
|
|
a notice placed by the copyright holder saying it may be distributed
|
|
under the terms of this General Public License. The "Program", below,
|
|
refers to any such program or work, and a "work based on the Program"
|
|
means either the Program or any derivative work under copyright law:
|
|
that is to say, a work containing the Program or a portion of it,
|
|
either verbatim or with modifications and/or translated into another
|
|
language. (Hereinafter, translation is included without limitation in
|
|
the term "modification".) Each licensee is addressed as "you".
|
|
<P>
|
|
|
|
Activities other than copying, distribution and modification are not
|
|
covered by this License; they are outside its scope. The act of
|
|
running the Program is not restricted, and the output from the Program
|
|
is covered only if its contents constitute a work based on the
|
|
Program (independent of having been made by running the Program).
|
|
Whether that is true depends on what the Program does.
|
|
|
|
<P>
|
|
|
|
<STRONG>1.</STRONG>
|
|
You may copy and distribute verbatim copies of the Program's
|
|
source code as you receive it, in any medium, provided that you
|
|
conspicuously and appropriately publish on each copy an appropriate
|
|
copyright notice and disclaimer of warranty; keep intact all the
|
|
notices that refer to this License and to the absence of any warranty;
|
|
and give any other recipients of the Program a copy of this License
|
|
along with the Program.
|
|
<P>
|
|
|
|
You may charge a fee for the physical act of transferring a copy, and
|
|
you may at your option offer warranty protection in exchange for a fee.
|
|
<P>
|
|
|
|
<STRONG>2.</STRONG>
|
|
You may modify your copy or copies of the Program or any portion
|
|
of it, thus forming a work based on the Program, and copy and
|
|
distribute such modifications or work under the terms of Section 1
|
|
above, provided that you also meet all of these conditions:
|
|
<P>
|
|
|
|
<UL>
|
|
|
|
<LI><STRONG>a)</STRONG>
|
|
You must cause the modified files to carry prominent notices
|
|
stating that you changed the files and the date of any change.
|
|
|
|
<P>
|
|
<LI><STRONG>b)</STRONG>
|
|
You must cause any work that you distribute or publish, that in
|
|
whole or in part contains or is derived from the Program or any
|
|
part thereof, to be licensed as a whole at no charge to all third
|
|
parties under the terms of this License.
|
|
|
|
<P>
|
|
<LI><STRONG>c)</STRONG>
|
|
If the modified program normally reads commands interactively
|
|
when run, you must cause it, when started running for such
|
|
interactive use in the most ordinary way, to print or display an
|
|
announcement including an appropriate copyright notice and a
|
|
notice that there is no warranty (or else, saying that you provide
|
|
a warranty) and that users may redistribute the program under
|
|
these conditions, and telling the user how to view a copy of this
|
|
License. (Exception: if the Program itself is interactive but
|
|
does not normally print such an announcement, your work based on
|
|
the Program is not required to print an announcement.)
|
|
</UL>
|
|
|
|
These requirements apply to the modified work as a whole. If
|
|
identifiable sections of that work are not derived from the Program,
|
|
and can be reasonably considered independent and separate works in
|
|
themselves, then this License, and its terms, do not apply to those
|
|
sections when you distribute them as separate works. But when you
|
|
distribute the same sections as part of a whole which is a work based
|
|
on the Program, the distribution of the whole must be on the terms of
|
|
this License, whose permissions for other licensees extend to the
|
|
entire whole, and thus to each and every part regardless of who wrote it.
|
|
<P>
|
|
|
|
Thus, it is not the intent of this section to claim rights or contest
|
|
your rights to work written entirely by you; rather, the intent is to
|
|
exercise the right to control the distribution of derivative or
|
|
collective works based on the Program.
|
|
<P>
|
|
|
|
In addition, mere aggregation of another work not based on the Program
|
|
with the Program (or with a work based on the Program) on a volume of
|
|
a storage or distribution medium does not bring the other work under
|
|
the scope of this License.
|
|
|
|
<P>
|
|
|
|
<STRONG>3.</STRONG>
|
|
You may copy and distribute the Program (or a work based on it,
|
|
under Section 2) in object code or executable form under the terms of
|
|
Sections 1 and 2 above provided that you also do one of the following:
|
|
|
|
|
|
<!-- we use this doubled UL to get the sub-sections indented, -->
|
|
<!-- while making the bullets as unobvious as possible. -->
|
|
<UL>
|
|
|
|
<LI><STRONG>a)</STRONG>
|
|
Accompany it with the complete corresponding machine-readable
|
|
source code, which must be distributed under the terms of Sections
|
|
1 and 2 above on a medium customarily used for software interchange; or,
|
|
|
|
<P>
|
|
<LI><STRONG>b)</STRONG>
|
|
Accompany it with a written offer, valid for at least three
|
|
years, to give any third party, for a charge no more than your
|
|
cost of physically performing source distribution, a complete
|
|
machine-readable copy of the corresponding source code, to be
|
|
distributed under the terms of Sections 1 and 2 above on a medium
|
|
customarily used for software interchange; or,
|
|
|
|
<P>
|
|
<LI><STRONG>c)</STRONG>
|
|
Accompany it with the information you received as to the offer
|
|
to distribute corresponding source code. (This alternative is
|
|
allowed only for noncommercial distribution and only if you
|
|
received the program in object code or executable form with such
|
|
an offer, in accord with Subsection b above.)
|
|
</UL>
|
|
|
|
The source code for a work means the preferred form of the work for
|
|
making modifications to it. For an executable work, complete source
|
|
code means all the source code for all modules it contains, plus any
|
|
associated interface definition files, plus the scripts used to
|
|
control compilation and installation of the executable. However, as a
|
|
special exception, the source code distributed need not include
|
|
anything that is normally distributed (in either source or binary
|
|
form) with the major components (compiler, kernel, and so on) of the
|
|
operating system on which the executable runs, unless that component
|
|
itself accompanies the executable.
|
|
<P>
|
|
|
|
If distribution of executable or object code is made by offering
|
|
access to copy from a designated place, then offering equivalent
|
|
access to copy the source code from the same place counts as
|
|
distribution of the source code, even though third parties are not
|
|
compelled to copy the source along with the object code.
|
|
<P>
|
|
|
|
<STRONG>4.</STRONG>
|
|
You may not copy, modify, sublicense, or distribute the Program
|
|
except as expressly provided under this License. Any attempt
|
|
otherwise to copy, modify, sublicense or distribute the Program is
|
|
void, and will automatically terminate your rights under this License.
|
|
However, parties who have received copies, or rights, from you under
|
|
this License will not have their licenses terminated so long as such
|
|
parties remain in full compliance.
|
|
|
|
<P>
|
|
|
|
<STRONG>5.</STRONG>
|
|
You are not required to accept this License, since you have not
|
|
signed it. However, nothing else grants you permission to modify or
|
|
distribute the Program or its derivative works. These actions are
|
|
prohibited by law if you do not accept this License. Therefore, by
|
|
modifying or distributing the Program (or any work based on the
|
|
Program), you indicate your acceptance of this License to do so, and
|
|
all its terms and conditions for copying, distributing or modifying
|
|
the Program or works based on it.
|
|
|
|
<P>
|
|
|
|
<STRONG>6.</STRONG>
|
|
Each time you redistribute the Program (or any work based on the
|
|
Program), the recipient automatically receives a license from the
|
|
original licensor to copy, distribute or modify the Program subject to
|
|
these terms and conditions. You may not impose any further
|
|
restrictions on the recipients' exercise of the rights granted herein.
|
|
You are not responsible for enforcing compliance by third parties to
|
|
this License.
|
|
|
|
<P>
|
|
|
|
<STRONG>7.</STRONG>
|
|
If, as a consequence of a court judgment or allegation of patent
|
|
infringement or for any other reason (not limited to patent issues),
|
|
conditions are imposed on you (whether by court order, agreement or
|
|
otherwise) that contradict the conditions of this License, they do not
|
|
excuse you from the conditions of this License. If you cannot
|
|
distribute so as to satisfy simultaneously your obligations under this
|
|
License and any other pertinent obligations, then as a consequence you
|
|
may not distribute the Program at all. For example, if a patent
|
|
license would not permit royalty-free redistribution of the Program by
|
|
all those who receive copies directly or indirectly through you, then
|
|
the only way you could satisfy both it and this License would be to
|
|
refrain entirely from distribution of the Program.
|
|
<P>
|
|
|
|
If any portion of this section is held invalid or unenforceable under
|
|
any particular circumstance, the balance of the section is intended to
|
|
apply and the section as a whole is intended to apply in other
|
|
circumstances.
|
|
<P>
|
|
|
|
It is not the purpose of this section to induce you to infringe any
|
|
patents or other property right claims or to contest validity of any
|
|
such claims; this section has the sole purpose of protecting the
|
|
integrity of the free software distribution system, which is
|
|
implemented by public license practices. Many people have made
|
|
generous contributions to the wide range of software distributed
|
|
through that system in reliance on consistent application of that
|
|
system; it is up to the author/donor to decide if he or she is willing
|
|
to distribute software through any other system and a licensee cannot
|
|
impose that choice.
|
|
<P>
|
|
|
|
This section is intended to make thoroughly clear what is believed to
|
|
be a consequence of the rest of this License.
|
|
|
|
<P>
|
|
|
|
<STRONG>8.</STRONG>
|
|
If the distribution and/or use of the Program is restricted in
|
|
certain countries either by patents or by copyrighted interfaces, the
|
|
original copyright holder who places the Program under this License
|
|
may add an explicit geographical distribution limitation excluding
|
|
those countries, so that distribution is permitted only in or among
|
|
countries not thus excluded. In such case, this License incorporates
|
|
the limitation as if written in the body of this License.
|
|
|
|
<P>
|
|
|
|
<STRONG>9.</STRONG>
|
|
The Free Software Foundation may publish revised and/or new versions
|
|
of the General Public License from time to time. Such new versions will
|
|
be similar in spirit to the present version, but may differ in detail to
|
|
address new problems or concerns.
|
|
<P>
|
|
|
|
Each version is given a distinguishing version number. If the Program
|
|
specifies a version number of this License which applies to it and "any
|
|
later version", you have the option of following the terms and conditions
|
|
either of that version or of any later version published by the Free
|
|
Software Foundation. If the Program does not specify a version number of
|
|
this License, you may choose any version ever published by the Free Software
|
|
Foundation.
|
|
|
|
<P>
|
|
|
|
|
|
<STRONG>10.</STRONG>
|
|
If you wish to incorporate parts of the Program into other free
|
|
programs whose distribution conditions are different, write to the author
|
|
to ask for permission. For software which is copyrighted by the Free
|
|
Software Foundation, write to the Free Software Foundation; we sometimes
|
|
make exceptions for this. Our decision will be guided by the two goals
|
|
of preserving the free status of all derivatives of our free software and
|
|
of promoting the sharing and reuse of software generally.
|
|
|
|
|
|
|
|
<P><STRONG>NO WARRANTY</STRONG></P>
|
|
|
|
<P>
|
|
|
|
<STRONG>11.</STRONG>
|
|
BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
|
|
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
|
|
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
|
|
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
|
|
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
|
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
|
|
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
|
|
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
|
|
REPAIR OR CORRECTION.
|
|
|
|
<P>
|
|
|
|
<STRONG>12.</STRONG>
|
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
|
|
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
|
|
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
|
|
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
|
|
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
|
|
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
|
|
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
|
|
POSSIBILITY OF SUCH DAMAGES.
|
|
|
|
</body>
|
|
</html>
|