QuizMenuTool Tutorial: Difference between revisions

Line 349:

== Importing The Scripts To SkyTemple ==

Now for the fun part! Actually applying everything to SkyTemple, and seeing the quiz actually play out.

Now for the fun part! Actually applying everything to SkyTemple, and seeing the quiz actually play out. This section will briefly cover installation of SkyPatches and Special Processes, though more generalized guides for these things are or will be available. First though, prior installation of StarterMenuTool will change some of these steps.

=== Converting From StarterMenuTool ===

There are very few differences between starting fresh and converting from StarterMenuTool. The differences are as follows:

Line 364:

Line 361:

* Existing Unionall Edit: StarterMenuTool also requires the modification of <code>coro EVENT_M00A_01</code>. QuizMenuTool will require this coroutine to be edited to run m00a01a in debug mode, and the QMT scripts otherwise.

=== Installing the SkyPatches ===

In order for QuizMenuTool to function, the following SkyPatches must be applied.

* FixPartnerNameMenu: Gives <code>MENU_PARTNER_NAME</code> the ability to actually nickname the partner. Requires ExtraSpace as a pre-requisite.

* ExtractSPCode: Enables the use of custom Special Processes used heavily by QMT.

Installing FixPartnerNameMenu is relatively simple. After downloading the file from the github repo, navigate to <code>Patches -> ASM</code> in SkyTemple. Then, click the "Open Patch Directory" button.

Finally, drag <code>FixPartnerName.skypatch</code> into the folder, and close it. The patch will now be in the "Others" Tab, ready for installation. If ExtraSpace is not installed, SkyTemple will prompt the installation of both patches sequentially. This is good, do that.

