add documentation for plugins & refactor more

This commit is contained in:
2023-05-24 12:34:35 +02:00
parent 1fa50afd01
commit e59e7f5101
6 changed files with 26 additions and 76 deletions

11
website/plugins.md Normal file
View File

@@ -0,0 +1,11 @@
# Writing plugins for ImageVideoUpscaler
Your plugin has to fulfill the following requirements:
- Name of class it exposes has to be [name of engine]Scaler. The name of the file should be just the name of the engine in all lower case.
- It has to support a folder or an individual file as an input and the function, has to take the following arguments:
Argument | Variable type
---------|---------------
x | y
- The function has to return the path to the folder where the final resulting images are located.