================================================================================
Known Bugs
================================================================================

Contents:

Chameleon FPGA Core
Menu System
Test Procedure

================================================================================
Chameleon FPGA Core
================================================================================

- REU has some issues (bugs). Some programs work, others crash. No solution for
  this yet.
  - "blureu" does not work

- 1541 emulation is still incomplete so you can expect load-errors with some of
  the speed-loaders out there. (this has improved a lot in beta6, but may still
  not be perfect)
  - jiffy dos seems to have problems

- SID emulation is still incomplete (Envelope Generator, Filters, Noise Generator)

> Found another problem title with the same bug, ie. only the first fraction
> of a second, and then no samples along the song. Turbo Outrun:
> http://noname.c64.org/csdb/release/?id=41990
> Maybe this is helpful, Blaa - The Demo features the same song, and there
> the samples play like they should:
> http://noname.c64.org/csdb/release/?id=32307 load "2-finished! blaa".
> Previous part doesn't seem to work on Chameleon.

- VIC-II
  - lightpen trigger is not emulated correctly

- Keyboard Matrix emulation is incomplete
  - Buck Rogers.crt: Joy emulation up and right on the keypad does not work.
    Only left, down and fire works. CDTV remote works fine too.
  - Frogger.crt: F1 does not work on the PS/2 keyboard, but does on the C64.
    Also pressing 1 on the CDTV remote does not work. Joystick emulation in this
    game works fine on PS/2 keyboard and also on CDTV here.
  - Pitfall II.crt: same as in Frogger.

================================================================================
Menu System
================================================================================

MMC/SD Card compatibility:
--------------------------

- some lowlevel routines are still blocking and might hang at initializing
  certain cards

------------------------------------------------------------------------------
File Browser:
------------------------------------------------------------------------------

------------------------------------------------------------------------------
PRG Launcher
------------------------------------------------------------------------------

- generally all files with a load adress >$03ff can be loaded and run. files
  which load below $0400 (often to overload pointers for autostart) are
  unsupported for now.
- programs will be started in a standard reset environment for maximum
  compatibility

- PRG Files which do not work for unknown reason:

Barry McGuigan World Championshop Boxing (1985)(Sportsware Productions)[cr Mr. Z][a].prg
Amazon Warrior (1985)(Geoff Sumner)[h Florasoft].prg
1985 - The Day After (1984)(Mastertronic)[h Crackman].prg

- PRG Files which load below $0400, and thus are unsupported:

Buggy Boy (1987)(Elite)[cr The Wild Boys].prg   - loads to $0302 (autostart)

- PRG Files with bugs:

A__AP___A (2002)(Ice Team).prg - sometimes graphics are corrupted. this also
                                 happens when running it by other means, so
                                 its not bug

------------------------------------------------------------------------------
G64 Mounter
------------------------------------------------------------------------------

due to the still incomplete 1541 emulation, mounting g64 files has several
limitations:

- track length is fixed, so non standard track lengths will not work
- half tracks are not supported
- non standard speedzones are not supported

------------------------------------------------------------------------------
SID Player
------------------------------------------------------------------------------

- PSID Tunes which require Compute's Sidplayer (MUS) are not supported yet

            <examples wanted>

  -=> this might get fixed depending on demand, possibly a seperate external
      .mus plugin would be a better idea ?

- PSID Tunes which use playsid specific features (usually indicated by a _PSID
  appended to the filename), such as the playsid sample voice, can not be
  played correctly. THIS IS NOT A BUG and it can not be fixed. use the RSID
  counterpart instead.

- Tunes that use memory from $0400 to $07e8 and/or load below $07e8 are not
  handled correctly yet, and the player will reject them.

  examples:
            /MUSICIANS/B/Bjerregaard_Johannes/Fruitbank.sid
            /MUSICIANS/B/Barrett_Steve/Professional_Ski_Simulator.sid

            <more examples wanted>

            ~  8 tunes with load=$02xx
            ~ 13 tunes with load=$03xx
            ~ 32 tunes with load=$04xx
            ~  7 tunes with load=$05xx
            ~  8 tunes with load=$06xx
            ~ 39 tunes with load=$07xx

  -=> THIS WILL GET FIXED IN A FUTURE VERSION

