[Pokeemerald] [Pokefirered + Pokeemerald] Quest Menu

[ghoulslash]

[Pokefirered] & [Pokeemerald] Quest Menu

This feature was originally implemented for binary hacking, but the PC menu works quite well for a quest menu in my opinion so I kept the original implementation rather than try to improve it.

Pokefirered repo
Pokeemerald repo

How To Add

• git remote add ghoulslash https://github.com/ghoulslash/pokefirered (or https://github.com/ghoulslash/pokeemerald)
• git pull ghoulslash quest-menu

How to Use (Pokeemerald):

• By default the quest menu is added to the start menu when "FLAG_SYS_QUEST_MENU_GET" is set.
• To open from elsewhere, you just need to call:
  

  QuestMenu_Init(0, <callback>)

• edit "sSideQuests" with your quest info. Strings are found in "src/strings.c"

How To Use (Pokefirered):

• If you want to open from elsewhere, you just need to call ItemPc_Init(0, some_callback).
• The structure, 'sSideQuests' inside src/item_pc.c on line 58 contains each quest's info. The relevant strings can be found in src/strings.c.
• Changing the default flags, number of quests, etc., can be found in include/quests.h

Scripting Commands:

• I've added a script command, 'questmenu', that takes a couple arguments and can be used to open the menu, unlock/complete quests, and more. Here's a rundown for the command "questmenu case, questId"
  • openquestmenu (or questmenu QUEST_MENU_OPEN 0): open the quest menu
  • QUEST_MENU_UNLOCK_QUEST questId: unlocks a specific quest
  • QUEST_MENU_COMPLETE_QUEST questId: mark a quest as complete
  • QUEST_MENU_SET_ACTIVE questId: set a quest as the active quest
  • QUEST_MENU_RESET_ACTIVE: remove any active quest
  • QUEST_MENU_BUFFER_QUEST_NAME questId: buffers the questId name to gStringVar1 (STR_VAR_1)
  • QUEST_MENU_GET_ACTIVE_QUEST: returns the active questId to VAR_RESULT
  • QUEST_MENU_CHECK_UNLOCKED questId: checks if the questId has been unlocked. Returns result to VAR_RESULT
  • QUEST_MENU_CHECK_COMPLETE questId: checks if the questId has been completed. Returns result to VAR_RESULT

How To Use (Pokeemerald): The same as above, except everything in contained in src/quests.c, and the function name to call is "QuestMenu_Init(0, some_callback)." A function named "Task_OpenQuestMenuFromStartMenu" is added for you to easily add QUESTS as a start menu option as well

Example Scripts:

Spoiler:

Example Script: Unlock quests 2, 5, 7, and 15 and then open the quest menu

     questmenu QUEST_MENU_UNLOCK_QUEST SIDE_QUEST_2
     questmenu QUEST_MENU_UNLOCK_QUEST SIDE_QUEST_5
     questmenu QUEST_MENU_UNLOCK_QUEST SIDE_QUEST_7
     questmenu QUEST_MENU_UNLOCK_QUEST SIDE_QUEST_15
     openquestmenu
     end

Example Script: Mark quest 13 as complete

     questmenu QUEST_MENU_COMPLETE_QUEST SIDE_QUEST_13
     end

Example Script: Buffer the active quest name

     questmenu QUEST_MENU_GET_ACTIVE_QUEST 0
     questmenu QUEST_MENU_BUFFER_QUEST_NAME VAR_RESULT
     msgbox QuestName MSGBOX_SIGN

QuestName: .string "{STR_VAR_1}$"

 

[Kiminoshiranaii]

Is this compatible with skeli's CFRU?

 

[Lunos]

Is this compatible with skeli's CFRU?

Skeli's CFRU is a C Injection for binary hacking, which is a different and separate way of hacking compared to using the decompilation projects.
The answer is "No".

 

[ghoulslash]

Is this compatible with skeli's CFRU?

Like Lunos said, this is strictly for decomps, whereas CFRU is for binary hacking. There is a binary version of this feature that is compatible, though. Fair warning that there may be bugs since it was developed a while ago.

 

[TheXaman]

The compiler is complaining about "stdpal_get" in e.g. "LoadPalette(stdpal_get(2), 0xD0, 0x20)", I presume the name has chnaged but I cant find the new version.

 

[ghoulslash]

The compiler is complaining about "stdpal_get" in e.g. "LoadPalette(stdpal_get(2), 0xD0, 0x20)", I presume the name has chnaged but I cant find the new version.

