Custom message override PoC #669
Conversation
garrettjoecox
force-pushed
the
custom-message-poc
branch
4 times, most recently
from
a52f5f8
to
c2669eb
Compare
|
It works 😄 
|
|
There is a program I use and its template is nice enough to work with, maybe you can take a look at it, it's name is Zelda64 Text Editor 2024-06-06.04-25-43.mp4 |
|
@garrettjoecox any updates on this? No rush if not. In the meantime, any recommendations on moving forward with the time selector enhancement? |
Sorry, I’ve been out of pocket these last few weeks. I meant to remove the do not merge label after I fixed the remaining issue. It’s still kind of a short/medium term PoC but I’d say it’s ready for people to use and try out. My intention was for you to use it and see if it allows you to do what you need, as a proving exercise. (Sorry I didn’t really convey this 😅) |
@garrettjoecox No problem! I'll go ahead and use it this weekend and see how it works! Thanks for the update 👍🏿 |
|
Any thoughts on this approach for medium term development (rando, anchor, etc)? |
|
I've been beginning to look through PRs starting from the back, but I can try to prioritize this one this evening. |
There was a problem hiding this comment.
Ok, for a mid term solution, I think it works fine. There are some logistics that we can build on top of like you mentioned in the description.
In addition to custom control codes (these could even be custom per "mod" type), I imagine we will want a hook in one of the Message_Update methods for handling complex messages (3ds song of double time comes to mind).
Leaving an approval as is (assuming we wont be leaving the example text registered by time of merge).
garrettjoecox
force-pushed
the
custom-message-poc
branch
3 times, most recently
from
4b064c9
to
d9922f8
Compare
|
@Archez made some small adjustments and added an example of text replacement. |
| GameInteractor_ExecuteOnHandleCustomMessage(activeMessageModId, activeMessageTextId, &msg); | ||
|
|
||
| // Copy modified message to the buffer | ||
| memcpy(buff + 11, msg.c_str(), msg.length()); |
There was a problem hiding this comment.
Probably should have a check somewhere here to ensure that the resulting string after modification is within the buffer limit < (1280 - 11) so that the memcpy doesn't overflow.
There was a problem hiding this comment.
There was a problem hiding this comment.
Yeah that works.
Although I'd prefer 1280 - 11 and 1280 - 11 - 1 respectively (or really defines for the max buffer and msg header size), but that's non-blocking for this PR (I'm sure we will be in this file a lot in the coming times)
| // Not really sure what the best ID is for this, but it needs to be between 0-255 | ||
| // because it's used as a u8 somewhere in the chain |
There was a problem hiding this comment.
out of curiousity do u know where this is?
There was a problem hiding this comment.
One spot is the textId field in the GetItemEntry struct, might be other places
garrettjoecox
force-pushed
the
custom-message-poc
branch
from
d9922f8
to
b7b3497
Compare
garrettjoecox
force-pushed
the
custom-message-poc
branch
from
b7b3497
to
b430d68
Compare
|
Simplified and consolidated this work into #757 , may re-open separately later |
It's not perfect, but it works.
This isn't meant to be an end all solution, but aims to be short - medium term solution for custom messages. The idea is that you register your custom message in
ShipMessages.husing the same format messages are extracted to in https://github.com/zeldaret/mm (after you have built the project look formessage_data.h)One thing that is absent, and still needs to be figured out is a good framework for replacing message contents, there is obviously built in control codes for this, but we'll want both more flexibility and more user friendliness than just using control codes. (eg templating like
{{}})We also need to bring in all of the message related changes from upstream so we can get all of the macros required to craft a message
Build Artifacts