=============================================================================

                               -- SetCleaner --

                  Copyright (C) 1998-2004 Simon Stanley Sitzia

=============================================================================

  [Solaris version]

-----------------------------------------------------------------------------
1. Legal Notes
-----------------------------------------------------------------------------
1) SetCleaner is freeware
2) If you use SetCleaner, you use it at your own risk!
3) You cannot distribute modified versions of this package:
   this means you cannot add, modify and/or remove any file to this
   distribution

-----------------------------------------------------------------------------
2. Overview
-----------------------------------------------------------------------------
  SetCleaner is a freeware arcade emulator utility for Xmame.
  Its main features are:

    (1) Gameset Repacking and Cleaning
    =========================================================================
    Using this feature, you can repack your zips applying the
    maximum compression available. It can delete useless files and
    fix those files which report a wrong length. It can delete
    automatically incorrect or unknown Gamesets. Then you can
    decide to remove all the Clone games or only those you already
    have the Original game. Note that merging isn't supported yet.
    A logfile can be generated to keep track of all the actions
    taken by the program.

    (2) Emulator and Gameset Information
    =========================================================================
    It shows detailed info about installed emulators and supported
    games (you can filter your search). Choosing a game it will
    show related info. Now you can select a game to view in which
    emulator it is supported.

    (3) Missing Games List
    =========================================================================
    It can generate the list of all the Gamesets not found (you
    can include/exclude NeoGeo games as well as clone games).

    (4) Front-End
    =========================================================================
    Now it has a small front-end which let you run games using
    emulator's current settings.

    (5) Sample Conversion
    =========================================================================
    It converts your older .SAM samples to .WAV (and vice versa).

-----------------------------------------------------------------------------
3. Requirements
-----------------------------------------------------------------------------

  Libraries
  ==========
    You need GTK and zlib installed on your system
    in order to run SetCleaner.

  Emulators 
  ==========
    You need at least one of the following
    X based emulator:

    Emulator    Minimum version required(*)
    -----------------------------------------
    Xmame       0.34 BETA 1
    -----------------------------------------
    (*) previous versions may not work
    --
    You can always find the latest releases here:
      Xmame  http://x.mame.net

  Zip Programs
  =============
    You need one of the following set of zip
    programs (required only for Cleaning) :
    -----------------------------------------
    (1) zip (v2.2) and unzip (v5.40)
    --
    You can get Zip/UnZip at Info-ZIP's web site:
      http://www.info-zip.org/pub/infozip

    {
      ... and (sorry, not yet supported)
          in the next releases:
      --
      (2) bzip2 (v0.9.0c) and tar (v1.13)
          or
      (3) gzip (v1.2.4) and tar (v1.13)
    }

-----------------------------------------------------------------------------
4. Progress
-----------------------------------------------------------------------------

  Current Release
  ================
    Version   : 2.2.0
    Date      : Jan 15, 2004
    Platforms : UN*X, Windows

  What's New
  ===========
    - First version

  History
  ========
    See HISTORY

