caverns4 / patcher64plus-tool Goto Github PK

Patcher64+ Tool
Join our Discord and feel free to contact us there.
List of credits are accessible within the Patcher64+ Tool.


--- Support or visit me ---
Discord:	https://discord.gg/P22GGzz
GitHub:		https://github.com/Admentus64
Patreon:	https://www.patreon.com/Admentus
PayPal:		https://www.paypal.com/paypalme/Admentus/


--- System Requirements ---
- 64-bit
- PowerShell 5.1 or newer
- Windows 7 or newer


--- Instructions: Windows 10/11 ---
Run the launcher or right click the .ps1 file -> Run with PowerShell.


--- Instructions: Windows 7/8.1 ---
Download and install WMF 5.1 from here: https://www.microsoft.com/en-us/download/details.aspx?id=54616
- Windows 7: Win7AndW2K8R2-KB3191566-x64.zip
- Windows 8.1: Win8.1AndW2K12R2-KB3191564-x64.msu
Initiate a reboot after the installation is done. Running the launcher will now work.

Optional: After installing WMF 5.1 and rebooting the system, download and install the latest PowerShell-x.y.z-win-x64.msi from https://github.com/PowerShell/PowerShell/releases/latest and enable "Add Run with PowerShell 7 context menu" during installation. Right click the .ps1 file -> Run with PowerShell 7.


--- Rules for Posting Bug Reports / Issues ---
- Confirm issue on Project64/Mupen64Plus with GlideN64 or Dolphin, no custom Frontends which interfere with the emulation such as ModLoader64
- Always use latest build
- Expansion Pak is enabled when needed, both in WAD or emulator
- Post console log file
- Post step-by-step replication of bug
- Post used settings
- Point out which specific option or component is broken or causing conflicts of Patcher64+
- One issue at a time, keep focused
- Must use proper US Rev0 ROM
- No ROM injection or custom patches, we can't confirm sources outside of Patcher64+
- Non-supported features are NOT bugs, if it doesn't exist it likely does so for a reason
- Confirm latest working Patcher64+ version if applicable


--- Zelda 64 Options Documentation & Sources ---
- https://github.com/ShadowOne333/Zelda64-Redux-Documentation (general)
- https://github.com/DaruniasJoy/OoT-Custom-Sequences (custom music)
- https://docs.google.com/spreadsheets/d/1Ihccm8noxsfHZfN1E3Gkccov1F27WXXxl-rxOuManUk (female pronouns script)
- www.youtube.com/channel/UC3071imQKR5cEIobsFHLW9Q (voices / patches)
- www.youtube.com/user/skilarbabcock (model replacements)
- www.youtube.com/c/malonrose (model replacements)
- https://github.com/Caverns4/Custom-Game-Models (model replacements)


--- Original Redux Sources ---
- www.romhacking.net/hacks/5752 (Zelda 1)
- www.romhacking.net/hacks/5440 (Zelda 2)
- www.romhacking.net/hacks/2594 (ALttP)
- www.romhacking.net/hacks/4672 (LA DX)
- www.romhacking.net/hacks/5138 (OoT)
- www.romhacking.net/hacks/5122 (MM)
- www.romhacking.net/hacks/4963 (SM)
- https://github.com/MarocZan (OoT & MM)
- https://github.com/ShadowOne333 (multiple games)


--- WARNING ---
If you're upgrading from a previous version and are using the Files\Settings folder from the previous version, you may encounter some issues.
Removing or deleting all files from that folder and restarting fixes the issue.

Reports have been going around that the compiled .exe file for the Patcher64+ Tool is considered dangerous and a virus.
I can absolutely assure you that the code present in the .exe is the exact same code found in the source code files included with each release.
Nothing more is added, and nothing less is removed.
The .exe is generated by using PS2EXE. If you do not trust the .exe file, you can stick to using the .ps1 file instead.
As said, it uses the exact same source code, so you won't be missing any features. 



===============
=== GENERAL ===
===============

Patches ROM or Virtual Console WAD files with patches.
The Patcher64+ Tool can switch to either Wii VC or Native mode.
Wii VC mode handles VC WAD titles while Native mode handles ROM files directly.
Native mode skips most of the code used in Wii VC mode, which results in a faster patching.
Supported ROM files can be found in .NES, .SFC, .SFM, .N64, .Z64 and .V64
The Patcher64+ Tool only supports the N64, NES and SNES consoles currently.

Keep in mind that:

a) Patching Majora's Mask, Super Smash Bros., Paper Mario requires their respective modes and not Free Mode, since both VC WAD titles have applied specific compression to their ROM and Boot DOL.

b) Free Mode and Inject ROM will not work with ROMs not meant for their console mode for the Wii's Virtual Console.

