XMvsSF 3v3 + DHC for Fightcade  v1.1.1  -  two players
===========================================================

X-Men Vs. Street Fighter with three characters per team, Delayed Hyper
Combos, snapbacks and eighteen colours per character, built to run on Fightcade's
own FinalBurn Neo. P1 controls the left team and P2 the right team.

THIS IS A PREVIEW (candidate 53). It was tested on the source code of
Fightcade's emulator (fightcade-fbneo, commit c959501), run without a window,
with scripted inputs and with the game state saved and loaded the way GGPO
does for rollbacks. It has NOT been tested in the Fightcade client, in an
online match, or with real controllers. See NOT TESTED YET below.

WHAT YOU NEED
  - Fightcade 2 and its FinalBurn Neo emulator.
  - Your own xmvsf.zip: X-Men Vs. Street Fighter, Europe 961004 - the parent
    set that Fightcade, FinalBurn Neo and MAME use, including xmvsf.key.
    This package contains no game data.
  - Windows: nothing else. macOS or Linux: python3.
  - An opponent who installed the same build (see BUILD CODE).

INSTALL
  1. Unzip this package anywhere.
  2. Build the game file from your xmvsf.zip:
       Windows  drag xmvsf.zip onto "INSTALL (drop xmvsf.zip here).cmd"
                (or copy it into this folder and double-click that file).
                If Windows says "Windows protected your PC", click
                "More info", then "Run anyway".
       macOS    copy xmvsf.zip into this folder, double-click INSTALL.command
       Linux    ./install.sh /path/to/xmvsf.zip
     The installer checks your ZIP, writes fightcade/xmvsf.zip in this folder
     (the whole game with the changed files) and prints its build code.
     Your own xmvsf.zip is never changed.
  3. Close Fightcade's emulator. In Fightcade's ROMs folder
     (Fightcade/emulator/fbneo/ROMs) rename xmvsf.zip to xmvsf.zip.original.
  4. Copy fightcade/xmvsf.zip from this package into that ROMs folder.

BUILD CODE
  Both players must have the same build, or the match desyncs. Compare the
  build code the installer printed with your opponent's. To check the file
  that is in Fightcade's ROMs folder, give it to the installer (drag it onto
  the INSTALL file, or run the installer with its path): a ZIP that already
  is this build is only reported, with its code.

PLAYING
  - This build replaces the set named xmvsf (Europe 961004). Play in a
    Fightcade channel that uses that set; a channel for another version
    (US xmvsfu, Japan xmvsfj, ...) does not load this file.
  - Try "Test Game" in Fightcade first.
  - When the emulator starts, FinalBurn Neo reports files with a wrong CRC.
    That is expected: they are the changed files. To stop the message, in
    the emulator window choose Misc > Options > Hide ROM Warnings.
  - Your opponent must have installed this build too. Against the normal
    game the match desyncs.

GOING BACK TO THE NORMAL GAME
  In Fightcade's ROMs folder delete xmvsf.zip and rename xmvsf.zip.original
  back to xmvsf.zip. The other versions of the game (US, Japan, Asia,
  Brazil) share two of the changed files with xmvsf.zip and may fail their
  start-up check while this build is installed (not tested); put the
  original back to play them. If your xmvsf.zip was a merged set that also
  held those versions, keep the original: the built file holds only the
  Europe 961004 set.

DIFFERENCES FROM THE RETROARCH RELEASE
  - Two players only (no six-player mode).
  - The original 384x224 screen only (no wide arena).
  - No miniature portraits on the life bars; names and bars are shown.
  - The rest is the same: three-character teams, tags, Team Hyper, Variable
    Counter, Delayed Hyper Combos, snapbacks and eighteen colours.

NOT TESTED YET
  - The Fightcade client itself, on Windows, macOS (Wine) or Linux (Wine).
  - An online match: GGPO over the network. The tests saved and loaded the
    game state the way GGPO does, rolled back and re-ran frames, and found
    no difference in the game state; they did not use a network.
  - Whether Fightcade's lobby accepts a changed xmvsf.zip.
  - Ranked matches: Fightcade reads scores from the game's memory; that was
    not tested with three-character teams.
  - Real controllers.
  - Fightcade emulator versions after commit c959501.
  - A match that Fightcade starts from a saved state (savestates/xmvsf_fbneo.fs
    or xmvsf_fbneo_ranked.fs, if the client has one). Since v1.1 this build
    sets itself up on its first frame either way; that was tested by loading
    a state saved on the normal game, not in the client. If you still see
    only two fighters a side, close the emulator, move those two files out
    of the savestates folder (keep them to restore the normal game later)
    and boot again; both players should start from a fresh boot.
  - The Windows installer on Windows (Windows PowerShell 5.1, which comes
    with Windows 10 and 11). It ran under PowerShell 7 on Linux.
  - The macOS installer on a Mac. The same Python installer ran on Linux.

TROUBLESHOOTING
  - "NOT INSTALLED: ... not the Europe 961004 revision": this build needs the
    parent set xmvsf (Europe 961004), not the US, Japan, Asia or Brazil
    version.
  - "xmvsf.key is missing": use a set that includes the CPS-2 key file.
  - "This ZIP is already patched": give the installer your original ZIP
    (xmvsf.zip.original), not the built one.
  - Desync online: compare build codes. Both players need this build.

CONTROLS
  See CONTROLS.txt.

WHAT IS IN THIS PACKAGE
  README.txt, CONTROLS.txt   this guide and the control card
  INSTALL ... .cmd, INSTALL.command, install.sh   the installer for Windows,
                             macOS and Linux
  xmvsf3v3_patch.py          the installer (Python; also usable on its own)
  patch/                     the patch: offsets and replacement bytes only
  source/                    the source of the patch and of these tools
  licenses/NOTICE.txt        notice
  licenses/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. Fightcade is not involved
with it. No game ROM data is included; you must use your own copy of the
game.
