-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Write Home, Installation and Updating page.
- Loading branch information
Showing
5 changed files
with
174 additions
and
1 deletion.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,21 @@ | ||
# About Allor | ||
|
||
![logo](documentation.png) | ||
|
||
> Welcome to `ComfyUI Allor Documentation`. Now you are ready for a new big step. | ||
## Introducing Allor | ||
|
||
**Allor**, is a plugin for **ComfyUI**, is your go-to solution for image post-processing. Here's why: | ||
|
||
- **Transparency Support**: Allor fully supports RGBA, ensuring your images maintain their quality and integrity. | ||
|
||
- **Batch Processing**: Have multiple images to process? No problem. Allor can handle batch image processing with ease. | ||
|
||
- **Versatile Modules**: With over 100+ nodes spread across various modules, Allor is equipped to handle a wide range of tasks. | ||
|
||
- **Customizable**: Tailor Allor to your needs. From modules to fonts, you have the freedom to configure it as you see fit. | ||
|
||
- **Self-Updating**: To provide you with the latest features and improvements, Allor has the ability to update itself. | ||
|
||
Now you are ready for Installing stage. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
# Alpha Chanel | ||
|
||
![alpha_chanel](alpha_chanel.png) | ||
![alpha_chanel](alpha_chanel.png){ border-effect="rounded" } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,119 @@ | ||
# Installation | ||
|
||
> Before installing Allor, you need to have ComfyUI installed, | ||
> see [here](https://github.com/comfyanonymous/ComfyUI#installing) how it can be done. | ||
> {style="note"} | ||
## Requirements | ||
* ComfyUI | ||
* Python 3.10 or above | ||
|
||
## Installing with manager | ||
|
||
If you have [ComfyUI-Manager](https://github.com/ltdrdata/ComfyUI-Manager) installed you can just install Allor by | ||
manager. | ||
|
||
## Installing with direct download | ||
|
||
<tabs group="installing"> | ||
<tab title="Installation for Unix" group-key="unix"> | ||
|
||
1. **Download Allor**: Download the [Allor ZIP archive](https://github.com/Nourepide/ComfyUI-Allor/archive/refs/heads/main.zip). | ||
|
||
2. **Unzip the Archive**: Unzip the downloaded archive to the `ComfyUI/custom_nodes` directory. | ||
|
||
3. **Run the Installation Script**: Execute the `install.sh` file. You can do this from the terminal with the following command: | ||
|
||
```bash | ||
bash install.sh | ||
``` | ||
|
||
4. **Run ComfyUI**: Finally, run ComfyUI. | ||
|
||
</tab> | ||
<tab title="Installation for Windows" group-key="windows"> | ||
|
||
1. **Download Allor**: Download the [Allor ZIP archive](https://github.com/Nourepide/ComfyUI-Allor/archive/refs/heads/main.zip). | ||
|
||
2. **Unzip the Archive**: Unzip the downloaded archive to the `ComfyUI\custom_nodes` directory. | ||
|
||
3. **Run the Installation Script**: Execute the `install.bat` file. You can do this from the command prompt with the following command or just click on it: | ||
|
||
```bash | ||
install.bat | ||
``` | ||
|
||
4. **Run ComfyUI**: Finally, run ComfyUI. | ||
|
||
</tab> | ||
</tabs> | ||
|
||
## Installing with Git | ||
|
||
<tabs group="installing"> | ||
<tab title="Installation for Unix" group-key="unix"> | ||
|
||
1. **Open Terminal**: Navigate to the `ComfyUI/custom_nodes` directory. You can do this by opening Terminal and using | ||
the `cd` command. | ||
|
||
2. **Clone the Repository**: Clone the repository by entering the following command: | ||
|
||
```bash | ||
git clone https://github.com/Nourepide/ComfyUI-Allor.git | ||
``` | ||
|
||
3. **Navigate to the Allor Folder**: Enter the Allor folder using the following command: | ||
|
||
```bash | ||
cd ComfyUI-Allor | ||
``` | ||
|
||
4. **Run the Installation Script**: Execute the `install.bat` script by entering the following command: | ||
|
||
```bash | ||
bash install.sh | ||
``` | ||
|
||
5. **Run ComfyUI**: Finally, run ComfyUI. | ||
|
||
</tab> | ||
<tab title="Installation for Windows" group-key="windows"> | ||
|
||
1. **Open Command Prompt**: Navigate to the `ComfyUI\custom_nodes` folder. You can do this by pressing <shortcut> | ||
Win+R</shortcut>, typing `cmd`, and pressing <shortcut>Enter</shortcut>. | ||
|
||
2. **Clone the Repository**: Clone the repository by entering the following command: | ||
|
||
```bash | ||
git clone https://github.com/Nourepide/ComfyUI-Allor.git | ||
``` | ||
|
||
3. **Navigate to the Allor Folder**: Enter the Allor folder using the following command: | ||
|
||
```bash | ||
cd ComfyUI-Allor | ||
``` | ||
|
||
4. **Run the Installation Script**: Execute the `install.bat` script by entering the following command: | ||
|
||
```bash | ||
install.bat | ||
``` | ||
|
||
5. **Run ComfyUI**: Finally, run ComfyUI. | ||
|
||
</tab> | ||
</tabs> | ||
|
||
## What does the installation script do? | ||
|
||
1. **Searches for the virtual environment**: The script checks for a Python virtual environment. | ||
|
||
2. **Installs dependencies**: If a `requirements.txt` file exists in the current directory, the script installs the dependencies listed in it. | ||
|
||
3. **Initializes a Git repository**: If Git is installed and the current directory is not already a Git repository, the script initializes a new Git repository and syncs it with a remote repository. | ||
|
||
4. **Uses GitPython**: If Git is not installed, the script uses GitPython, a Python library, to perform Git operations. | ||
|
||
5. **Finishes its work**: Finally, the script deactivates the Python virtual environment. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,38 @@ | ||
# Updating | ||
|
||
## Auto-Update | ||
|
||
**Allor** has the capability to **self-update**. By default, this happens **once a day**. | ||
|
||
If you wish to **modify this behavior** or **disable auto-update**, please refer to the **configuration page**. | ||
|
||
## Manual updating with Git | ||
|
||
> You need to have Git installed. | ||
<tabs group="updating"> | ||
<tab title="Updating for Unix" group-key="unix"> | ||
|
||
1. **Open Terminal**: Navigate to the `ComfyUI/custom_nodes/ComfyUI-Allor` directory. You can do this by opening Terminal and using | ||
the `cd` command. | ||
|
||
2. **Update the Repository**: Update the repository by entering the following command: | ||
|
||
```bash | ||
git pull | ||
``` | ||
|
||
</tab> | ||
<tab title="Updating for Windows" group-key="windows"> | ||
|
||
1. **Open Command Prompt**: Navigate to the `ComfyUI\custom_nodes\ComfyUI-Allor` folder. You can do this by pressing <shortcut> | ||
Win+R</shortcut>, typing `cmd`, and pressing <shortcut>Enter</shortcut>. | ||
|
||
2. **Update the Repository**: Update the repository by entering the following command: | ||
|
||
```bash | ||
git pull | ||
``` | ||
|
||
</tab> | ||
</tabs> |