feat: plugin system (currently just sprites) #95

andrewbenington · 2024-12-25T22:42:31Z

Description

Added a plugin system, currently allowing new sprite packs to be used but to be expanded to PKM and SAV types in the future. Allowed plugins are listed at OpenHome-Plugins/plugins.json, which can be updated as needed.

To Do

Download plugins asynchronously (so app doesn't hang)
~~Investigate ways to make code loading more secure~~
(After some investigation, securing plugin code from accessing web resources like Tauri code is not possible without severely restricting what plugins can do. It will be important to vet the plugins allowed to be installed)
- ~~Restrict plugins from calling Tauri code~~
Save enabled/disabled status of plugins in settings
Allow plugins to consume PokemonData from OpenHome instead of needing to package the library themselves
Plugin descriptions
Plugin versions/update option
Delete plugins
Separate tabs (browse vs installed)

Issues
Fixes #89

evanwporter

Rather than adding the added plugins to a list I think it would be cool to make the installed plugins have a green background and the uninstalled plugins have a red background.

andrewbenington · 2024-12-29T21:28:43Z

Rather than adding the added plugins to a list I think it would be cool to make the installed plugins have a green background and the uninstalled plugins have a red background.

red should be a "danger" color and only used when we want to alert the user of a destructive action. plus, I want plugins to be able to have full backgrounds. The current images are only placeholders.

I like the idea of browsing available plugins without having to go past the list of installed ones. I'll move the installed plugin list to its own tab in case the user wants to see those.

evanwporter · 2024-12-29T23:47:09Z

red should be a "danger" color and only used when we want to alert the user of a destructive action.

Okay.

The current images are only placeholders.

Oh they are temporary? I really like them... But we should replace the BW sprite pack with Kyurem since that seems more neutral

Also a delete button would be good.

andrewbenington · 2024-12-30T00:23:46Z

Oh they are temporary? I really like them... But we should replace the BW sprite pack with Kyurem since that seems more neutral

Actually I like them too. I still think icons should be allowed to take up the whole card in the future, so I'll stick to the bottom right 'installed' chip. And I picked Reshiram because I like its design the most :) same with Xerneas

Also a delete button would be good.

Yeah that's a task in the PR description. I want to finish those before merging

evanwporter · 2024-12-31T00:43:18Z

@andrewbenington

Instead of a delete + disable/enable dropdown. What about adding the delete to the bottom left and the disable/enable togglable by clicking the card.

Edit: next commit makes these changes but it can be reversed.

evanwporter · 2024-12-31T02:04:32Z

@andrewbenington

I added a delete button. Currently there is a delay from when the trash can is clicked and when the card is removed. This is due to the backend having to delete all the files then removing the card.

Also I can't get the title styling right, so maybe you could look at it.

andrewbenington · 2024-12-31T18:35:35Z

@andrewbenington

I added a delete button. Currently there is a delay from when the trash can is clicked and when the card is removed. This is due to the backend having to delete all the files then removing the card.

Also I can't get the title styling right, so maybe you could look at it.

I like it. I started making a dropdown because I want the option to expand and view plugin details, but I'm thinking clicking the main body of the card will expand to show details, and click the enabled chip to toggle enabled/disabled

And yeah the delete button should probably hide the plugin immediately, even if the files haven't finished deleting. I'll hopefully get to it tomorrow

This is so it can be reused in the future

andrewbenington · 2025-01-02T00:25:59Z

@evanwporter I think this is ready to merge into main. If you have a chance can you look at it?

I made a couple styling changes, plus a backend change that will require you to redownload any plugins on the Available Plugins page. Let me know if you run into any issues, I'm going to do some testing on Windows and Linux to make sure

evanwporter · 2025-01-02T01:34:11Z

The just added sprite packs don't see to be working. But I haven't done any in depth investigation @andrewbenington

evanwporter · 2025-01-02T01:35:53Z

@andrewbenington

andrewbenington · 2025-01-02T01:46:06Z

@evanwporter
The Sword/Shield plugin sprites were sourced from Bulbapedia, and some of them are missing there (including Dragonite). It's more common for Crown Tundra introduced mons

evanwporter · 2025-01-02T04:08:54Z

@andrewbenington Ah okay then it looks good.

* Resource pack backend * simplified `download_images_from_github_folder` * Added to `tauriInvoker` * Added button to `Settings` to download gen1 sprite pack. * ran linter * initial plugin downloading/management * plugin card styling * fix for missing plugin folder * async plugin download * keep home mounted * housekeeping * move gen 7 sprites to plugin * start persisting enabled plugins * plugin enabled status persists correctly * move gen 6 sprites to plugin * newline * bump version * standardize icon.png and assets dir * image url update * Created delete plugin command * Set up debugging in VSCode (#97) * Update launch.json * Update tasks.json * Fixed it * renamed `ui` to `frontend` * Got rid of problem matcher * Fixed vscode settings * fix last opened (recent saves) (#99) * plugin page tabs * installed plugin dropdown menu * fix unused var * added `deletePlugin` to tauri invoker * Added `deletePLugin` to backend * made changes * implmented deletion of plugin * ran linter * Moved code w/i `delete_plugin` to generic `util::delete_folder`. This is so it can be reused in the future * Fixed display * Fixed plugin icon covering chips * added `deletePlugin` to dummy backend * delete icon styling * update plugin metadata fields * log plugin sprite error instead of displaying * cleanup plugin state on delete * coalesce plugin actions * include version and api_version in downloaded metadata --------- Co-authored-by: evanwporter <[email protected]> Co-authored-by: Evan <[email protected]>

* move modal into pokemon details component * feat: plugin system (currently just sprites) (#95) * Resource pack backend * simplified `download_images_from_github_folder` * Added to `tauriInvoker` * Added button to `Settings` to download gen1 sprite pack. * ran linter * initial plugin downloading/management * plugin card styling * fix for missing plugin folder * async plugin download * keep home mounted * housekeeping * move gen 7 sprites to plugin * start persisting enabled plugins * plugin enabled status persists correctly * move gen 6 sprites to plugin * newline * bump version * standardize icon.png and assets dir * image url update * Created delete plugin command * Set up debugging in VSCode (#97) * Update launch.json * Update tasks.json * Fixed it * renamed `ui` to `frontend` * Got rid of problem matcher * Fixed vscode settings * fix last opened (recent saves) (#99) * plugin page tabs * installed plugin dropdown menu * fix unused var * added `deletePlugin` to tauri invoker * Added `deletePLugin` to backend * made changes * implmented deletion of plugin * ran linter * Moved code w/i `delete_plugin` to generic `util::delete_folder`. This is so it can be reused in the future * Fixed display * Fixed plugin icon covering chips * added `deletePlugin` to dummy backend * delete icon styling * update plugin metadata fields * log plugin sprite error instead of displaying * cleanup plugin state on delete * coalesce plugin actions * include version and api_version in downloaded metadata --------- Co-authored-by: evanwporter <[email protected]> Co-authored-by: Evan <[email protected]> * chore: make rust functions more eloquent (#105) * make rust functions more eloquent * with_icon_bytes consumes self * navigation works * WIP box position display * box indicator is temporary and sizes better * cargo lock changes --------- Co-authored-by: evanwporter <[email protected]> Co-authored-by: Evan <[email protected]>

evanwporter and others added 12 commits December 22, 2024 01:40

Resource pack backend

7ba51eb

simplified download_images_from_github_folder

47ed4d9

Added to tauriInvoker

e6f7ef7

Added button to Settings to download gen1 sprite pack.

1a71eac

ran linter

d9250c2

initial plugin downloading/management

00acc63

plugin card styling

16a13af

fix for missing plugin folder

b7862f7

async plugin download

4914d52

keep home mounted

3d77281

housekeeping

cc2eae9

move gen 7 sprites to plugin

f30e1d0

andrewbenington mentioned this pull request Dec 27, 2024

Download Sprites as Resource Packs #93

Closed

andrewbenington added 6 commits December 26, 2024 23:00

start persisting enabled plugins

229ef12

Merge branch 'main' into plugin-system

1838886

Merge branch 'main' into plugin-system

d7531cb

Merge branch 'main' into plugin-system

867c9c9

plugin enabled status persists correctly

17337ab

move gen 6 sprites to plugin

7a66c55

andrewbenington mentioned this pull request Dec 28, 2024

Low quality pokemon sprites on windows #89

Closed

evanwporter reviewed Dec 29, 2024

View reviewed changes

andrewbenington added 4 commits December 29, 2024 16:30

newline

4b25cf4

bump version

3af4e98

standardize icon.png and assets dir

7376cee

image url update

c740e5e

evanwporter added 2 commits December 30, 2024 14:00

Created delete plugin command

8603fcd

Merge branch 'main' into plugin-system

d46385e

evanwporter added 2 commits December 30, 2024 15:57

added deletePlugin to tauri invoker

f40dca5

Added deletePLugin to backend

1df2d3e

evanwporter added 2 commits December 30, 2024 17:01

made changes

9ec4040

implmented deletion of plugin

1e0508c

ran linter

1d5da02

evanwporter and others added 11 commits December 31, 2024 13:54

Moved code w/i delete_plugin to generic util::delete_folder.

05049bb

This is so it can be reused in the future

Fixed display

88fed7b

Fixed plugin icon covering chips

e068857

added deletePlugin to dummy backend

c06149d

delete icon styling

7abf855

update plugin metadata fields

7eb0b50

log plugin sprite error instead of displaying

d8bb96f

cleanup plugin state on delete

1265c21

coalesce plugin actions

84f2016

include version and api_version in downloaded metadata

6e48e12

merge main

4e9fbf8

andrewbenington marked this pull request as ready for review January 1, 2025 23:18

andrewbenington requested a review from evanwporter January 1, 2025 23:18

andrewbenington merged commit 434f2a5 into main Jan 2, 2025
3 checks passed

andrewbenington deleted the plugin-system branch January 2, 2025 04:11

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: plugin system (currently just sprites) #95

feat: plugin system (currently just sprites) #95

andrewbenington commented Dec 25, 2024 •

edited

Loading

evanwporter left a comment

andrewbenington commented Dec 29, 2024

evanwporter commented Dec 29, 2024

andrewbenington commented Dec 30, 2024 •

edited

Loading

evanwporter commented Dec 31, 2024 •

edited

Loading

evanwporter commented Dec 31, 2024

andrewbenington commented Dec 31, 2024 •

edited

Loading

andrewbenington commented Jan 2, 2025

evanwporter commented Jan 2, 2025 •

edited

Loading

evanwporter commented Jan 2, 2025 •

edited

Loading

andrewbenington commented Jan 2, 2025

evanwporter commented Jan 2, 2025

feat: plugin system (currently just sprites) #95

feat: plugin system (currently just sprites) #95

Conversation

andrewbenington commented Dec 25, 2024 • edited Loading

evanwporter left a comment

Choose a reason for hiding this comment

andrewbenington commented Dec 29, 2024

evanwporter commented Dec 29, 2024

andrewbenington commented Dec 30, 2024 • edited Loading

evanwporter commented Dec 31, 2024 • edited Loading

evanwporter commented Dec 31, 2024

andrewbenington commented Dec 31, 2024 • edited Loading

andrewbenington commented Jan 2, 2025

evanwporter commented Jan 2, 2025 • edited Loading

evanwporter commented Jan 2, 2025 • edited Loading

andrewbenington commented Jan 2, 2025

evanwporter commented Jan 2, 2025

andrewbenington commented Dec 25, 2024 •

edited

Loading

andrewbenington commented Dec 30, 2024 •

edited

Loading

evanwporter commented Dec 31, 2024 •

edited

Loading

andrewbenington commented Dec 31, 2024 •

edited

Loading

evanwporter commented Jan 2, 2025 •

edited

Loading

evanwporter commented Jan 2, 2025 •

edited

Loading