                            SNEmul release 0.9
                          (c) 1997-99 by Archeide and v0x

  1. DISCLAIMER

  WE (Archeide and v0x) DISCLAIM ALL WARRANTIES WITH REGARD TO THIS
  SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
  FITNESS FOR A CERTAIN PURPOSE; IN NO EVENT SHALL WE BE LIABLE FOR ANY
  SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER
  RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF
  CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
  CONNECTION WITH THE USE OF THIS SOFTWARE.  Short: use at your own risk.

  2. Introduction

  Welcome to the wonderful world of emulation. SNEmul is a Super Nintendo
  emulator. That means that this software is (in theory ;) able to run
  rom dumps of SNES softwares on your PC. As SNEmul is in a middle stage of
  development, don't expect all your roms running with it. The reason we
  make this release is to have bugs/failures/success reports. If you want
  to help, then experience it, and give us a feedback.

  Our first goal was to make a solid 65c816 cpu emulation. Sound is 
  implemented but still lacks some DSP fx like echo-fx. Tranparence effects
  are also implemented although they need some optimizations. In the future,
  perfect sound and faster emulation will be supported. We are working hard
  on SNEmul and it becomes more stable and faster weeks after weeks, so expect
  it to reach the achievement of leading emulators very soon.

  3. Installation and usage

  For the DOS version, Unzip all the files in the directory of your choise
  and just type "SNEMUL romfile" to start. You'll need to start SNEmul in
  its own directory, ortherwise it will crash because of missing files.

  To install the Linux version, just un-gzip-tar the archive in your
  home directory and run it as root (SNEmul needs to have superuser
  privileges to switch graphic modes). NOTE: you don't need anymore the
  liblge.so file since it is now staticaly linked into the binary.

  4. What is implemented

  - 65816 CPU (a few bugs remain, and 6502 emulation is not supported)
  - SRAM support
  - LoROM/HiROM support
  - Line by line graphics engine
  - Graphics Modes 0,1,2,3,4,5,6,7 
  - Mode 7 effects
  - 512 horizontal resolution with Mode 5
  - 8x8, 16x16 tiles (priority per tile is implemented)
  - 32x32, 64x32, 32x64, 64x64 screen modes
  - 8x8, 16x16, 32x32, 64x64 sprites
  - Window clipping(uncomplete)
  - BG priorities
  - BACK color
  - Sprite priorities (still doesn't work perfectly)
  - Mosaic effects
  - Full DMA support
  - HDMA support(uncomplete)
  - HIRQ/VIRQ/NMI interrupts
  - PAL/NTSC detection
  - SPC700 CPU (some bugs remain)
  - Sound DSP (ADSR/GAIN effects implemented)
  - Super FX(still buggy)
  - DSP1

for 16 bits mode only :
  - Palette alteration between scanlines
  - Fixed color Add/sub for BG/sprites/BACK (may not work in all case)
  - Subscren Add/sub for BG/sprites/BACK
  - Some 1/2 transparence effects are implemented
  - Window color clipping is also implemented for a few effects

other interesting features :

  - Snapshots(State save) support
  - MOD ripper THAT *MAY* WORK with some MOD players like UMP, MOD4WIN, AMP
  - Debugger(very primitive for the moment)
  - Tiles/Sprites editor(stored in the VRAM/buffer, not in ROM - sorry)
  - Memory, Palette viewer
  - Cheats editor, Cheats search(need to be improved)
  - can read zipped ROMs.(only one ROM by zip file)

  5. Misc

  We, Archeide and v0x, expect feedback from you. Send us a mail even if you
  likes/dislikes it; it shows us that people are trying our emulator, and
  we don't work only for us...

  Mail at: archeide@yahoo.com or snemul@free.fr

  Web site is: http://snemul.free.fr/

  We hope you would have as much fun using SNEmul as we have ourself making
  it.

  6. FAQ

  - Why the sound doesn't work ?

    Try to select your sound card in the sound dialog.
    If you use a 100% compatible Sound Blaster sound card,
    check if your "BLASTER" variable is correctly set.

    If you use an Ensoniq Soundscape PCI, use another emulator or
    select the very-old (and obsolete) "other sound engine".

  - Why SNEmul is so slow ?

    SNEmul is main in C and C++. And some games needs a lot of CPU time
    (like SuperFX games). 
    * Your computer is too slow. Solution : change your computer.
    * You run it under Windows. Solution : try it under pure DOS.
    * SNEmul have a problem with your computer and/or the game.
      Solution : mail me(archeide@yahoo.com) or use ZSNES, SNES9X, SNEeSe,
      NLKE or whatever emulator you want.

  - How can i speed up SNEmul ?

    - hide the GUI (the GUI is slow for the moment)
    - use VESA 2 driver(if you use 16 bits mode)
    - enable scanlines (if you use high res video modes)
    - enable the speed hacks(check the SNEMUL.CFG file to see if they
      are enabled)
    - enable 'FastSound' option and disable Stereo sound
    - use 256 colors mode and low res video modes(like 256x256)
    - disable the sound
    - disable ADSR/GAIN sound effects
    - hide some BG/Sprites layers
    - run SNEmul in pure DOS mode.

  - How do I use the SNEmul cheat tools ?

    I don't have time to explain you. 

  7. Keyboard

  Keys used in the GUI:
  - CTRL+TAB       : select next window
  - CTRL+SHIFT+TAB : select previous window
  - TAB            : select next object
  - SHIFT+TAB      : select previous object
  - SPACE          : press button/select radio button or check box...
  - ENTER          : select the game in the ROM selector
  - UP/DOWN        : select radio button in a group
                   : select other entry in the lists
  - PGUP/PGDN      : select a entry in the next/previous page

  Joypad emulation keys can only be used when the game window
  is selected(use CTRL+TAB) or when you are in Full Screen mode :
  - Cursor keys : joypad direction
  - A, Z        : LEFT & RIGHT buttons
  - S, X        : X & Y buttons
  - D, C        : A & B buttons
  - SPACE       : START button
  - TAB         : SELECT button

  Keys which can be used in the GUI and in the Full Screen mode :
  - ESC         : switch Full screen / GUI

  (don't forget that if you want to play games, you should better use
   Full Screen mode because it's MUCH faster =)

  - 1-5         : toggle BG1-4,sprites
  - 0           : toggle HDMA
  - P           : save screen shot 'SNEMUL.PCX'
  - K + digit   : save snapshot
  - L + digit   : load snapshot

  - ALT         : when you are in full screen mode, return to the GUI

  Keys which can only be used in the GUI :
  (but you can keep the alt key pressed if you have used it to return to the GUI)
  - ALT+L       : open the file selector
  - ALT+S       : open the snapshot selector
  - ALT+V       : open the video mode dialog
  - ALT+F       : when you are in the GUI, switch game display in the
                  background/window

  7. Credits

  Shawn Hargreaves & co. - Allegro 3.9.XX(WIP) libray

  The Teach        - Thanks for the great help
  Trepalium        - The TrepSNES sources helped us a lot...
  Y0shi            - Thanks for all your docs and your support...
  (and all the other guys who made SNES docs)
  Pan/ANTHROX      - They made the MODE 7 demo
  zsKnight         - Thanks for the great help
  Lestat           - Thanks for your help
  ZoOp             - Thanks for LoROM/HiROM informations, and beta testing
  Lord ESNES       - Thanks for your mails

  Special credits to :
  ------------------
  Jerremy Koot, Gary Handerson, Lestat, _Demo_... and all the other SNES9X
  contributors.
  The SNES9X sources have helped and will help us a lot.

  Greets and good luck for all the other authors of SNES emulator:
  ZSNES team, SNES9X team, SNEeSe author, NLKE team,  etc.