- RSID Tunes which are regular BASIC programs (load=$0801,init=0,play=0) are
  not handled correctly right now and starting them might result in an error.

  examples: all tunes in DEMOS/COMMODORE

            <more examples wanted>

            ~278 tunes with load=$0801

  -=> THIS WILL GET FIXED IN A FUTURE VERSION

  workaround: if you get an error, type "poke 780,<subtune>:run"

- RSID Tunes which claim all available resources (IRQ, NMI and mainloop) can
  not be stopped by the player. THIS IS NOT A BUG and it can not be fixed,
  other than by modifying the ripped sid file (to either chain the original
  NMI/IRQ correctly, or to not use busy looping). Use the RESET button to go
  back to the menu!

  examples:
            /MUSICIANS/T/Tel_Jeroen/Hard_Rock.sid

            <more examples wanted>

- Subtunes in RSID tunes which claim all resources can not be changed after
  having started the tune. THIS IS NOT A BUG and it can not be fixed. (a way to
  select the subtune first and then start playing may be added in the future)

            <examples wanted>

- other tunes that do not work for unknown reasons:

            /GAMES/G-L/Galaxions.sid   (crash)
            /GAMES/G-L/Game-Master.sid ("plays", but no audio)
            /GAMES/S-Z/Zodia.sid       ("plays", but no audio)
            Wizball.sid (crash)

            <more examples wanted>

- last not least, some tunes don't play correctly simply because they are bad
  rips. common problems are SEI or CLI somewhere, or writes to $01 where they
  shouldnt be.

when reporting tunes that do not work, please make sure the rip itself is ok,
a good way to do that is converting it to a prg file with PSID64 and see if it
works (http://sourceforge.net/projects/psid64/). please report tunes that do
not play with psid64 to the hvsc team as well as to us.

--------------------------------------------------------------------------------
CRT Launcher
--------------------------------------------------------------------------------

- files which have inconsistant info in the CRT and CHIP headers might not
  work (for example when the CRT header indicates a CBM80/8K cartridge, but
  the CHIP header has a loadadress of $e000 - which indicates an ultimax
  cartridge - the image will NOT work). THIS IS NOT A BUG and will not get
  fixed. Fix the CRT files instead!

- easyflash currently doesnt work correctly

================================================================================
Test Procedure
================================================================================

this is a list of things for people who want to systematically test various
features. it is here as a remainder because often things are overlooked and
some bugs just never happen in someones daily routine.

general:
--------

- due to the ongoing development of the user interface and keyboard shortcuts
  there might be inconsistancies between on-screen text and actually used keys.
  please report such occurances so they can be fixed.

MMC/SD Card compatibility:
--------------------------

- insert your sd/mmc card into the chameleon and press reset. now go to system
  info in the menu. if the c64 hangs now, that means the card can not be properly
  initialized. in such a case we would like to know the exact type,size,brand
  etc of the card you are using.
- system info should correctly show the type, filesystem etc of the card
- enter the filebrowser. it should correctly show the name of the card and also
  show the two directory panels with the list of files in your cards root directory.

- generally if the above works, we would like to hear about any other problems
  that only occur with a specific card

non volatile user options:
--------------------------

- change some options, save them, powercycle the chameleon and check if the changes
  have been saved (and loaded) correctly.

upgrading the core:
-------------------

- upgrade using chaco and/or chacocmd

Filebrowser:
------------

- browsing through individual directories on either panel should work. please
  read "readme-menu.txt" for a list of keys that you can try :)


Plugins:
--------

- plugins should cleanly exit to the filebrowser
- pressing "freeze" when a plugin is active should return to the filebrowser

- CRT launcher: the CRT launcher should generelly launch any of the supported
  cartridge types.
  if you find a cart that doesnt work, please read readme-menu.txt and the details
  above and report the non working image if you think it meets the listed
  requirements and should work.

- PRG launcher: generally most onefile programs should work. incase you find
  one that does not, please read the details above and report the non working
  program if you think that it meets the requirements of the prg launcher and
  should work.

- SID player: this is currently the most limited plugin, again please read
  the details above, many (if not most) tunes will play fine, with the
  exceptions listed. please report only non working tunes from the latest
  hvsc which meet the requirements and limitations of the sid player.
