       C o t t A G E
Cott Arcade Generic Emulator
(c) 2002 The Java-Emu Team


What's new:
----------

   CottAGE 0.03

   N.B: 
	CottAGE uses sun.audio to avoid the need of the java plugin, but
   	sun.audio is unsupported and undocumented. Also, sun.audio is
   	restricted to 8bit 8KHz mu_Law output, which is very low quality.
   	Because of that, the sound is dull and there's a lot of bad aliasing.
   	Furthermore, there's no way that I know of to correctly align
   	the generated buffers, since you can't determine where the sound
   	system is reading the buffer. This results in a very annoying 'rattling' noise.
   	As a conclusion, there is sound but it sucks.
	We expect to add support for javax.sound but with the need of the java plugin.
        Another drawback is that javax.sound is buggy in JDK 1.4 and timing errors occur.

   - [Bw8080] Add support for jspecter, jspectr2, spaceatt [Gollum]
   - [Bw8080] Add support for invaderl, spceking, spcewars [Gollum]
   - [Bw8080] Add support for spacewr3, sinvemag, sinvzen [Gollum]
   - [Bw8080] Fixes spaceat2, boothill [Gollum]
   - [Bw8080] Rewrite driver selection [Gollum]
   - [Bw8080] Resync some subdrivers with MAME 0.60s [Gollum]
   - [Galaxian] Add support for galaxian, scramblb [Erik Duijs]
   - [Namco] Add namco sound hardware [Erik Duijs]
   - [Pacman] Add sound support to all subdrivers [Erik Duijs]
   - [Z80] Removed localization of PC in fetch-decode loop. [Erik Duijs]
   - Rewrite throttling code [Arnon Cardoso]
   - Improve bitmap facilities [Erik Duijs]
   - Fixes XY scrolling playfield [Erik Duijs]
   - Add support for video granularity [Erik Duijs]
   - Fixes error messages in zip file support [Erik Duijs]
   - Rename all drivers according to MAME 0.60s [Gollum]
   - Start writing new throttling code [Erik Duijs/Arnon Cardoso]
   - Add sound enable/disable option [Erik Duijs]
   - Add sound support in CottAGE [Erik Duijs]
   - Add soundchip support [Erik Duijs]
   - Resync directories with MAME 0.60s [Gollum]
   - Improve HTML pages with games with sound [Gollum]
   - Improve HTML pages with sorted games [Gollum]
   - Improve HTML pages with clones and games [Gollum]

   CottAGE 0.02 - 10/05/2002

   - Add a weird trick for throttling on Win9X/Win2K [Erik Duijs]
   - [Z80] Add INI/IND opcodes [Erik Duijs]
   - [Bombjack] Fixes driver information [Erik Duijs/Gollum]
   - Fixes HTML pages [Erik Duijs/Gollum]
   - Fixes release package with roms directory [Gollum]
   - Fixes compatibility tests [Erik Duijs]
   - Fixes source package compilation [Arnon Cardoso]

   CottAGE 0.01 - 07/05/2002

   - [Bw8080] Fixes sicv, sisv, sisv2, sitv [Gollum]
   - [Bw8080] Resync some subdrivers with MAME 0.58s [Gollum]
   - Redo some compatibility tests [Gollum]
   - Improve HTML pages [Gollum]

   CottAGE 0.00 - UNRELEASED

   - All CottAGE design [Erik Duijs]
   - JEF library [Erik Duijs]
   - All drivers work [Erik Duijs]
   - Drivers fixes [Gollum]
   - Romloader fixes [Gollum]


How to compile (MsDos/Windows):
------------------------------

   Unzip the cottage-sources.zip file in a directory.
   Launch makejef to build the Jef (Java Emulation Framework) library.
   Launch makecot to build CottAGE.

   You must have a working JDK in your path.


Usage and Distribution License:
------------------------------

   CottAGE is heavily based on MAME (a portable Multiple Arcade Machine Emulator).
   You can see it as a java port but not exactly.
   We use a similar license (the original MAME license is included).

I. Purpose:
----------
   CottAGE is strictly a non-profit project. Its main purpose is to be a reference
   to the inner workings of the emulated arcade machines. This is done for
   educational purposes and to prevent many historical games from sinking into
   oblivion once the hardware they run on stops working. Of course to preserve
   the games, you must also be able to actually play them; you can consider
   that a nice side effect.
   It is not our intention to infringe on any copyrights or patents on the
   original games. All of CottAGE's source code is either our own or freely
   available. To operate, the emulator requires images of the original ROMs
   from the arcade machines, which must be provided by the user. No portion of
   the original ROM codes are included in the executable. The only exception is
   for the Official site that allows users to try several ROMs online but we
   strongly discourage users to download these ROMs by other means.

II. Cost:
--------
   CottAGE is free. Its source code is free. Selling either is not allowed.

III. ROM Images:
---------------
   ROM images are copyrighted material. Most of them cannot be distributed
   freely. Distribution of CottAGE on the same physical medium as illegal copies
   of ROM images is strictly forbidden.
   You are not allowed to distribute CottAGE in any form if you sell, advertise,
   or publicize illegal CD-ROMs or other media containing ROM images. This
   restriction applies even if you don't make money, directly or indirectly,
   from those activities. You are allowed to make ROMs and CottAGE available for
   download on the same website, but only if you warn users about the ROMs's
   copyright status, and make it clear that users must not download ROMs unless
   they are legally entitled to do so.

IV. Source Code Distribution:
----------------------------
   If you distribute the jar file (java classes) version of CottAGE, you should also
   distribute the source code. If you can't do that, you must provide a link
   to a site where the source can be obtained.

V. Distribution Integrity:
-------------------------
   This chapter applies to the official CottAGE distribution. See below for
   limitations on the distribution of derivative works.
   CottAGE must be distributed only in the original archives. You are not allowed
   to distribute a modified version, nor to remove and/or add files to the
   archive.

VI. Reuse of Source Code:
------------------------
   The source code cannot be used in a commercial product without the written
   authorization of the authors. Use in non-commercial products is allowed, and
   indeed encouraged. If you use portions of the CottAGE source code in your
   program, however, you must make the full source code freely available as
   well.
   Usage of the _information_ contained in the source code is free for any use.

VII. Derivative Works:
---------------------
   Derivative works are allowed, provided their source code is freely
   available. However, these works are discouraged. MAME is a continuously-
   -evolving project while CottAGE try to maintain the same level of compatibility
   and features. It is in your best interests to submit your contributions
   (drivers or new code for the Jef library) to the CottAGE development team,
   so they may be integrated into the main distribution.


How to Contact Us
-----------------

The official CottAGE homepage is http://cottage.emuunlim.com/
You can always find the latest release there as well as a page
to try online some ROMs.


Acknowledgments
---------------

Huge thanks to the whole MAME team for their incredible work.
Thanks to all members of the Java-Emu Team for help, fixes and testing.
