QuizMenuTool Tutorial
This article is unfinished. You can help expanding it.
This guide explains how to use QuizMenuTool to create a custom Personality Quiz. The bulk of this guide will explain the use of the google sheets portion of the tool. A rudimentary understanding of SkyTemple scripting will be assumed, namely adding new acting scenes, and adding scenes to unionall.ssb. For help with these topics... TODO: Link supplemental resources or suggest #support.
Who QuizMenuTool is for
If either of the below points do not apply to you, you do not need QuizMenuTool.
- You would like to expand (or shrink) the list of starter options in the game.
- You would like to keep the personality quiz in the game.
If you only want to change the size of the starter list, and do not want the personality quiz (as if the SkipQuiz patch is applied), you should instead use StarterMenuTool, which is less powerful but requires much less work to set up.
Programs and Files
Required Programs and Files
- Explorers of Sky Personality Quiz Assembling Sheet
- Necessary Special Processes and SkyPatches
- SkyTemple
Personality Quiz Assembling Sheet
Making a Copy of the Sheet
The above link does NOT grant edit access. In order to use the sheet, a copy will need to be made as follows:
First click the "File" button on the top left. Next, "Make a Copy" of the sheet. Finally, name the copy as desired.
Cell Color-Coding
Throughout the spreadsheet, most cells are color-coded. Here's a brief explanation of each color present in the sheet:
- Green Cells are for user input. If a cell is green, it is intended to contain input data.
- Grey Cells contain formulas. They will update automatically, and should not be edited.
- Orange Cells are for user outputs. If a cell is orange, it is intended to be exported elsewhere, such as to a SkyTemple script.
- Cells without a color or of an unspecified color are typically safe to edit. Always check for a formula first though!
Starter Selection Generator: Actually Adding the Starters...
Upper Panel
Most tabs in the sheet contain an upper panel of some kind, with various simple inputs and feedback on them:
This upper panel contains 4 inputs, 3 of which are for Special Processes pertaining to starter selection. If other Special Processes have already been added, these Special Process IDs will need to be changed to free slots. The "White Space?" checkbox will attempt to add indents to the output ExplorerScript lines. The 4 grey cells are useful statistics about the input starters: how many different pools are used by the starters, how many species are present, and how many options there are for the hero and partner.
Personality Pool Input
Next, on the lower right is the nature "Pool" input. These contain the pool name, and the text that should be displayed if that pool is selected by the quiz.
The "Pool Name" field is only used by the Question Generator Tab, and will not show up anywhere in the final script. Modify these as desired as soon as possible, as it will be difficult to do so after designing the quiz questions. For best results, ensure all pool names are unique!
Starter Species Data
The bottom left segment of the sheet is the "Starter Species Data" input. This is part of a wider table, but each segment will be discussed individually.
While some of these fields should be intuitive, A brief description of each column is as follows:
- Species Name: The name of the species as you want it shown in the quiz. If the cell turns purple on entering a species name, this means the Pokémon could not be found in Vanilla Translation Strings. French and German Translations will need to be added by hand, or all strings involving the Pokémon will need to be translated manually.
- Species ID: The ID in SkyTemple of the Pokémon. [TODO: Explain how this is affected by ExpandPokeList].
- Gender: The gender of the Pokémon, used to set the frame color, and to add "♂" and "♀" to the hero/partner selection list. 0 is Male, 1 is Female, and 2 is Genderless.
- Pool ID: The number of the Pool the Pokémon should be categorized under. Each Pool that could be chosen by the Quiz should have at least one valid Pokémon, or Bulbasaur will be selected as a failsafe. If the species are not sorted by Pool ID, cells will turn red. The sheet will produce invalid labels if this table is not sorted by Pool ID!
- Start w/ Vowel: If the Pokémon should be referred to as "...an [Pokémon]", check this box.
Talk Group & Role Exclusion
Continuing along the table, the next two subsections are for "Talk Groups" and "Role Exclusion". Both of these segments relate to either the hero, or the partner.
In the vanilla game, the hero and partner have differing dialogue depending on their species-specific "Talk Group". These columns are dedicated to assigning the talk group for the hero or partner if that row's species is chosen. While it handles pronouns for dialogue, especially in gendered languages, it also affects the way the partner's dialogue is written. This is how they are used in vanilla:
| # | Used By | Notable Species | Description |
|---|---|---|---|
| 1 | Partner | Male Squirtle/Totodile/Chimchar/Meowth/Munchlax | More Masculine Dialogue. (Refers to self as "Oira" in Japanese) |
| 2 | Partner | All other Male Pokémon | More Neutral Dialogue. (Refers to self as "Boku" in Japanese) |
| 3 | Partner | All Female Pokémon | More Feminine Dialogue. |
| 4 | Hero | All Male/Genderless Pokémon | Uses Masculine Pronouns |
| 5 | Hero | All Female Pokémon | Uses Feminine Pronouns |
The "Role Exclusion" checkboxes blacklist the row from being an option as a hero or as a partner respectively. Certain Pokémon, like Meowth and Munchlax, are unable to be heroes in the vanilla game. This section is how to replicate that feature of the original quiz.
Fuwarante Blacklist
Finally, on the far end of the table, is the Fuwarante Blacklist inputs. These are perhaps the most complicated portion of this tab of the sheet.
Each column corresponds to a bit of the script variable $BIT_FUWARANTE_LOCAL. If the matching flag is on, the starter in that row cannot be chosen. This will be elaborated on further in the "Question Loop Generator", but this is a brief explanation of what the bits represent by default:
| Bit | Description/Use Case |
|---|---|
| 0 | If enabled, $PLAY_OLD_GAME will be true, meaning the player answered that they have played Time/Darkness before. |
| 1 | If enabled, the player has played EoS before, according to a custom starting question. |
| 2 | If enabled, the player has participated in a Mystery Mail event before, according toa custom ending question. |
| 3 | If enabled, the player claimed to be female in the final gender question. Enable for male starters. |
| 4 | If enabled, the player claimed to be male in the final gender question. Enable for female starters. |
Outputs
The orange output cells on the far right of this sheet are largely unimportant, but are present for debug purposes. It compiles the portions of the script using the inputs on this tab of the sheet.
Quiz Preamble Generator: A Good First Impression!
Preamble Text
This is the first of many direct inputs for ExplorerScript code. Due to the way spreadsheets store cell data, " " behave weirdly when present in the final script. Please use ' ' instead. This input is for the first set of dialogue before the questions actually begin.
Outputs
Once again, the orange output cell on this sheet is largely unimportant, but is present for debug purposes. It compiles the portions of the script using the inputs on this tab of the sheet.