c) NES titles require the console mode to be set to NES mode due to their ROM file being stored differently.



===============
=== OPTIONS ===
===============

Options included:
- Change between Native Mode (uses regular ROM files) or Wii VC mode (uses .WAD files)
- Change between Consoles
- Change Game Mode for a different set of included patches
- Patch a ROM or Wii VC WAD file with one of the included patches in their respective game mode
- Patch a ROM or Wii VC WAD file with a custom BPS/IPS/Xdelta/VCDiff/PPF3 patch file

Wii VC Mode exclusive options incude:
- Inject a custom ROM into a Wii VC WAD
- Only patch the Wii VC WAD with the chosen selected modifications
- Extract the ROM contained within the Wii VC WAD only

Popular ROM hacks for many games among others but not limited to are featured such as:
- The Legend of Zelda: Dawn & Dusk
- The Legend of Zelda: The Missing Link
- The Legend of Zelda: Master of Time
- Super Mario: Star Road
- Super Mario: The Last Impact
- Super Mario 3D Land
- OverKart 64
- Paper Mario: Hard Mode
- Super Smash Bros. Remix
- Banjo Kazooie: Cut Throat Coast
- Tag Anywhere patch for Donkey Kong 64
- Super Mario World: Invictus
- Kaizo Mario World

The following games have support for Redux which allows for many quality of life enhancements:
- The Legend of Zelda: Ocarina of Time (OoT)
- The Legend of Zelda: Majora's Mask (MM)
- The Legend of Zelda (TLoZ)
- Zelda II: The Adventure of Link (TAoL)
- The Legend of Zelda: A Link to the Past (ALttP)
- The Legend of Zelda: Link's Awakening DX (LADX)
- Super Metroid (SM)

The following games have support for Additional Options which allows you to customize the game as you want it:
- The Legend of Zelda: Ocarina of Time (OoT)
- The Legend of Zelda: Majora's Mask (MM)
- Super Mario 64 (SM64)
- Paper Mario (PM)
- Super Smash Bros. (SSB)
- Mario Kart 64 (MK64)
- Banjo-Kazooie (BK)
- Bomberman Hero (BH)
- GoldenEye 007 (GE)
- The Legend of Zelda: A Link to the Past (ALttP)
- Super Metroid (SM)
- The Legend of Zelda (TLoZ)
- Zelda II: The Adventure of Link (TAoL)
- The Legend of Zelda: Link's Awakening DX (LADX)

Some ROM Hacks for many multiple games also support Additional Options, so this feature isn't just limited to the original vanilla game.
This includes ROM hacks such Dawn & Dusk, Gold Quest, Master of Time, Paper Mario: Hard Mode, Super Mario: Star Road and more.

Ocarina of Time and Majora's Mask also have support for different languages, and includes the following:
- English (OoT, MM)
- German (OoT, MM)
- French (OoT, MM)
- Spanish (OoT, MM)
- Brazilian Portuguese (OoT, MM)
- Italian (OoT)
- Polish (OoT, MM)
- Russian (OoT, MM)
- Japanese (OoT)
- Simplified Chinese (OoT)

Redux patches aim to enhance the base experience of the game, such improved game mechanics and some other quality of life changes.
For example having items on dedicated buttons (D-Pad) for Ocarina of Time and Majora's Mask.
Options offers smaller individual changes that can be applied individually from each other, such as Widescreen support.


=============================
=== OCARINA OF TIME REDUX ===
=============================