-----------------------------------------------------------------------------
5. Usage
-----------------------------------------------------------------------------
  NOTE: Remember, it's strongly recommended to backup your Gamesets before
        running SetCleaner.
  NOTE: Currently cleaning is supported only for M.A.M.E.
  NOTE: Merging isn't supported yet.
  HINT: Use bzip2: it will speed up the cleaning,
        keeping compression rate the best available.

  Cleaning
  =========
    [NOTE] MAME and zip programs must be enabled.

    To clean Gamesets follow these steps:
    1) "File -> Preferences"
        Check all settings. You need to select zip programs in order to
        enable Cleaning. Also MAME must be enabled. If you're still
        evaluating SetCleaner (or just having trouble) I suggest you keep
        enabled both complete LogFile and TestMode (using this option all
        action will be simulated), otherwise remember to backup manually your
        Gamesets.
    2) "File -> Detect EMUs"
        During this step the program gathers information about your emulators
        version as well as supported games. Make sure you enabled at least
        one emulator in the settings. If this process hangs you can stop it.
    3) "Utils -> Clean -> Romsets"
        Now you can start Gameset cleaning, provided you can stop (or abort)
        this process at any time.

  Other services provided by SetCleaner:
  =======================================
    (#) "Info -> Emulators"
        Shows information about your emus version and some general stats
        about all supported games. You can choose an emulator.
    (#) "Info -> Supported Games"
        Shows a detailed card about games selected from the list. You can
        filter your search using the available filters. Clicking on "Extra
        Info" (or just double-clicking on the gameset name), will show a
        detailed card of selected game. You can choose an emulator.
    (#) "Info -> Game Query"
        Shows if the selected game is emulated. If yes, it shows the list of
        emulators in which it is supported.
    (#) "Play -> Tiny Front-End"
        TFE lets you run games using your current emu settings. You can
        choose an emulator.
    (#) "Utils -> Create Available/Missing Game List"
        Generate list of gamesets not found to file "SC.LST".
        [NOTE] MAME must be enabled
    (#) "Utils -> Sample Converter"
        Insert the filename of the sample(.SAM) to convert (to .WAV).

  Preferences
  ============
    You can change setting using menu Preferences. Here is a short
    description for each option:
    
    =======
    General
    =======
    > Game Selection Group:
        Select the group of files to be considered during the process.
        If you want to scan only some Gamesets, you can select single
        Gamesets as well as groups of gamesets using wildcards (i.e.
        "sc inv*" will optimise those gamesets whose names match "inv*").
    > Log Type:
        Type of log to be generated after Cleaning. By default the log is
        saved to file "SC.LOG".
      - None
          Don't generate log.
      - Short
          Generate a short log which has only a summary section.
      - Complete
          (Recommended) This log is very useful to keep track of the actions
          taken by the program.
    [Security]
        These options are provided for a better control during the Cleaning.
      > Test Mode:
          Enable test-mode. This option disables file and set
          fixing/deleting. Use this one if you want to evaluate the program.
      > User Prompt:
          Prompt user for action before fixing/deleting files or sets.
    > Enable .dat creation:
        Use .dat files instead of detecting the emulators directly. Using
        .dat files will speed up the detection step but the .dat size can be
        very large.

    =====
    Xmame
    =====
    > Enable support:
      Enables full MAME support. Note that if this option is disabled the
      Cleaning functionality will be off.
    > Main path:
      Specify path to your MAME dir. This dir must contain a valid MAME.EXE
      executable. The path can be relative or absolute. Use the "<" button
      for browsing.
    > Other paths:
      Specify Roms/Samples/Artwork paths.
    - Get paths from xmamerc
        The program imports all paths directly from the xmamerc located in
        the dir specified by "Main path"
    - Specify paths manually
        Specify all paths manually. Multiple paths must be separated by
        colons.
      > Roms:
          Specify paths to the dir where are located your zipped Romsets.
          You can specify only a directory. All paths can be relative or
          absolute.
      > Samples:
          Specify paths to the dir where are located your zipped Samplesets.
          You can specify only a directory. All paths can be relative or
          absolute.
      > Artwork:
          Specify paths to the dir where are located your Backdrops.
          You can specify only a directory. All paths can be relative or
          absolute.
      > Import paths from xmamerc now
          When clicked it copies all the paths from xmamerc to the current
          ones.

    ============
    Zip Programs
    ============
    > Type:
        Select the programs you want SetCleaner to use for compressing and
        uncompressing zips.
      - None
          Don't use zip programs.
          Note: this disables Cleaning.
      - Zip/UnZip (Info-ZIP)
          Uses Info-ZIP's programs.
      - PKZIP/PKUNZIP (PKWARE)
          Uses PKWARE's programs.
    > Path:
        Specify path to your zip programs dir. This dir must contain valid
        executables (for further info see the "Requirements" section). The
        path can be relative or absolute. Use the "<" button for browsing.

    ==========
    Games List
    ==========
    [Available/Missing Games List]
        Options for generating Missing Games List. The list will be generated to
        file "SC.LST"
      > Include Clones:
          Include clones in list.
      > Include NeoGeo:
          Include NeoGeo games in list.

    =======
    Cleaner
    =======
    > Repack:
        This repacks zips using the maximum compression rate available.
    [Internal Set Cleaning]
        Some sets could be not perfect so enabling "Repack" will let
        SetCleaner rebuild these sets optimising them.
      > Remove useless files:
          Remove redundant files.
          Note: Some files, although don't needed now, could be needed in
          future emulator versions.
      > Fix files length:
          Cut roms if their length is wrong.
    > Verify:
        Verify gamesets validity.
        Note: this will mark as wrong those sets whose roms have an incorrect
        checksum or whose length can't be fixed.
    > Delete:
        Here you can set rules for deleting some specific sets.
      > Clone Games:
          Using this option you can get rid of clones and duplicated games.
        - None:
            Don't delete clones.
        - Redundant:
            Delete clones only if the original game is found.
        - All:
            Delete all clones.
      > Unknown Sets:
          Delete unsupported archives.
      > Incorrect Sets:
          Delete corrupted archives.
      > Unneeded Samplesets:
          Delete obsolete samplesets.

------------------------------------------------------------------
6. Contact
------------------------------------------------------------------
The SetCleaner homepage is located at:
  http://www.mameworld.net/setcleaner
  Official mirrors are:
    --Add here-- ;)

Feel free to send any comment, suggestion or bug-report to:
sitzia@tin.it

------------------------------------------------------------------
7. Thanks
------------------------------------------------------------------
SetCleaner for SPARC is compiled using GNU gcc
SetCleaner for Linux is compiled using GNU gcc
SetCleaner for Windows is compiled using lcc-win32
SetCleaner for DOS was compiled using DJGPP

Thanks for their great software go to:
  Jacob Navia                     - lcc-win32
  DJ Delorie                      - DJGPP
  Jean-loup Gailly and Mark Adler - zlib
  Gilles Vollant                  - Zip/UnZip for zlib
  Jordan Russell                  - Inno Setup

And of course thanks for their hard work go to:
  Nicola Salmoria and the MAME Team - M.A.M.E.
  Allard Van Der Bas,               - Xmame
  Dick the Ridder,
  Juan Antonio Martinez,
  Hans de Goede and Lawrence Gold
  Antiriad & Raine Team             - Raine
  Bloodlust Software                - Callus
  Li Jih Hwa & Thierry Lescot       - System16
  Anders Nilsson & Janne Korpela    - RAGE
  Nao                               - M72
  Roberto Ventura                   - JFF

==================================================================
Zip and UnZip are copyrighted by Info-ZIP group
