diff --git a/README.md b/README.md index 3f51618..9954c2b 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,40 @@ # comfyui-discord -A simplified interface to ComfyUI through Discord \ No newline at end of file +A simplified interface to ComfyUI through Discord + +###### Quick Start + +1. Run `comfyui-discord.sh` to create `settings.json` + +2. Put your Discord bot's token in `settings.json` + +3. Set a channel's topic to `example-workflow` + +4. Run `comfyui-discord.sh` + +5. Send a message in that channel, e.g. + + ``` + steps25 cfg8 width512 height480 > a bowl of fruit on a wooden desk -red, strawberry, red apple, raspberry, metal x4 + ``` + +6. Observe the bot's response with attachment + +###### Explanation + +The message above is broken into a several compontents: + + * `steps` - 25 + * `cfg` - 8 + * `width` - 512 + * `height` - 480 + * `positive`: "a bowl of fruit on a wooden desk" + * `negative`: "red, strawberry, red apple, raspberry, metal" + * `repeat_n_times`: 4 + +...and is passed to ComfyUI by loading `example-workflow.json` and making text replacements, e.g. + + * `__STEPS__` with `25` + * `__POSITIVE__` with `a bowl of fruit on a wooden desk` + +The `example-workflow_settings.json` file can be used to provide default values that are left unspecified in the user's message. For example, keys `width` and `height` can be set in `example-workflow_settings.json` and used for direct replacements of `__WIDTH__` and `__HEIGHT__` in the API workflow JSON body.