Ocarina of Time Redux ingame toggleable features:
- 30 FPS
- D-Pad support for mapping items to (disabled, single set or dual set)
- D-Pad layout (four different layouts)
- Hide HUD (four different layouts)
- HUD layout (five different layouts)
- Inverse aim
- No idle camera reset when standing still
- Keep equipped mask when changing areas
- Tri-Swipe animation
- Damage taken multiplier
- Unequip items from the C buttons
- Unequip gear (swords, shields, tunics)
- Equip item to B button
- Toggle between previously obtained items (Fairy Ocarina, Giant's Knife, Hookshot)
- Crouch stab fix for normal damage
- Swords dealing one less point of damage
- Earn new abilities when obtaining Spiritual Stones and Medallion
- Rupee drain that drains your rupees and then your hearts over time
- Fog distance
- Inventory editor
- Infinite cheats

The following Redux features can be turned on or off during patching:
- Turning on or off the ingame options menu
- Skip cutscenes
- Run faster with the Bunny Hood
- Bombchus drop as regular item pickups
- Easier fishing
- Rupee icon color adjusts based on set wallet
- Ice Arrows have Blue Fire properties
- Show game progress in File Select
- Visual icon indicator for the Stone of Agony
- Rainbow colors
- Different colors for buttons, the rupee icons, interface, boomerang, bombchu trail and text cursors
- Other speedups and fixes

All of this can be customized like you want it to be. Turn it on or off at will.
These customizations work in combination with the regular non-Redux customizations.


=======================
=== MAJORA'S REDUX ===
======================

Majora's Redux customizable features:
- D-Pad layout (disabled, hidden, left or right)
- Faster block pushing
- Elegy of Emptiness speedup
- Disable crit wiggle (randomly move when criticially injured)
- Use Ocarina of Time when standing underwater
- Control flow of time with quick buttons
- Summon an Elegy of Emptiness statue without playing the song
- Ocarina icons based on transformed form
- 30 FPS
- HUD toggle
- Unequip items from the C buttons
- Equip items on the B button
- Change to previously obtained swords & shields
- Skip talking to the Clock Town guard when done once
- Climb everything
- Inventory editor
- Infinite cheats
- Different colors for buttons and the interface

All of this can be customized like you want it to be. Turn it on or off at will when patching.
These customizations work in combination with the regular non-Redux customizations.


====================
=== INSTRUCTIONS ===
====================

- To run this patcher, right click and select "Run with PowerShell".

- Select the current console and game in the "Current Game Mode" tab. Select "Free Game Selection" to freely inject a ROM or freely patch it with a patch file for any Wii VC WAD file you have.

- Drag and Drop your WAD file or select it with the [...] button.

- Select checkboxes in the "Virtual Console - Patch Options" tab to apply specific patches to your Wii VC WAD game. Certain patch buttons will force specific checkboxes from the "Virtual Console - Patch Options" tab

- Apply and customize Redux, Additional Options of Language if it is present for the current selected game and patch.

- The Game/Channel Title and GameID can be overwritten be checking the checkbox. If unchecked, the Game/Channel Title and GameID will follow default values as determined by the game patch buttons.

- The "Patch VC Emulator Only" options will only apply the chosen fixes from the "Virtual Console - Patch Options" tab. Custom Channel Title and GameID is also supported with this button.

- A custom ROM injection requires a ROM (.NES, .SFC, .SFM, .Z64, .N64 or .V64) to be set, either by Drag and Drop it or by selecting it with the [...] button.

- Free patching requires a patch file (.BPS, .IPS, .Xdelta, .VCDiff or .PPF3) to be set, either by Drag and Drop it or by selecting it with the [...] button.

- Press one of the game patch buttons for included premade patches. Alternatively press the Inject ROM button or Patch BPS button. Then wait for the patcher tool to finish.

- The patched ROM or WAD file is created in the same path as the original and the original is preserved.



==================================
=== PATCH OPTIONS DESCRIPTIONS ===
==================================

--- Automatic ---
- Downgrade                 Downgrade a ROM to the first revision if supported, but only works with No-Intro US ROMs.

--- Checkboxes ---
- Enable Redux              Include the Redux patch into the selected patch. This checkbox is only shown if it is supported.
- Enable Options            Allow for the customization of the ROM. This checkbox is only shown if it is supported.

--- Buttons ---
- Select Options            Additional Options in general can be fully customized in here.
- Patch Selected Option     Run the patching process.

--- Select Options ---
- Main                      Contains several options in general to customize.
- Audiovisual               Contains graphics, music and sound related options to customize.
- Difficulty                Contains difficulty-related options to customize.
- Colors                    Contains options in where HUD elements and ingame objects can be customized with different color schemes.
- Equipment                 Contains options to change the behaviour of equipable or usable items, such as ammunition.
- Cutscenes                 Contains cutscene- and skip-related options to customize, often to speed-up the flow of the game.
- Redux                     Additional Options that are require the Redux patch can be customized in here.
- Language                  Different languages can be customized in here, as well as specific options that are language-dependant.



=====================================
=== VC PATCH OPTIONS DESCRIPTIONS ===
=====================================

--- Checkboxes ---
- Remove All T64            Remove all injected custom textures by the Virtual Console in the .T64 format.
- Remove Filter             Remove the dark filter injected by the Virtual Console to display the original N64 gamma.
- Expand Memory             Expands the available RAM memory, but invalidates existing AR/Gecko codes.
- Remap D-Pad               Remap the D-Pad to their four D-Pad button directions instead of toggling the minimap.
- Remap L Button            Remap L to its actual L button (e.g. for showing the interface in SM64).
- Remap C-Down              Remap C-Down to toggle the minimap button.
- Remap Z Button            Remap Z, ZL and ZR for toggling the minimap.
- Leave D-Pad Up            Keep D-Pad for toggling the minimap.

--- Buttons ---
- Patch VC Emulator Only    Only apply the VC Patch Options to the ROM, and nothing else.
- Extract ROM Only          Only extract the ROM from the WAD and nothing else. Appears in the same folder as the WAD itself.