XMvsSF 3v3 + DHC  v1.1.1  -  2P  -  macOS (Apple silicon)
==========================================================================

X-Men Vs. Street Fighter with three characters per team, Delayed Hyper
Combos, snapbacks and eighteen colours per character. P1 controls the left team and P2 the right team.

WHAT YOU NEED
  - RetroArch 1.9 or newer for macOS from retroarch.com (the App Store
    version cannot load cores from outside the store).
  - Python 3.8 or newer, used once by the installer. If macOS offers to
    install the "command line developer tools" when you run it, accept.
  - Your own xmvsf.zip: X-Men Vs. Street Fighter, Europe 961004 - the parent
    set that MAME, FinalBurn Neo and Fightcade use, including xmvsf.key.
    This package contains no game data.
  - two game controllers (a keyboard works for P1).

INSTALL (once)
  1. Unzip this package anywhere and keep its folder together.
  2. Copy your xmvsf.zip into this folder.
  3. Right-click "INSTALL.command" and choose Open (the first time, macOS asks
     because the file was downloaded; click Open again). It checks your ZIP
     and writes three new files:
        roms/xmvsf6pd.zip                            your game's unchanged files
        system/standard/fbneo/patched/xmvsf6pd.zip   the changes, original screen
        system/wide/fbneo/patched/xmvsf6pd.zip       the changes, wide arena
     Your xmvsf.zip is never changed.
     Terminal alternative:  python3 xmvsf3v3_patch.py /path/to/xmvsf.zip

PLAY
  "PLAY XMvsSF 3v3 2P.command"        original screen (4:3)
  "PLAY XMvsSF 3v3 2P WIDE.command"   wide arena (16:9)
  (Right-click > Open the first time.)

  The launcher checks the files, finds RetroArch in Applications and starts
  the game in front of Terminal, with this package's core
  (cores/fbneo_xmvsf3v3_libretro.dylib) and this folder's own settings. It does not change
  your RetroArch configuration. It removes the download quarantine from this
  folder only, so RetroArch can load the core. If RetroArch is somewhere
  else, put the full path of its program
  (.../RetroArch.app/Contents/MacOS/RetroArch) on the first line of
  retroarch-path.txt in this folder.

CONTROLS
  See CONTROLS.txt. In short: MP+MK and MP+HK tag in your two reserves,
  HP+HK brings in the next living character in pick order (first, second,
  third, first...), the incoming character's Hyper motion plus MP+MK or MP+HK
  during a Hyper is a Delayed Hyper Combo (a full chain is three Hypers),
  QCF+MP+MK or QCF+MP+HK is a snapback (one level), and at character select
  nine inputs (the six buttons and the three punch-and-kick pairs) pick
  colours 1 to 9; hold Start with them for colours 10 to 18.

START FROM A FRESH BOOT
  Start a new match from a fresh boot before you load a state. States made
  with v1.0.0, with the stock game, with another core or on the other screen
  do not carry over: keep them separate, and keep your old saves backed up.

GOOD TO KNOW
  - Only the included core runs these game files, and only through the
    launchers: they load roms/xmvsf6pd.zip and switch on FinalBurn Neo's
    "Allow patched romsets", which takes the changed files from the chosen
    screen's system folder. Stock FinalBurn Neo, MAME and Fightcade cannot run
    them. Do not rename or move them.
  - The WIDE launcher uses system/wide and the 512x224 screen; the normal
    launcher uses system/standard and the original 384x224 screen. Save
    states work within the same screen only.
  - RetroArch gives controllers to players in the order it detects them
    (Settings > Input > Port 1..2 Controls to change the order).
  - Settings, saves and states for this package stay in its own config,
    saves and states folders.

TROUBLESHOOTING
  - "NOT INSTALLED: ... not the Europe 961004 revision": this release needs
    the parent set xmvsf (Europe 961004). US, Japan, Asia and Brazil clones
    have different program chips.
  - "xmvsf.key is missing": use a current MAME/FinalBurn Neo set that
    includes the CPS-2 key file.
  - "already exists and is not this release's file": move the old file it
    names (in roms or system) away, then install again.
  - RetroArch starts without the game: run the launcher again and read its
    window; it names the file or setting it could not use.

REPORTING A PROBLEM
  This is a preview. The snapback's choppy switch, reported on v1.0.0, is
  diagnosed but not changed in v1.1. Physical controllers, six people and
  the Windows launchers on Windows are still untested; on macOS, the
  two-player package has been run on one Mac.
  When you report something, give the package name, platform, both teams,
  their colours, the exact buttons (and whether you held them) and a short
  clip that starts before the input.

UNINSTALL
  Delete this folder. Nothing was installed anywhere else.

WHAT IS IN THIS PACKAGE
  README.txt, CONTROLS.txt   this guide and the control card
  cores/                     FinalBurn Neo libretro core with the XMvsSF
                             3v3 + DHC six-port board (and its .info file)
  patch/                     the patch: offsets and replacement bytes only
  xmvsf3v3_patch.py          the installer (also usable on its own)
  source/                    source for the patch, the core changes and
                             these tools
  licenses/                  FinalBurn Neo licence, notices and
                             PALETTE-CREDITS.txt (where colours 3 to 18
                             come from)
  PREVIEW_CHECKS.md          what has been checked and what is still open
  RELEASE.json, SHA256SUMS.txt   file list and checksums

This is an unaffiliated fan modification. X-Men, Marvel, Street Fighter and
Capcom names and marks belong to their owners. No game ROM data is included;
you must use your own copy of the game.
