ExileAPI Plugin Auto Update

[Queuete]

Hello community,

the latest version in my ExileAPI fork ships with a plugin AutoUpdate feature. This thread is meant to provide a "Guide" for using this feature and for plugin developers who want to make sure their plugin is compatible.


USER:
1. Download the latest Release from my ExileAPI fork: Releases . Queuete/ExileApi . GitHub
2. The currently used AutoUpdate settings can be seen in the "PluginAutoUpdate" Tab in the HUD main settings (press f12). Furthermore you can deactivate the whole feature or the update process for single plugins in there. The configuration for existing plugins can be changed here (expecially the github url, if you like to use a different fork of the same plugin)
3. Adding a Plugin is currently not supported in the settings menu (this will most likely change in the future). Therefore you need to edit the updateSettings.json file. To add a new plugin simply copy the configuration of one of the existing plugins, adapt it and add it to your list. The file needs to be in valid JSON format, this can be checked here: JSONLint - The JSON Validator
One regular mistake is having a trailing "," at the end of the list. The list needs to end WITHOUT a ","!

When you want to change a plugin URL you may need to delete the folder in the Source and Compiled folder.

If you want to change the config files of a plugin make sure you do your changes in "Plugins/Compiled/PluginName". Changes in the Source folder will be overwritten on start up.

Disclaimer: Due to the nature of a auto plugin functionality this will run code downloaded from repositories on your pc. You should not use repositories from owners you dont trust. Running PoeHelper as admin will increase the risk.

I want to keep a list with (working) plugins here aswell, if you look for ideas you may find them here:
- DevTree, GitHub - Queuete/DevTree: Plugin vor ExileApi. Base taken from https://github.com/Qvin0000/ExileApiPlugins
- HealthBars, GitHub - Queuete/HealthBars
- MinimapIcons, GitHub - Queuete/MinimapIcons: Plugin vor ExileApi. Base taken from https://github.com/Qvin0000/ExileApiPlugins
- IconsBuilder, https://github.com/Queuete/IconsBuilder
- Stashie, https://github.com/Craere/Stashie
- BuffUtil, https://github.com/Queuete/BuffUtil
- BasicFlaskRoutine, https://github.com/Queuete/BasicFlaskRoutine
- AutoQuit, https://github.com/Queuete/AutoQuit
- PreloadAlert, https://github.com/Queuete/PreloadAlert
- DeliriumSpawnerHighlight, https://github.com/Queuete/DeliriumSpawnerHighlight
- PickIt, (my simplyfied version)https://github.com/Queuete/PickIt, https://github.com/DetectiveSquirrel/Pickit
- HighlightedItems https://github.com/ravand1990/HighlightedItems


PLUGIN DEVELOPER:
When you are new you may want to check out the Github repository on "How to set up a developer version" this will currently ship with a bunch of plugins in which you can see how plugins are handled.
https://github.com/Queuete/ExileApi/...ster/README.md

1. If you have any external dependencies, which are not included in ExileAPI, put them in a folder called "libs" in your source. This folder needs to be at the same level as your .csproj file.
2. Static files (e.g. config or image files) either need to be generated in code (see Stashie) or placed in a folder which is copied by the updater.
Possible folder names which are copied: Dependencies: "libs", "Libs", "lib", "Lib". Other static files: "settings", "Settings", "config", "Config", "images", "Images", "img", "Img", "static", "Static"

To automate the process of adding your external dependencies you can use "(post) build events"
In your Solution explorer right click the plugin project -> Proeperties -> Tab Build Events -> Post-build event command line.
Example: copy "$(TargetDir)Dependency.dll" "$(ProjectDir)libs\Dependency.dll"

https://docs.microsoft.com/de-de/vis...p?view=vs-2019


Feel free to add information on Plugins in the thread, for example if you want them added to the list or they are not working (yet) with the update feature. If you are the "original owner" of one of the listed plugins and want your repository added to the list please reach out to me.

Best Regards,
Queuete

[piggottrichard]

i think this is a great addition to the base HUD could you also include pickit please

[Queuete]

i think this is a great addition to the base HUD could you also include pickit please

You can definitly add my simplyfied version of it without any problems: GitHub - Queuete/Pickit. On how to add it see "USER 3." in the first post.
This version always picks up everything. IngameItem filters do the "heavy lifting" on deciding which items to pick and they are way easier and better to customize. If you really want the full version it should work aswell, but I have not tried it this is the repository: GitHub - DetectiveSquirrel/Pickit