Patch Files - Revision history

Fenhl: updated GitHub link

2025-05-06T00:32:19Z

updated GitHub link

← Older revision		Revision as of 00:32, 6 May 2025
Line 1:		Line 1:
	As of version 3.7.7 of the Ocarina of Time Randomizer it is possible to create and apply patch files to the base ROM which can be shared between people who want to play on the same exact seed without distributing copyright material.		As of version 3.7.7 of the Ocarina of Time Randomizer it is possible to create and apply patch files to the base ROM which can be shared between people who want to play on the same exact seed without distributing copyright material.

	''For more technical information view the [https://github.com/~~TestRunnerSRL~~/OoT-Randomizer/blob/~~30fd28fc2dff9853b5adf95eb6d869f27fb742b9~~/Notes/ZPFZ%20patch%20format.txt ZPF patch format Documentation on GitHub].''		''For more technical information view the [https://github.com/OoTRandomizer/OoT-Randomizer/blob/Dev/Notes/ZPFZ%20patch%20format.txt ZPF patch format Documentation on GitHub].''

	== Advantages of Using Patches ==		== Advantages of Using Patches ==

Maplestar at 21:52, 9 October 2021

2021-10-09T21:52:06Z

← Older revision		Revision as of 21:52, 9 October 2021
Line 38:		Line 38:

	=== Bundled Release ===		=== Bundled Release ===
	Under the "ROM Options" tab there is an "Output Type" section. You want to choose "Patch File" instead of "Compressed [Stable]". This will only create the patch file. If you also want a ROM for yourself, you'll need to [[#Apply Patch Files\|apply the patch file]].		The bundled release is the downloadable, offline program for the randomizer. This applies to both the <code>.exe</code> version and github zip files. Under the "ROM Options" tab there is an "Output Type" section. You want to choose "Patch File" instead of "Compressed [Stable]". This will only create the patch file. If you also want a ROM for yourself, you'll need to [[#Apply Patch Files\|apply the patch file]].

	[[File:PatchFiles_Offline.png\|center]]		[[File:PatchFiles_Offline.png\|center]]
Line 54:		Line 54:

	=== Bundled Release ===		=== Bundled Release ===
	Make sure to change "Output Type" back to "Compressed [Stable]" if you previously generated a patch file. At the bottom of the Generator above the "Generate!" button is a section with two tabs. "Generate From Seed" is selected by default. Switch it to "Generate From File" and a "Patch File" textbox will appear. Choose "Select File," locate the ZPF or ZPFZ patch file, and select it. Change your Player ID, if applicable. You can scroll up to change the Cosmetic and SFX options, if desired. If you want the cosmetic/SFX options which were included in the patch file, make sure to disable "Override Original Cosmetics." Once everything is set, click the "Generate!" button and your ROM will be generated.		The bundled release is the downloadable, offline program for the randomizer. This applies to both the <code>.exe</code> version and github zip files. Make sure to change "Output Type" back to "Compressed [Stable]" if you previously generated a patch file. At the bottom of the Generator above the "Generate!" button is a section with two tabs. "Generate From Seed" is selected by default. Switch it to "Generate From File" and a "Patch File" textbox will appear. Choose "Select File," locate the ZPF or ZPFZ patch file, and select it. Change your Player ID, if applicable. You can scroll up to change the Cosmetic and SFX options, if desired. If you want the cosmetic/SFX options which were included in the patch file, make sure to disable "Override Original Cosmetics." Once everything is set, click the "Generate!" button and your ROM will be generated.

	[[File:PatchFiles_Offline2.png\|center]]		[[File:PatchFiles_Offline2.png\|center]]

Maplestar: Added screenshots

2021-10-09T21:11:30Z

Added screenshots

← Older revision		Revision as of 21:11, 9 October 2021
Line 31:		Line 31:

	=== Website ===		=== Website ===
	The website only creates patch files, which you then apply to your ROM after generation. The patch file can be downloaded from the seed page. We will use the [https://ootrandomizer.com/seed/vanilla Vanilla plando seed] as an example. At the very bottom of the page, below the "Patch ROM" button, is a link ''Save unmodified Patch File''. Clicking this link will download the patch file to your computer. You can then send this to people by uploading it to a file sharing site or on Discord.		The website only creates patch files, which you then apply to your ROM after generation. The patch file can be downloaded from the seed page. We will use the [https://ootrandomizer.com/seed/vanilla Vanilla plando seed] as an example. At the very bottom of the page, below the "Patch ROM" button, is a link ''Save unmodified Patch File''. Clicking this link will download the patch file to your computer.

			[[File:PatchFiles_Website.png\|center]]

			You can then send this to people by uploading it to a file sharing site or on Discord.

	=== Bundled Release ===		=== Bundled Release ===
	Under the "ROM Options" tab there is an "Output Type" section. You want to choose "Patch File" instead of "Compressed [Stable]". This will only create the patch file. If you also want a ROM for yourself, you'll need to [[#Apply Patch Files\|apply the patch file]].		Under the "ROM Options" tab there is an "Output Type" section. You want to choose "Patch File" instead of "Compressed [Stable]". This will only create the patch file. If you also want a ROM for yourself, you'll need to [[#Apply Patch Files\|apply the patch file]].

			[[File:PatchFiles_Offline.png\|center]]

			You can then send this to people by uploading it to a file sharing site or on Discord.

	== Apply Patch Files ==		== Apply Patch Files ==
Line 41:		Line 49:

	=== Website ===		=== Website ===
	At the bottom of the [https://ootrandomizer.com/generator Generator page] above the "Generate Seed!" and "Generate Race Seed!" buttons is a section with two tabs. "Generate From Seed" is selected by default. Switch it to "Generate From File" and a "Patch File" textbox will appear. Choose "Select File," locate the ZPF or ZPFZ patch file, and select it. Change ~~your~~ Player ID, if applicable. You can scroll up to choose between creating a <code>.z64</code> file or a <code>.wad</code> file. Once everything is set, click "Patch ROM!" button and your ROM will be generated.		At the bottom of the [https://ootrandomizer.com/generator Generator page], above the "Generate Seed!" and "Generate Race Seed!" buttons is a section with two tabs. "Generate From Seed" is selected by default. Switch it to "Generate From File" and a "Patch File" textbox will appear. Choose "Select File," locate the ZPF or ZPFZ patch file, and select it. Change the Player ID, if applicable. You can scroll up to choose between creating a <code>.z64</code> file or a <code>.wad</code> file or to change the Cosmetic and SFX options. If you want the cosmetic/SFX options which were included in the patch file, make sure to disable "Override Original Cosmetics." Once everything is set, click "Patch ROM!" button and your ROM will be generated.

			[[File:PatchFiles_Website2.png\|center]]

	=== Bundled Release ===		=== Bundled Release ===
	Make sure to change "Output Type" back to "Compressed [Stable]" if you previously generated a patch file. At the bottom of the Generator above the "Generate!" button is a section with two tabs. "Generate From Seed" is selected by default. Switch it to "Generate From File" and a "Patch File" textbox will appear. Choose "Select File," locate the ZPF or ZPFZ patch file, and select it. Change your Player ID, if applicable. Once everything is set, click the "Generate!" button and your ROM will be generated.		Make sure to change "Output Type" back to "Compressed [Stable]" if you previously generated a patch file. At the bottom of the Generator above the "Generate!" button is a section with two tabs. "Generate From Seed" is selected by default. Switch it to "Generate From File" and a "Patch File" textbox will appear. Choose "Select File," locate the ZPF or ZPFZ patch file, and select it. Change your Player ID, if applicable. You can scroll up to change the Cosmetic and SFX options, if desired. If you want the cosmetic/SFX options which were included in the patch file, make sure to disable "Override Original Cosmetics." Once everything is set, click the "Generate!" button and your ROM will be generated.

			[[File:PatchFiles_Offline2.png\|center]]

Maplestar: Moved Disadvantages up below Advantages + minor phrasing changes.

2020-09-25T02:40:41Z

Moved Disadvantages up below Advantages + minor phrasing changes.

@@ Line 1: / Line 1: @@
 As of version 3.7.7 of the Ocarina of Time Randomizer it is possible to create and apply patch files to the base ROM which can be shared between people who want to play on the same exact seed without distributing copyright material.
-''For more technical information view the [https://github.com/TestRunnerSRL/OoT-Randomizer/blob/30fd28fc2dff9853b5adf95eb6d869f27fb742b9/Notes/ZPFZ%20patch%20format.txt ZPF patch format Documentation on GitHub]''
+''For more technical information view the [https://github.com/TestRunnerSRL/OoT-Randomizer/blob/30fd28fc2dff9853b5adf95eb6d869f27fb742b9/Notes/ZPFZ%20patch%20format.txt ZPF patch format Documentation on GitHub].''
 == Advantages of Using Patches ==
-First and foremost, by using patch files you can legally share randomizer ROMs as the patch files do not contain any copyrighted content in them.
+First and foremost, patch files allow you to legally share randomizer seeds, as the patch files do not contain any copyrighted content.
-If you want to conduct a race where only the organizer, or a third party individual, has the spoiler log you can do so by having the person who you want to have access to it create a patch file, then share that patch file for the racers to use on the website. This way you can have a race without fearing someone cheating by reading the spoiler log, and you can still have a spoiler log to look back on later which would not be available if creating a race seed on the website.
+Patch files are the best way to conduct a race where only the organizer or a third party individual has access to the spoiler log. Simply have the person who should have spoiler log access create the patch file, then share that patch file with racers to use on the website. This way you can have a race without fearing someone cheating by reading the spoiler log, but you can still look back on the spoiler log later, which would not be available with a race seed created on the website.
-Patch files also currently work no matter the version of the randomizer. A patch file created on 3.7.7 will work on the latest generator. A version 5.1 patch file will work on the 3.7.7 generator; ''however is not recommended to do due to a bug related to cosmetics with that earlier version that was fixed prior to version 4.0.'' '''This means you can generate a randomizer patch on the Dev branch, a Pull Request, or a an entirely different fork of the randomizer and use it on the website and it will just work!'''
+Patch files also currently work no matter the version of the randomizer used. A patch file created on 3.7.7 will work on the latest generator. A version 5.1 patch file will work on the 3.7.7 generator; ''however it is not recommended to do that due to a bug related to cosmetics that was fixed prior to version 4.0.'' '''This also means you can generate a randomizer patch on the Dev branch, a Pull Request, or a an entirely different fork of the randomizer and use it on the website and it will just work!'''
 == Disadvantages of Using Patch Files ==
 There are not many, but some issues can occur when using patch files.
-=== Cannot Override Some Cosmetics When Using A Patch From Newer Versions ===
+=== Cannot Override Some Cosmetics Using A Patch From Newer Versions on Older Versions ===
 If you generate a patch file on a newer version of the randomizer that adds new cosmetics, you might not be able to override some of the cosmetics already existing in the patch file when using an older version to apply it.
@@ Line 43: / Line 25: @@
 You may be able to use the [https://ootrandomizer.com/latestDev latest Dev version on the website] to work around this issue.

Flagrama: /* Cannot Override Some Cosmetics When Using A Patch From Newer Versions */ mention latestDev

2020-05-13T20:42:35Z

Cannot Override Some Cosmetics When Using A Patch From Newer Versions: mention latestDev

← Older revision		Revision as of 20:42, 13 May 2020
Line 41:		Line 41:
	*Magic Colors		*Magic Colors
	*Button Colors		*Button Colors

			You may be able to use the [https://ootrandomizer.com/latestDev latest Dev version on the website] to work around this issue.

Flagrama: /* Cannot Override Some Cosmetics When Using A Patch From Newer Versions */

2020-05-13T03:31:35Z

Cannot Override Some Cosmetics When Using A Patch From Newer Versions

← Older revision		Revision as of 03:31, 13 May 2020
Line 35:		Line 35:
	If you generate a patch file on a newer version of the randomizer that adds new cosmetics, you might not be able to override some of the cosmetics already existing in the patch file when using an older version to apply it.		If you generate a patch file on a newer version of the randomizer that adds new cosmetics, you might not be able to override some of the cosmetics already existing in the patch file when using an older version to apply it.

	The cosmetics that will ~~break~~ in this case include:		The cosmetics that you will not be able to change in this case include:
	*D-Pad HUD Display		*D-Pad HUD Display
	*Sword Trails		*Sword Trails

Flagrama: /* Cannot Override Some Cosmetics When Using A Patch From Newer Versions */

2020-05-13T03:30:31Z

Cannot Override Some Cosmetics When Using A Patch From Newer Versions

← Older revision		Revision as of 03:30, 13 May 2020
Line 32:		Line 32:
	There are not many, but some issues can occur when using patch files.		There are not many, but some issues can occur when using patch files.

	=== ~~No Cosmetics~~ Override ~~With~~ Cosmetics From Newer Versions ===		=== Cannot Override Some Cosmetics When Using A Patch From Newer Versions ===
	If you generate a patch file on a newer version of the randomizer that adds new cosmetics, you ~~won't~~ be able to override the cosmetics already existing in the patch file when using an older version to apply it.		If you generate a patch file on a newer version of the randomizer that adds new cosmetics, you might not be able to override some of the cosmetics already existing in the patch file when using an older version to apply it.

	~~''Ex'': Patching on 5.2.6 or newer adds button colors to the patch file. Trying to apply one of these patches on the website's 5.2 generator~~ will ~~not allow you to override the cosmetics~~ in ~~the patch file.~~		The cosmetics that will break in this case include:
			*D-Pad HUD Display
			*Sword Trails
			*Heart Colors
			*Magic Colors
			*Button Colors

Flagrama: /* No Cosmetics Override With Cosmetics From Newer Versions */

2020-05-13T03:13:43Z

No Cosmetics Override With Cosmetics From Newer Versions

← Older revision		Revision as of 03:13, 13 May 2020
Line 32:		Line 32:
	There are not many, but some issues can occur when using patch files.		There are not many, but some issues can occur when using patch files.

	=== No Cosmetics Override With Cosmetics In Newer Versions ===		=== No Cosmetics Override With Cosmetics From Newer Versions ===
	If you generate a patch file on a newer version of the randomizer that adds new cosmetics, you won't be able to override the cosmetics in the patch file when using an older version to apply it.		If you generate a patch file on a newer version of the randomizer that adds new cosmetics, you won't be able to override the cosmetics already existing in the patch file when using an older version to apply it.

	''Ex'': Patching on 5.2.6 or newer adds button colors to the patch file. Trying to apply one of these patches on the website's 5.2 generator will not allow you to override the cosmetics in the patch file.		''Ex'': Patching on 5.2.6 or newer adds button colors to the patch file. Trying to apply one of these patches on the website's 5.2 generator will not allow you to override the cosmetics in the patch file.

Flagrama: disadvantage of patch files

2020-05-13T03:10:48Z

disadvantage of patch files

← Older revision		Revision as of 03:10, 13 May 2020
Line 28:		Line 28:
	=== Bundled Release ===		=== Bundled Release ===
	Make sure to change "Output Type" back to "Compressed [Stable]" if you previously generated a patch file. At the bottom of the Generator above the "Generate!" button is a section with two tabs. "Generate From Seed" is selected by default. Switch it to "Generate From File" and you'll see a "Patch File" textbox appear. Choose "Select File" and locate your ZPF or ZPFZ patch file and select it. Once everything is set, click the "Generate!" button and your ROM will be generated.		Make sure to change "Output Type" back to "Compressed [Stable]" if you previously generated a patch file. At the bottom of the Generator above the "Generate!" button is a section with two tabs. "Generate From Seed" is selected by default. Switch it to "Generate From File" and you'll see a "Patch File" textbox appear. Choose "Select File" and locate your ZPF or ZPFZ patch file and select it. Once everything is set, click the "Generate!" button and your ROM will be generated.

			== Disadvantages of Using Patch Files ==
			There are not many, but some issues can occur when using patch files.

			=== No Cosmetics Override With Cosmetics In Newer Versions ===
			If you generate a patch file on a newer version of the randomizer that adds new cosmetics, you won't be able to override the cosmetics in the patch file when using an older version to apply it.

			''Ex'': Patching on 5.2.6 or newer adds button colors to the patch file. Trying to apply one of these patches on the website's 5.2 generator will not allow you to override the cosmetics in the patch file.

Flagrama: /* Advantages of Using Patches */ semicolon grammar

2019-12-29T16:09:58Z

Advantages of Using Patches: semicolon grammar

← Older revision		Revision as of 16:09, 29 December 2019
Line 8:		Line 8:
	If you want to conduct a race where only the organizer, or a third party individual, has the spoiler log you can do so by having the person who you want to have access to it create a patch file, then share that patch file for the racers to use on the website. This way you can have a race without fearing someone cheating by reading the spoiler log, and you can still have a spoiler log to look back on later which would not be available if creating a race seed on the website.		If you want to conduct a race where only the organizer, or a third party individual, has the spoiler log you can do so by having the person who you want to have access to it create a patch file, then share that patch file for the racers to use on the website. This way you can have a race without fearing someone cheating by reading the spoiler log, and you can still have a spoiler log to look back on later which would not be available if creating a race seed on the website.

	Patch files also currently work no matter the version of the randomizer. A patch file created on 3.7.7 will work on the latest generator. A version 5.1 patch file will work on the 3.7.7 generator; ''~~However~~ is not recommended to do due to a bug related to cosmetics with that earlier version that was fixed prior to version 4.0.'' '''This means you can generate a randomizer patch on the Dev branch, a Pull Request, or a an entirely different fork of the randomizer and use it on the website and it will just work!'''		Patch files also currently work no matter the version of the randomizer. A patch file created on 3.7.7 will work on the latest generator. A version 5.1 patch file will work on the 3.7.7 generator; ''however is not recommended to do due to a bug related to cosmetics with that earlier version that was fixed prior to version 4.0.'' '''This means you can generate a randomizer patch on the Dev branch, a Pull Request, or a an entirely different fork of the randomizer and use it on the website and it will just work!'''

	== Create Patch Files ==		== Create Patch Files ==