Nexus Patcher v1.9.0
=====================

This folder has two programs. They share the same receipts/ folder.

  NexusPatcher.exe          The window app. Start here.
  nexus-eboot-patcher.exe   The command-line tool (same engine, for scripts).

SHA-256 of NexusPatcher.exe:        11fe05858666d91b0a19605e9cceee577405a159c6f918d21bb8d61e8aece84f
SHA-256 of nexus-eboot-patcher.exe: c63c6552cd8150689e5bff6a83ba44713acf7b62313f5c88f002d08ddf4219f0

Keep the whole folder together. Do not move one exe out of it.


START
-----
Double-click NexusPatcher.exe. It opens in its own window (Microsoft Edge in
app mode; without Edge it opens in your default browser). Close the window to
quit. Only one copy can run at a time.

The window has two modes:

  Auto Mode    Patches the game on your PS3 over the network.
  EBOOT file   Patches an EBOOT.BIN file on this PC (for RPCS3, or to copy
               to the PS3 yourself).


AUTO MODE (PS3)
---------------
Before you start:
  - Install the game and its latest update on the PS3.
  - Start HEN, then turn on the FTP server in webMAN MOD.
  - Put the PC and the PS3 on the same network.
  - Close the game on the PS3.

1. Pick the game in the list. The region (USA, Europe, Asia) is on each row.
2. Type the PS3 IP address. On the PS3: Settings > Network Settings >
   Settings and Connection Status List.
3. Click Start. The tool saves your original file on this PC first.
4. Choose your patches (see PATCHES below) and click Continue.
5. Confirm the install. The tool checks the new file on the PS3 after the
   transfer. If the install fails, it puts your original back and checks it.

Start HEN after each PS3 restart, then start the game from the XMB.

Remove the patches: open Backups, pick the game, click Restore. The tool puts
your saved original back and checks it. To choose different patches, restore
the original first, then patch again.

Keep the receipts/ folder. It holds your saved originals. Without them the
tool cannot restore your game.


EBOOT FILE MODE (PC, RPCS3)
---------------------------
1. Click EBOOT file and choose your original EBOOT.BIN (or drag it onto the
   window).
2. The tool checks the file and shows the game, region and version.
3. Choose your patches and where you play: PS3 or RPCS3.
4. The patched file goes to output/<run>/EBOOT.BIN next to your file. A copy of
   your original goes to backup/<run>/. Your file stays where it was.


PATCHES
-------
Full patch: the patches the game needs to go online with the community
servers. They are always installed together. You cannot remove a part of them.

Optional patches: extras, for example removing the Online Pass requirement.
They are never selected for you. Tick the ones you want.

Some games have only optional patches. Tick at least one to continue.


SUPPORTED GAMES AND VERSIONS
----------------------------
The tool checks your file. A version that is not on this list is refused and
nothing is changed.

  Lucha Libre AAA: Heroes of the Ring  BLUS30640 (USA)     1.00, 01.01
  Need for Speed Rivals                BLUS31201 (USA)     01.00, 01.03
                                       BLES01894 (Europe)  01.03
                                       BLAS50602 (Asia)    01.03
  TEKKEN REVOLUTION                    NPUB31250 (USA)     01.00, 01.05
  WWE '12                              BLUS30841 (USA)     01.00, 01.02
                                       BLES01439 (Europe)  01.02
  WWE '13                              BLUS31015 (USA)     01.00, 01.01
                                       BLES01699 (Europe)  01.01
  WWE 2K14                             BLUS31277 (USA)     01.00, 01.03
                                       BLES01937 (Europe)  01.03
  WWE SmackDown vs. Raw 2011           BLUS30621 (USA)     01.00, 01.01
                                       BLES01045 (Europe)  01.00, 01.01

On a PS3, the game runs the update EBOOT (the newest version in each row).
The 01.00 disc EBOOTs are mainly for RPCS3 (EBOOT file mode).

WWE '12, '13 and 2K14: these have the optional Online Pass patch only.

TEKKEN REVOLUTION: the file on the PS3 is protected. Auto Mode saves your
original but cannot patch it. Use EBOOT file mode with the decrypted .elf from
RPCS3. Version 01.05 gets the community server setup with connection support.


EXTRA PATCH FILES
-----------------
The patches that ship with this release are used without a question. If you
add another patch file (in recipes/ or next to the exe), the tool asks first:
"Use this extra patch file?". Click Do not use unless you trust where it came from.
A patch file changes your game executable.


IF SOMETHING GOES WRONG
-----------------------
The tool shows a short message with the cause and what to do next. Common ones:
  No answer from <IP>         Check the IP address and that the PS3 is on.
  FTP is off on your PS3      Start HEN, then turn on FTP in webMAN MOD.
  Not supported yet           Your game version is not on the list above.
  Already patched             Restore the original first (Backups).
  Nexus Patcher is already open   Use the window that is open, or close it.

Nothing is written to the PS3 before you confirm the install.

Report a problem: say what you did and what the tool showed, and attach
  - the log of the window app: %LOCALAPPDATA%\NexusPatcherGUI\gui.log
  - the run folder in receipts\ (for Auto Mode: receipts\<game ID>\console_deploy\<run>\)

The window app is new in this version. Installing to a PS3 through it, and the
Online Pass patches in game, are not yet tested on real hardware. If you have a
problem, the previous version (v1.8.1) still works as before.


COMMAND-LINE TOOL (nexus-eboot-patcher.exe)
-------------------------------------------
The same engine, the same patch rule and the same messages as the window app,
in a console window. For advanced users and scripts.
  Menu:             1) EBOOT file  2) Auto Mode  3) Restore the original
  Patch a file:     drag EBOOT.BIN onto nexus-eboot-patcher.exe
  Auto Mode:        nexus-eboot-patcher.exe --auto --console <PS3 IP> --title <ID>
  Restore original: nexus-eboot-patcher.exe --restore --console <PS3 IP> --title <ID>
  Optional patch:   add --optional <ID> (the IDs are in --list-features)
  List patches:     nexus-eboot-patcher.exe --list-features <EBOOT.BIN>
  Check recipes:    nexus-eboot-patcher.exe --check-recipes
The full patch is always installed whole. --yes installs only the full patch and
never selects an optional patch.
For an extra patch file it asks the same question and waits for [y/N]: type y
to use it; Enter or n means no. For a script (--yes or no console), add
--trust-recipe <sha256> for each extra patch file you accept. --yes alone never
trusts an extra file.


MORE
----
docs/RELEASE_v1.9.0.md   What changed in this release and how it was tested.
docs/RECIPE_PATCH_TYPES.md     Full and optional patches (for recipe authors).
docs/AI_RECIPE_RUNBOOK.md      How to write a recipe; template and schema in docs/.
docs/OBFUSCATED_BUILD.md       How the executables are built and protected.

Real-PS3 and in-game testing is still pending for some patches. See the
release notes for the current status.
