Launcher: support Component icons inside apworlds #3629
Conversation
…worlds.module/subpath/to/data.png that use pkgutil to load files from within an apworld
github-actions
bot
added
affects: core
kvui.py
Outdated
| def load_override(filename, default_load=DefaultLoad, **kwargs): | ||
| if filename[:3] == "ap:": | ||
| return ImageLoaderPkgutil(filename) | ||
| else: | ||
| return default_load(filename, **kwargs) |
There was a problem hiding this comment.
If we're overriding load, why aren't we returning the same type that load returns?
It looks like the default load returns an instance of Image, while the new load would return an instance of ImageLoaderBase (which itself has a load function that returns a list of ImageData).
Can you explain how this works?
There was a problem hiding this comment.
if ImageLoader.load() needs to load asynchronously it returns an ImageLoaderBase that can handle the request
https://github.com/kivy/kivy/blob/master/kivy/core/image/__init__.py#L454
this is mimicking that workflow but just short-circuiting it as early as possible because the current loader picking code in kivy cannot handle the information we need in the filename
Co-authored-by: Doug Hoskisson <[email protected]>
kvui.py
Outdated
|
|
||
|
|
||
| # grab the default loader method so we can override it but use it as a fallback | ||
| DefaultLoad = ImageLoader.load |
There was a problem hiding this comment.
variable name
- This isn't a type, so this isn't the right capitalization pattern for it.
- Is there any reason for people to import this from the module and use it directly? If not it should begin with underscore (
_)
maybe _original_load or _original_image_load or _original_image_loader_load
Co-authored-by: Doug Hoskisson <[email protected]>
|
Is this something that we want to document in https://github.com/ArchipelagoMW/Archipelago/blob/main/docs/apworld%20specification.md ? Mentioning #3387 for posterity |
Exempt-Medic
added
the
is: enhancement
ScipioWright
added
waiting-on: core-review
|
bad news: I have learned that PIL is not included in frozen so this did not function when frozen retested the same apAsyncImage_test branch on source and frozen and now it works in both |
|
Great feature, especially for custom/unsupported apworlds! |
What is this fixing or adding?
Add kivy overrides to allow AsyncImage source paths of the format ap:worlds.module/subpath/to/data.png that use pkgutil to load files from within an apworld
How was this tested?
locally edited the a hat in time world to use
icon_paths['yatta'] = f"ap:{__name__}/data/yatta.png"instead of the existing icon_paths value, moving said png to inside a "data" folder in the world, and opened the launcher with:and all displayed the icon, also tested
If this makes graphical changes, please attach screenshots.
Testing notes
feel free to reference the branch https://github.com/qwint/Archipelago/tree/apAsyncImage_test to see the ahit changes for testing