I've merged with pret so that problem should be fixed. Thanks for the reminder!

 

[Bidoof]

Thank you so much for this feature, this is super cool! This can bring just the extra oomph to the depth of a hack. At least I as a completionist am really stoked about having side quests and rewards! This is probably the best modification I've seen thus far. Kudos to you!

 

[Martyk]

(EDIT) Never mind, I found the problem. sub_81983AC has been renamed to Menu_InitCursor.
I'll leave the comment here for if anybody else runs into the same problem.

Hi,
I would really like to add this because this is simply an amazing feature!
However, I get the following error:
src/quests.c: In function `Task_QuestMenuSubmenuInit':
src/quests.c:1182: warning: implicit declaration of function `sub_81983AC'

in src/quests it looks as following (Underlined part is row 1182):

Spoiler:

static void Task_QuestMenuSubmenuInit(u8 taskId)
{
s16 * data = gTasks[taskId].data;
u8 windowId;

QuestMenu_SetBorderStyleOnWindow(4); //for sub menu list items
windowId = QuestMenu_GetOrCreateSubwindow(0);

if (GetSetQuestFlag(data[1], FLAG_GET_COMPLETED))
{
// completed
PrintTextArray(4, 2, 8, 2, GetFontAttribute(2, FONTATTR_MAX_LETTER_HEIGHT) + 2, NELEMS(sCompletedQuestSubmenuOptions), sCompletedQuestSubmenuOptions);
sub_81983AC(4, 2, 0, 2, GetFontAttribute(2, FONTATTR_MAX_LETTER_HEIGHT) + 2, NELEMS(sCompletedQuestSubmenuOptions), 0);

}
else if (IsActiveQuest(QuestMenu_GetCursorPosition()))
{
// active
PrintTextArray(4, 2, 8, 2, GetFontAttribute(2, FONTATTR_MAX_LETTER_HEIGHT) + 2, NELEMS(sActiveQuestSubmenuOptions), sActiveQuestSubmenuOptions);
sub_81983AC(4, 2, 0, 2, GetFontAttribute(2, FONTATTR_MAX_LETTER_HEIGHT) + 2, NELEMS(sActiveQuestSubmenuOptions), 0);
}
else
{
// unlocked
PrintTextArray(4, 2, 8, 2, GetFontAttribute(2, FONTATTR_MAX_LETTER_HEIGHT) + 2, NELEMS(sQuestSubmenuOptions), sQuestSubmenuOptions);
sub_81983AC(4, 2, 0, 2, GetFontAttribute(2, FONTATTR_MAX_LETTER_HEIGHT) + 2, NELEMS(sQuestSubmenuOptions), 0);
}
//CopyItemName(QuestMenu_GetItemIdBySlotId(data[1]), gStringVar1);
//StringExpandPlaceholders(gStringVar4, gText_StrVar1);

StringCopy(gStringVar4, sText_QuestMenu_SelectedQuest);
//StringExpandPlaceholders(gStringVar4, sText_QuestMenu_SelectedQuest);

QuestMenu_AddTextPrinterParameterized(windowId, 2, gStringVar4, 0, 2, 1, 0, 0, 1);
ScheduleBgCopyTilemapToVram(0);
gTasks[taskId].func = Task_QuestMenuSubmenuRun;
}

Any idea on how to fix this?
Thanks again for all these amazing features you come up with, not just this one.

 

[Jessler]

Hey! I absolutely love this, and I could see it having a big use in my hacks. The one downside I see is that it only saves one active quest at a time. If you could modify this to allow for multiple active quests at once, that would be perfect. That's my only complaint though, it's super useful!

 

[ghoulslash]

Hey! I absolutely love this, and I could see it having a big use in my hacks. The one downside I see is that it only saves one active quest at a time. If you could modify this to allow for multiple active quests at once, that would be perfect. That's my only complaint though, it's super useful!

Thanks! The active quest is more for show than anything. This branch doesn't do anything with the active quest other than display 'active'. If you wanted, you could easily remove it by making "IsActiveQuest" return FALSE. Alternatively, create an "activeQuests" field in the saveblock and have IsActiveQuest return a value based on GetSetQuestFlag and checking some FLAG_GET_ACTIVE. Feel free to reach out to me on discord for more info if this option sounds good and you need some more help implementing it.

 

[Jessler]

That sounds exactly like what I was hoping to do with it- I'll give it a shot and if I need more help I'll be sure to reach out. Thanks a lot!