Next, is the installation of ExtractSPCode. Once again, navigate to <code>Patches->ASM</code>, and select the "Utility" tab. Install ExtractSPCode, and any necessary pre-requisites (there shouldn't be any, except maybe ExtraSpace).

=== Applying The Special Processes ===

Now for installing the Special Processes themselves. If the hack already has custom Special Processes it wishes to keep, or the IDs of the special processes in the sheet have been changed, apply the SPs as desired, but ensure the sheet has accurate IDs (NOT Effects), so it can call them. For simplicity, these are the default locations of each SP:

{| class="wikitable"

|+

!Spreadsheet Tab

!Spreadsheet Input Name

!SP File Name

!ID

!Effect

|-

|Starter Selection Generator

|starter_setter SP ID

|starter_setter.asm

|64

|61

|-

|Starter Selection Generator

|set_frame_color SP ID

|set_frame_color.asm

|65

|62

|-

|Aura Bow Generator

|CheckTSPress SP ID

|CheckTSPress.asm

|66

|63

|-

|Aura Bow Generator

|ReturnTSPFrames SP ID

|ReturnTSPFrames.asm

|67

|64

|-

|Aura Bow Generator

|MoveText2TopScreen SP ID

|MoveText2TopScreen.asm

|68

|65

|-

|Starter Selection Generator

|Set_Demo_Character SP ID

|Set_Demo_Character.asm

|69

|66

|-

|Aura Bow Generator

|get_favorite_config_color SP ID

|get_favorite_config_color.asm

|70

|67

|}

Ensure that you download the correct set of special processes for your version of the ROM (US or EU). Next, navigate to <code>Patches->ASM->Special Processes</code>, and click the "Add Special Process" button until enough IDs are in the list for each new Special Process.

The list should look like it does in the image when done. With that completed, navigate to the "Effects Code" tab. Click the "+" Button to create a new effect. Then, click the "Import Code" button at the bottom to select the special process to be imported to this effect.

[[File:How2AddSpecialProcesses2.png|center|thumb|600x600px|Clicking the "+" Button adds a new effect. Each new effect must have the correct .asm file imported into it, as specified in the table.]]

In the above image, Special Process <code>starter_setter.asm</code> is being imported to Effect 61, which corresponds to ID 64. Similarly, <code>set_frame_color.asm</code> should be imported to Effect 62 (ID 65), <code>CheckTSPress.asm</code> should be imported to Effect 63, etc.

Once all the necessary Special Processes have been imported to their effects, the last thing that needs to be done is assigning the effects to their IDs. Navigating back to the "Special Process Effects" tab, assign each effect to the correct ID, as shown below:

With that, SP importing is complete, and all that remains is to save the ROM.

=== Creating QMT Script Files ===

=== Pasting Scripts/Unionall From the Sheet ===

== Other Resources ==

@@ Line 349: / Line 349: @@
 == Importing The Scripts To SkyTemple ==
-Now for the fun part! Actually applying everything to SkyTemple, and seeing the quiz actually play out.
+Now for the fun part! Actually applying everything to SkyTemple, and seeing the quiz actually play out. This section will briefly cover installation of SkyPatches and Special Processes, though more generalized guides for these things are or will be available. First though, prior installation of StarterMenuTool will change some of these steps.
 === Converting From StarterMenuTool ===
 There are very few differences between starting fresh and converting from StarterMenuTool. The differences are as follows:
@@ Line 364: / Line 361: @@
 * Existing Unionall Edit: StarterMenuTool also requires the modification of <code>coro EVENT_M00A_01</code>. QuizMenuTool will require this coroutine to be edited to run m00a01a in debug mode, and the QMT scripts otherwise.
+=== Installing the SkyPatches ===
+In order for QuizMenuTool to function, the following SkyPatches must be applied.
+* FixPartnerNameMenu: Gives <code>MENU_PARTNER_NAME</code> the ability to actually nickname the partner. Requires ExtraSpace as a pre-requisite.
+* ExtractSPCode: Enables the use of custom Special Processes used heavily by QMT.
+Installing FixPartnerNameMenu is relatively simple. After downloading the file from the github repo, navigate to <code>Patches -> ASM</code> in SkyTemple. Then, click the "Open Patch Directory" button.
+[[File:InstallFixPartnerNamePatch.png|alt=The "Open Patch Folder" button is on the bottom left.|center|thumb|600x600px|The "Open Patch Directory" button is on the bottom left.]]
+Finally, drag <code>FixPartnerName.skypatch</code> into the folder, and close it. The patch will now be in the "Others" Tab, ready for installation. If ExtraSpace is not installed, SkyTemple will prompt the installation of both patches sequentially. This is good, do that.
+Next, is the installation of ExtractSPCode. Once again, navigate to <code>Patches->ASM</code>, and select the "Utility" tab. Install ExtractSPCode, and any necessary pre-requisites (there shouldn't be any, except maybe ExtraSpace).
+[[File:ExtractSPCode.png|alt=ExtractSPCode Location|center|thumb|600x600px|ExtractSPCode Location]]
+=== Applying The Special Processes ===
+Now for installing the Special Processes themselves. If the hack already has custom Special Processes it wishes to keep, or the IDs of the special processes in the sheet have been changed, apply the SPs as desired, but ensure the sheet has accurate IDs (NOT Effects), so it can call them. For simplicity, these are the default locations of each SP:
+{| class="wikitable"
+|+
+!Spreadsheet Tab
+!Spreadsheet Input Name
+!SP File Name
+!ID
+!Effect
+|-
+|Starter Selection Generator
+|starter_setter SP ID
+|starter_setter.asm
+|64
+|61
+|-
+|Starter Selection Generator
+|set_frame_color SP ID
+|set_frame_color.asm
+|65
+|62
+|-
+|Aura Bow Generator
+|CheckTSPress SP ID
+|CheckTSPress.asm
+|66
+|63
+|-
+|Aura Bow Generator
+|ReturnTSPFrames SP ID
+|ReturnTSPFrames.asm
+|67
+|64
+|-
+|Aura Bow Generator
+|MoveText2TopScreen SP ID
+|MoveText2TopScreen.asm
+|68
+|65
+|-
+|Starter Selection Generator
+|Set_Demo_Character SP ID
+|Set_Demo_Character.asm
+|69
+|66
+|-
+|Aura Bow Generator
+|get_favorite_config_color SP ID
+|get_favorite_config_color.asm
+|70
+|67
+|}
+Ensure that you download the correct set of special processes for your version of the ROM (US or EU). Next, navigate to                       <code>Patches->ASM->Special Processes</code>, and click the "Add Special Process" button until enough IDs are in the list for each new Special Process.
+[[File:How2AddSpecialProcesses1.png|alt=The "Add Special Process" button is at the very bottom.|center|thumb|600x600px|The "Add Special Process" button is at the very bottom.]]
+The list should look like it does in the image when done. With that completed, navigate to the "Effects Code" tab. Click the "+" Button to create a new effect. Then, click the "Import Code" button at the bottom to select the special process to be imported to this effect.
+[[File:How2AddSpecialProcesses2.png|center|thumb|600x600px|Clicking the "+" Button adds a new effect. Each new effect must have the correct .asm file imported into it, as specified in the table.]]
+In the above image, Special Process <code>starter_setter.asm</code> is being imported to Effect 61, which corresponds to ID 64. Similarly, <code>set_frame_color.asm</code> should be imported to Effect 62 (ID 65), <code>CheckTSPress.asm</code> should be imported to Effect 63, etc.
+Once all the necessary Special Processes have been imported to their effects, the last thing that needs to be done is assigning the effects to their IDs. Navigating back to the "Special Process Effects" tab, assign each effect to the correct ID, as shown below:
+[[File:How2AddSpecialProcesses3.png|alt=Simply clicking on the effect cell will allow it to be edited.|center|thumb|600x600px|Simply clicking on the effect cell will allow it to be edited.]]
+With that, SP importing is complete, and all that remains is to save the ROM.
+=== Creating QMT Script Files ===
+=== Pasting Scripts/Unionall From the Sheet ===
 == Other Resources ==