From e00a30a09e7d3cbbb84569e81793bbaff1a77d2d Mon Sep 17 00:00:00 2001
From: daxcay <164315771+daxcay@users.noreply.github.com>
Date: Sat, 24 Aug 2024 12:44:10 +0530
Subject: [PATCH] Update README.md
---
README.md | 232 ++++++++++++++++++++++++++++++++++++------------------
1 file changed, 155 insertions(+), 77 deletions(-)
diff --git a/README.md b/README.md
index c80cb5d..d6b7ee8 100644
--- a/README.md
+++ b/README.md
@@ -1,117 +1,195 @@
-
+
# ComfyUI-Nexus
- 
+ 
-A ComfyUI node designed to enable seamless multiuser workflow collaboration. This innovative tool allows teams to work together both locally and remotely, making collaboration a breeze.
-
-### Key Features:
-
- - **Multiuser Collaboration**: enable multiple users to work on the same workflow simultaneously.
- - **Local and Remote Access**: use tools like ngrok or other tunneling software to facilitate remote collaboration. A local IP address on WiFi will also work 😎.
- - **Enhanced Teamwork**: streamline your team's workflow management and collaboration process.
- - **Real-Time Chat**: communicate directly within the platform to ensure smooth and efficient collaboration.
- - **Spectate Mode**: allow team members to observe the workflow in real-time without interfering, perfect for training or monitoring progress.
- - **Admin Permissions**: admins can control who can edit the workflow and who can queue prompts, ensuring the right level of access for each team member.
- - **Workflow backup**: in case of any mishap you can reload a old backup. the node save 5 workflow 60 seconds apart.
+A ComfyUI node designed to enable seamless multi-user workflow collaboration. This innovative tool allows teams to work together both locally and remotely, making collaboration a breeze.
-### Key Binds:
+## Key Features
- - **Activate Chat**: press **`t`**
- - **Show/Hide Users** press **`LAlt + p`**
- - **Show/Hide Backups** press **`LAlt + o`** (for editors only)
+- **multiuser collaboration**: enable multiple users to work on the same workflow simultaneously.
+- **local and remote access**: use tools like ngrok or other tunneling software to facilitate remote collaboration. A local IP address on WiFi will also work 😎.
+- **enhanced teamwork**: streamline your team's workflow management and collaboration process.
+- **real-time chat**: communicate directly within the platform to ensure smooth and efficient collaboration.
+- **spectate mode**: allow team members to observe the workflow in real-time without interfering—perfect for training or monitoring progress.
+- **admin permissions**: admins can control who can edit the workflow and who can queue prompts, ensuring the right level of access for each team member.
+- **workflow backup**: in case of any mishap, you can reload an old backup. The node saves 5 workflows, each 60 seconds apart.
+
+## Key Binds
+
+- **activate chat**: press **`t`**
+- **show/hide users panel**: press **`LAlt + p`**
+- **show/hide backups panel**: press **`LAlt + o`** (for editors only)
+
+## Chat Commands
+
+- `/nick `: changes your nickname
+- `/login account password`: this command is used to become admin.
+- `/logout`: logout the admin.
## Installation
-#### Using `comfy-cli` (https://github.com/yoland68/comfy-cli)
- - `comfy node registry-install ComfyUI-Nexus`
- - https://registry.comfy.org/publishers/daxcay/nodes/comfyui-nexus
-
-#### Manual Method
- - Go to your Comfyui > Custom Nodes folder path > Run CMD
- - Copy and Paste this command git clone ```https://github.com/daxcay/ComfyUI-Nexus.git```
- - Then go inside ComfyUI-Nexus with cmd or open new.
- - type ```pip install -r requirements.txt``` to install the dependencies
+### Using `comfy-cli`
+- `comfy node registry-install ComfyUI-Nexus`
+- [Node Registry](https://registry.comfy.org/publishers/daxcay/nodes/comfyui-nexus)
-#### Automatic Method with [Comfy Manager](https://github.com/ltdrdata/ComfyUI-Manager)
- - Inside ComfyUI > Click Manager Button on Side.
- - Click `Custom Nodes Manager` and Search for `Nexus` and Install this node:
+### Manual Method
-#### Restart ComfyUI and it should be good to go
+- Go to your ComfyUI > Custom Nodes folder path > Run CMD
+- Copy and paste this command: `git clone https://github.com/daxcay/ComfyUI-Nexus.git`
+- Then go inside `ComfyUI-Nexus` with CMD or open a new one.
+- Type `pip install -r requirements.txt` to install the dependencies.
+### Automatic Method with [Comfy Manager](https://github.com/ltdrdata/ComfyUI-Manager)
+
+- Inside ComfyUI > Click the Manager Button on the side.
+- Click `Custom Nodes Manager` and search for `Nexus`, then install this node.
+
+### Restart ComfyUI, and it should be good to go.
-## One Time Setup
+## One-Time Setup
-> **Note**: Only for someone hosting the comfy server.
+> **Note**: Only for someone hosting the ComfyUI server.
-
+### Setting Admin Password
-### Setting admin password
- - Go to comfyui folder > **nexus** folder > admins.json
-
- 
+- Go to the `comfyui` folder > `nexus` folder > `admins.json`
- - Write any account name and password but make sure to not have spaces.
-
- 
+ 
+- Write any account name and password, but make sure not to use spaces.
-#### Restart ComfyUI and it should be good to go
-
+ 
-### Using Ngrok to host server
+### Restart ComfyUI, and it should be good to go.
- - Go to this link: https://dashboard.ngrok.com/signup?ref=home-hero
- - After signup and login go to this link: https://dashboard.ngrok.com/get-started/setup/windows
- - After installing and setup of ngrok just run this command: `ngrok http `
+### Using Ngrok to Host Server
- 
+- Go to this [link](https://dashboard.ngrok.com/signup?ref=home-hero) to sign up.
+- After signing up and logging in, go to this [link](https://dashboard.ngrok.com/get-started/setup/windows) to set up ngrok.
+- After installing and setting up ngrok, just run this command: `ngrok http `
- 
+ 
+ 
+ 
- 
+- Share this with your brother or friends for collaboration.
- - Share this with your brother or friends in colloboration.
- - I will attach a setup video soon.
-
+### Using Your IP Address to Host Server
-### Using your ip address to host server
-
- - Open a cmd and write `ipconfig`
-
- 
-
- - Now copy this address like in my case its `http://192.168.1.45:` so final url will be: `http://192.168.1.45:5000`
- - Share this with your brother or friends in colloboration.
-
-#### Ngrok and WiFi address will change if you restart the machine or application itself.
-
-
-
-## Real time chat window
-
-When you join the comfy for the first time you will see this chat windows on to left corner like this.
-
-
-
-To chat you have to press `t`. then you write the message and press 'Enter'.
-
-
+- Open a cmd and write `ipconfig`.
+ 
+- Now copy this address. For example, if it's `http://192.168.1.45:`, the final URL will be: `http://192.168.1.45:5000`
+- Share this with your brother or friends for collaboration.
+> Ngrok and WiFi address will change if you restart the machine or application. so follow above steps if somthing goes wrong.
## Permissions in ComfyUI-Nexus
- - **Viewer**: Default permission given to person joining.
- - **Editor**: Person having permission to edit the workflow
- - **Queue Prompt**: Person having permission to queue the workflow
+- **viewer**: default permission given to a person joining.
+- **editor**: person having permission to edit the workflow.
+- **queue prompt**: person having permission to queue the workflow.
+
+> Admin has all permissions by default.
+
+## Real-Time Chat Window
+
+When you join ComfyUI for the first time, you will see this chat window in the top left corner:
+
+
+
+To chat, press `t`, then write the message and press 'Enter'.
+
+
+
+
+### Chat Commands
+
+- `/nick `: changes your nickname
+- `/login account password`: this command is used to become admin.
+- `/logout`: logout the admin.
+
+
+## User Panel
+
+To show/hide the user panel, press `LAlt + p`.
+
+**For users, the user panel will look like this:**
+
+
+
+Users can perform the following actions on a joined user:
+
+
+
+- **mouse**: show/hide the mouse of other players.
+- **spectate**: enable/disable spectate mode. Main use case: when you want to see or learn something from another user.
+
+**For admins, the user panel will look like this:**
+
+
+
+Admins can perform the following actions on a joined user:
+
+
+
+- **editor**: give/revoke editor permission to/from that user. Anyone with this permission can edit the workflow.
+- **queue**: give/revoke queue permission to/from that user. Anyone with this permission can queue the workflow.
+
+
+## Backup Panel (For Admins and Editors Only)
+
+To show/hide the backup panel, press `LAlt + o`.
+
+**The backup panel looks like this:**
+
+
+
+- **load**: load the backup on ComfyUI. If the admin presses it, it will load for all users.
+
+> Backups are saved 60 seconds apart. To load a workflow dragged by an admin, the admin will have to wait 60 seconds to let the server make a backup, then load it for all users.
+
+
+## Future Updates
+
+- Based on feedback, I will add/update features.
+- Multi-room collaboration.
+- Users can set their own color for names and mouse cursors.
+
+
+# Contact and Support
+
+### Patreon: [link](https://patreon.com/daxtoncaylor)
+
+### Support My Mission:
+
+By becoming a Patron, you'll gain exclusive benefits, including:
+
+- Early Access: Get early access to development releases and resources.
+- Feature Voting: Participate in polls to guide my development.
+- Exclusive Perks: Receive a special role in our Discord Server.
+
+Join me in my goal of creating a more robust and intuitive AI collaboration experience for everyone. Your support will help drive innovation and improve the ComfyUI ecosystem.
+
+### Daxton Caylor - ComfyUI Node Developer
+
+ - ### Contact
+ - **Twitter**: @daxcay27
+ - **Email** - daxtoncaylor@gmail.com
+ - **Discord** - daxtoncaylor
+ - **DiscordServer**: https://discord.gg/Z44Zjpurjp
+
+ - ### Support
+ - **Buy me a coffee**: https://buymeacoffee.com/daxtoncaylor
+ - **Support me on paypal**: https://paypal.me/daxtoncaylor