Lunarsoap5: Created page with "'''TPGZ''' is a romhack for the video game The Legend of Zelda: Twilight Princess started by [https://github.com/hallcristobal/ MidKight] in the end of 2018 and is maintained by the speedrunning community of the game. Its main goal is to provide tools for speedrunners to practice, and for glitch hunters to discover new bugs. It is available for both the Game Cube and the Wii version of the game. Contrarily to the randomizer..."

2022-09-27T13:09:20Z

Created page with "'''TPGZ''' is a romhack for the video game The Legend of Zelda: Twilight Princess started by [https://github.com/hallcristobal/ MidKight] in the end of 2018 and is maintained by the speedrunning community of the game. Its main goal is to provide tools for speedrunners to practice, and for glitch hunters to discover new bugs. It is available for both the Game Cube and the Wii version of the game. Contrarily to the randomizer..."

New page

'''TPGZ''' is a [[wikipedia:ROM_hacking|romhack]] for the video game [[The Legend of Zelda: Twilight Princess]] started by [https://github.com/hallcristobal/ MidKight] in the end of 2018 and is maintained by the speedrunning community of the game. Its main goal is to provide tools for speedrunners to practice, and for glitch hunters to discover new bugs. It is available for both the Game Cube and the Wii version of the game.

Contrarily to the [[Randomizer|randomizer]] of the same game which uses a modified save file to load into an unaltered version of the game, TPGZ is made by directly modifying the game's code. To accomplish this, it uses a custom tool to patch the game. That tool was made into a [https://tpgz.io/ web patcher] at the beginning of 2021, to make the process of compiling the romhack easier.

==History==
It first started when on August 8th, 2018, MidKnight started a repository on GitHub demonstrating a very simple example of a romhack of Twilight Princess written in [https://www.rust-lang.org/ Rust] that would only display "Hello from Rust!" on the top left corner of the game. It wasn't doing much, but it was something that could be improved over.

==How to get TPGZ==

===GameCube===

#Dump your own retail copy of the game.
#Go to the [https://tpgz.io/ web patcher].
#Select the version of the practice tool you want to get.
#Select your dumped game file.
#Hit patch (may take a few minutes).
#Save the patched file on your computer.

You should now be able to load this file on the Dolphin emulator or on a console through Nintendon't.

===Wii===
[[File:TPGZ successful compilation.png|alt=TPGZ successful compilation|thumb|230x230px|This shows how the command line should look if the romhack was successfully compiled]]
<nowiki>*</nowiki>''Note: Only NTSCU 1.0 and PAL versions are supported for now''

#Dump your own retail copy of the game.
#Download the romhack patcher from [https://github.com/zsrtp/romhack-compiler/releases/tag/v0.1.1-r2 this link] and extract it.
#Select the correct patch file for the version of your game from the latest release of TPGZ on [https://github.com/zsrtp/tpgz/releases github].
#Put the dump of your game, the romhack patcher, and the patch file in the same folder.
#[https://www.thewindowsclub.com/how-to-open-command-prompt-from-right-click-menu Open a command line in that folder], and execute <code>./romhack.exe apply 0.2-wii-ntscu-10.patch "rzde10.iso" "tpgzw.iso"</code> (assuming you named your dump "rzde10.iso" and that you have the NTSCU 1.0 version of the game).
#Once the patcher has successfully stopped, you should have a file <code>tpgzw.iso</code> in your folder.

You should now be able to load this file on the Dolphin emulator or on a console through [https://github.com/Fledge68/WiiFlow_Lite/releases WiiFlow] on a USB stick. Alternatively, you can convert the ISO file into a WBFS ([[Practice Rom#Links|using WiiMMS]]) file to reduce its size and store it on an SD card.

==Usage Guide==
[[File:TPGZ main menu.png|alt=TPGZ main menu|thumb|275x275px|TPGZ main menu when opened on the title screen]]
To open the main menu of TPGZ, you need to press [[File:ButtonIcon-GCN-L.svg|28x28px]] + [[File:ButtonIcon-GCN-R.svg|28x28px]] + [[File:ButtonIcon-GCN-D-Pad-D.svg|28x28px]](Z+C+Minus on Wii). You can open the menu at any moment as long as the game is not in a loading state.

Apart for some special menus, the controls are as follows:
{| class="wikitable"
!Controls
!Action
|-
|[[File:ButtonIcon-GCN-D-Pad-D.svg|alt=D-Pad Down|28x28px]]
|Moves the cursor to the next entry in the list
|-
|[[File:ButtonIcon-GCN-D-Pad-U.svg|alt=D-Pad Up|28x28px]]
|Moves the cursor to the previous entry in the list
|-
|[[File:ButtonIcon-GCN-D-Pad-R.svg|alt=D-Pad Right|28x28px]]
|Moves the cursor 10 entry down the list
|-
|[[File:ButtonIcon-GCN-D-Pad-L.svg|alt=D-Pad Left|28x28px]]
|Moves the cursor 10 entry up the list
|-
|[[File:ButtonIcon-GCN-A.png|alt=A Button|28x28px]]
|Selects the item on the cursor
|-
|[[File:ButtonIcon-GCN-B.png|alt=B Button|28x28px]]
|Leaves the current menu
|}

===Menus===

====Cheats====
This menu contains a variety of cheats that you can enable/disable by using [[File:ButtonIcon-GCN-A.png|alt=Button A|28x28px]] on the item.
{| class="wikitable mw-collapsible"
!Cheat
!Description
|-
|Infinite air
|Gives link infinite air underwater
|-
|Infinite arrows
|Gives Link 99 arrows
|-
|Infinite bombs
|Gives Link 99 bombs in all bags
|-
|Infinite hearts
|Link will always have full hearts
|-
|Infinite oil
|Gives Link infinite lantern oil
|-
|Infinite rupees
|Link will always have 1000 rupees
|-
|Infinite slingshot
|Gives Link 99 slingshot pellets
|-
|Invincible
|Makes Link invincible
|-
|Invincible enemies
|Makes some enemies invincible
|-
|Moon jump
|Hold [[File:ButtonIcon-GCN-R.svg|alt=Trigger R|28x28px]]+[[File:ButtonIcon-GCN-A.png|alt=Button A|28x28px]] to moon jump
(Z+C+A on Wii)
|-
|Door storage
|Disables most collision
|-
|Super clawshot
|Clawshot can grab almost anywhere

and is super fast.
|-
|Unrestricted items
|Disables item restrictions
|-
|Transform anywhere
|Transform at any location
|-
|Gale LJA (wii only)
|Automatically pulls out the sword

when throwing boomerang without

leaving targeting mode.
|}

====Flags====
This menu regroups various flag related sub menus.

*'''General flags''': All flags that concerns the game in general, like having Midna on [[File:ButtonIcon-GCN-Z.svg|alt=Button Z|28x28px]] (DPad Up on Wii) or having the Early Boss Flag set.
*'''Dungeon flags''': Have map; Have compass; Have boss key; Mini-boss dead; Boss dead.
*'''Portal flags''': Activates/deactivate every warp portal in the game.
*'''Flag records''': Every remaining flags. Temporary area flags, event flags, mini-games and special dungeon flags.

====Inventory====
This menu regroups various inventory related sub menus.

*'''Item wheel''': You can edit which item is on which slot of the item wheel.
*'''Pause menu''': Editing everything that in the pause menu (aka start menu).
*'''Amounts''': Changing ammo/collectible amounts.

====Memory====
This menu regroups various memory tools.

*'''Watches''': Manage memory watches.
*'''Memory editor''': Edit any address on the RAM.

====Practice====
This menu regroups various saves at key points for different categories. Currently supports the following categories: '''any%''', '''100%'''.

====Scene====
{| class="wikitable mw-collapsible"
!Option
!Description
|-
|Disable bg music
|Disables background and enemy music
|-
|Disable sfx
|Disables sound effects (item, weather, etc.)
|-
|Freeze actors
|Freezes actors
|-
|Freeze camera
|Locks the camera inplace
|-
|Hide actors
|Hides actors
|-
|Hid hud
|Hides the heads-up display
|-
|Freeze time
|Freeze in-game hour
|-
|Time (hrs)
|Modifies the current in-game hour
|-
|Time (mins)
|Modifies the current in-game minutes
|}

====Settings====

*'''Area reload behavior''': load area = Reload last area; load file = Reload last file
*'''Cursor color''': Options are green, blue, red, orange, yellow, and purple.
*'''Font''': Options are ''Consola'', ''Calamity '''bold''''', ''Liberation sans'', ''Liberation sans '''bold''''', ''Liberation serif'', ''Liberation serif '''bold''''', ''press-start-2p''.
*'''Drop shadows''': Adds shadows to all written characters.
*'''Save card''': Saves your current setup for Cheats, Watches, Settings, Tools, ... into the memory card.
*'''Load card''': Loads your saved setup for Cheats, Watches, Settings, Tools, ... from the memory card.
*'''Menu positions''': Changes the positions of different graphical elements of TPGZ ([[File:ButtonIcon-GCN-A.png|alt=Button A|28x28px]] to toggle selection, [[File:ButtonIcon-GCN-D-Pad.svg|alt=DPad|28x28px]] to move).

====Tools====
{| class="wikitable mw-collapsible"
!Tool
!Description
!Controls
|-
|Area reload
|Reloads current area/file
(depends on settings)
|'''GC''': [[File:ButtonIcon-GCN-L.svg|alt=Button L|28x28px]]+[[File:ButtonIcon-GCN-R.svg|alt=Button R|28x28px]]+[[File:ButtonIcon-GCN-A.png|alt=Button A|28x28px]]+[[File:ButtonIcon-GCN-Start-Pause.svg|alt=Button Start|28x28px]]
'''Wii''': Z+C+B+2
|-
|Fast bonk recovery
|Reduces bonk animation significantly
|
|-
|Fast movement
|Link's movement is much faster after
a roll
|
|-
|Gorge checker
|Gives an indication if you are early or
late for Gorge Void, and by how much
|Warp to Kakariko Gorge:
'''GC''': [[File:ButtonIcon-GCN-L.svg|alt=Button L|28x28px]]+[[File:ButtonIcon-GCN-Z.svg|alt=Button Z|28x28px]]

'''Wii''': Z+C+A+1
|-
|BiT checker (Wii only)
|Gives an indication if you are early or
late for Ordon Bridge BiT, and by how

much
|Warp to Ordon Bridge:
'''Wii''': Z+C+A+2
|-
|Input viewer
|Shows current input
|
|-
|Link debug info
|Shows Link's position, angle, and speed
|
|-
|No sinking in sand
|Link won't sink in sand
|
|-
|Roll checker
|Frame counter for chaining rolls
|
|-
|Teleport
|Saves and load Link's position
|'''GC''': store = [[File:ButtonIcon-GCN-R.svg|alt=Button R|28x28px]]+[[File:ButtonIcon-GCN-D-Pad-U.svg|alt=Button UP|28x28px]]; load = [[File:ButtonIcon-GCN-R.svg|alt=Button R|28x28px]]+[[File:ButtonIcon-GCN-D-Pad-D.svg|alt=Button Down|28x28px]]
'''Wii''': store = Z+C+1 ; load = Z+C+2
|-
|Turbo mode
|Simulates turbo controller inputs
|
|-
|Timer
|Frame timer
|'''GC''': start/stop = [[File:ButtonIcon-GCN-Z.svg|alt=Button Z|28x28px]]+[[File:ButtonIcon-GCN-A.png|alt=Button A|28x28px]]; reset = [[File:ButtonIcon-GCN-Z.svg|alt=Button Z|28x28px]]+[[File:ButtonIcon-GCN-B.png|alt=Button B|28x28px]]
'''Wii''': start/stop = Z+C+A+B ; reset = Z+C+B+1
|-
|Load timer
|Loading zone timer
|'''GC''': reset = [[File:ButtonIcon-GCN-Z.svg|alt=Button Z|28x28px]]+[[File:ButtonIcon-GCN-B.png|alt=Button B|28x28px]]
'''Wii''': reset = Z+C+B+1
|-
|Igt timer
|In-game time timer
|'''GC''': start/stop = [[File:ButtonIcon-GCN-Z.svg|alt=Button Z|28x28px]]+[[File:ButtonIcon-GCN-A.png|alt=Button A|28x28px]]; reset = [[File:ButtonIcon-GCN-Z.svg|alt=Button Z|28x28px]]+[[File:ButtonIcon-GCN-B.png|alt=Button B|28x28px]]
'''Wii''': start/stop = Z+C+A+B ; reset = Z+C+B+1
|-
|Free cam
|Gives full control of the camera
|'''GC''': toggle = [[File:ButtonIcon-GCN-Z.svg|alt=Button Z|28x28px]]+[[File:ButtonIcon-GCN-A.png|alt=Button A|28x28px]]+[[File:ButtonIcon-GCN-B.png|alt=Button B|28x28px]]; move=[[File:ButtonIcon-GCN-Control Stick.png|alt=Button Stick|28x28px]]/[[File:ButtonIcon-GCN-L.svg|alt=Button L|28x28px]]/[[File:ButtonIcon-GCN-R.svg|alt=Button R|28x28px]]
view = [[File:ButtonIcon-GCN-C-Stick.png|alt=Button C-Stick|28x28px]]

'''Wii''': toggle = Z+C+B+Minus ; move = Stick+D-Pad

view = C+Stick
|-
|Move link
|Gives full control of link's position
|'''GC''': toggle = [[File:ButtonIcon-GCN-L.svg|alt=Button L|28x28px]]+[[File:ButtonIcon-GCN-R.svg|alt=Button R|28x28px]]+[[File:ButtonIcon-GCN-Y.svg|alt=Button Y|28x28px]]; move=[[File:ButtonIcon-GCN-Control Stick.png|alt=Button Stick|28x28px]]/[[File:ButtonIcon-GCN-C-Stick.png|alt=Button C-Stick|28x28px]]
view = [[File:ButtonIcon-GCN-C-Stick.png|alt=Button C-Stick|28x28px]]

'''Wii''': toggle = Z+C+B+Plus ; move = Stick

view = C+Stick
|-
|Link tunic color
|Options: green, blue, red, orange,
yellow, white, and rainbow
|
|}

====Warping====
This menus allows the user to choose exactly where to warp, and also how to warp to any known map in the game.

==Planned features==

*Actor spawner
*Frame advance
*Collision viewer
*Lag counter

==FAQ==
// WiP

==Links==

*[https://github.com/zsrtp/tpgz Github]
*[https://tpgz.io/ Web patcher]
*[https://wit.wiimm.de/ Wiimms Tools] to convert ISO to WBFS

==Main Contributors==

*[https://github.com/hallcristobal MidKight (Cristobal Hall-Ramos)]
*[https://github.com/Pheenoh Pheenoh]
*[https://github.com/TakaRikka Taka]
*[https://github.com/kipcode66 kipcode66]

Practice Rom - Revision history