From 3857d35b7d3ce3088db34383b2f58cee35269da4 Mon Sep 17 00:00:00 2001 From: Nourepide Date: Sat, 25 Nov 2023 05:56:56 +0300 Subject: [PATCH] Write Configuration page. --- Writerside/topics/Configuration.md | 154 +++++++++++++++++++++++++++++ 1 file changed, 154 insertions(+) diff --git a/Writerside/topics/Configuration.md b/Writerside/topics/Configuration.md index a025a48..97aeb80 100644 --- a/Writerside/topics/Configuration.md +++ b/Writerside/topics/Configuration.md @@ -1 +1,155 @@ # Configuration + +**Allor** can be configured using the `config.json` file. This file is created during the **first launch** of Allor, +based on the template found in `template/template.json`. + +In the event of an **update**, the configuration file **automatically adapts** to all changes. It **preserves old +parameters** while removing outdated ones and applying new ones. This ensures that your configuration stays +**up-to-date** with the latest features and improvements. + +## Modules + +In this section, you have the ability to **disable** any modules that you do not need to load. By default, all modules +are **enabled** (set to `true`). + +| Name | Type | Default | Description | +|-------------------|---------|---------|--------------------------------------------------| +| AlphaChanel | Boolean | True | Manages the transparency of images. | +| Clamp | Boolean | True | Manage nodes for readability. | +| ImageBatch | Boolean | True | Handles batch image processing. | +| ImageComposite | Boolean | True | Combines multiple images into one. | +| ImageContainer | Boolean | True | Get images size as container. | +| ImageDraw | Boolean | True | Draws shapes onto images. | +| ImageEffects | Boolean | True | Applies various effects to images. | +| ImageFilter | Boolean | True | Filters images using different algorithms. | +| ImageNoise | Boolean | True | Adds or reduces noise in images. | +| ImageSegmentation | Boolean | True | Divides an image background. | +| ImageText | Boolean | True | Create text as images. | +| ImageTransform | Boolean | True | Transforms images by rotating, scaling, and etc. | + +## Override + +With **Allor**, you have the flexibility to **disable** the standard nodes of ComfyUI that have similar functionality +available in Allor. By default, all overrides are **disabled** (set to `false`). + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefaultOriginalNew
postprocessingBooleanFalseImageBlend-
ImageBlurImageFilterBlur
ImageFilterBoxBlur
ImageFilterGaussianBlur
ImageFilterGaussianBlurAdvanced
ImageFilterStackBlur
ImageFilterMedianBlur
ImageFilterBilateralBlur
ImageQuantize-
ImageSharpen-
transformBooleanFalseImageScaleImageTransformResizeAbsolute
ImageScaleByImageTransformResizeRelative
ImageInvertImageTransfromRotate
ImageTransformTranspose
debugBooleanFalseLatentBlend-
LoadLatent-
SaveLatent-
TomePatchModel-
FreeU-
FreeU_V2-
HyperTile-
+ +## Updates + +In this section, you can **configure the auto-update feature** of Allor or even **disable it** entirely. + +| Name | Type | Default | Description | +|---------------------------|---------|---------|------------------------------------------------------------------------------------------------| +| update_frequency | String | day | Sets how often Allor should check for updates. Available - Always, Never, Day, Week and Month. | +| notify_if_has_new_updates | Boolean | True | Notify you when new updates are available | +| notify_if_no_new_updates | Boolean | True | Notify you when there are no new updates. | +| auto_update | Boolean | True | Automatically update itself if update available. | +| branch_name | String | main | Specifies the branch that Allor should pull updates from. | + +## Fonts + +Some nodes require fonts to function. In this section, you can configure where **Allor** should look for these fonts. + +| Name | Type | Default | Description | +|--------------|---------|--------------------|---------------------------------------------------------------------------------------------------------| +| folder_path | String | comfy_extras/fonts | Specifies the path where Allor should look for fonts. You can use `\` or `/` symbol for path splitting. | +| system_fonts | Boolean | False | Use the system’s fonts. | +| user_fonts | Boolean | False | Use the user's fonts. Doesn't affect on Windows because all fonts contains in system folder. |