Grimoire
Settings
Manage servers, model imports, workflow history, workflow queue visibility, seed visibility, and saved dialog state.
What Is This?
The Settings tab handles the Grimoire runtime: server controls, model imports, workflow-history retention and loading, workflow queue visibility, seed visibility, and saved UI state. You usually visit it during initial setup, when adding new assets, or when the dialog state needs cleanup.
Server Configuration
The plugin runs two background services:
- ComfyUI — runs the local node graph and local model inference.
- Middleman — bridges Aseprite, ComfyUI, and the hosted API providers.
Both services need to be available when Grimoire opens because the dialog fetches node metadata before it builds the tabs.
Server Status
Shows whether the ComfyUI and middleman servers are currently running, starting, or stopped. Check this if generations are failing or the plugin is unresponsive.
Start Servers
Launches both services.
Stop Servers
Stops both services so you can free resources or fully reset the runtime.
Restart Servers
Stops and starts both services again. Use this after importing models, changing runtime files, or recovering from a stuck state.
ComfyUI Port
The network port ComfyUI listens on. Default: 8288.
Only change this if port 8288 is already in use by another application on your machine. Must match whatever port the middleman is configured to connect to.
Middleman Port
The network port the middleman server listens on. Default: 8388.
Only change this if port 8388 is already in use.
On macOS and Linux, Black Magik usually auto-starts these after setup. On all platforms, the same actions are also available from Edit > Black Magic > Servers.
Import Models
Models are the files the local workflows use. You need at least one checkpoint for local prompt-based generation. LoRAs, ControlNets, CLIP Vision models, IPAdapter assets, and other model types unlock the advanced tabs.
How to Import a Model
- Select the Model Type from the dropdown (this determines which subfolder the file goes into).
- Click the file picker and choose your
.safetensorsfile. - Click Import Model.
Black Magik copies the file into the matching ComfyUI model folder, then tries to refresh node metadata immediately so the new asset appears in the UI. If the refresh fails, the file is still imported; use Refresh Node Definitions or restart the servers to update the lists.
Extra Model Actions
| Action | What It Does |
|---|---|
| Open Models Folder | Opens the local ComfyUI models directory. |
| Refresh Node Definitions | Re-fetches ComfyUI object metadata and rebuilds the Settings tab so newly imported models and nodes can appear without a full restart. |
Model Types Reference
Choose the type that matches what you are installing. This tells the plugin which folder to put the file into so ComfyUI can find it.
The five types most users will ever need:
| Type | What to put here |
|---|---|
| checkpoints | The main AI model files that power all generation. These are the largest files — typically 2–7 GB each. Every generation tab requires at least one. |
| loras | Small style or character add-on files, typically 50–200 MB. They nudge an existing checkpoint toward a specific look without replacing it. |
| clip_vision | Image encoder models used by the IPAdapter tab so it can “understand” your reference image. |
| ipadapter | The IPAdapter model files that let a reference image guide the style of your generation. |
| controlnet | ControlNet model files for structural guidance (pose, depth, edges, etc.). |
The dropdown also exposes other ComfyUI model folders for advanced setups, including audio_encoders, configs, diffusion_models, latent_upscale_models, model_patches, photomaker, RMBG, style_models, and vae_approx.
Less common types — only needed for specific advanced setups:
| Type | What it is |
|---|---|
| vae | A small file that converts between the model’s internal compressed format and actual image pixels. Most checkpoints include one already; only install separately if a model requires it. |
| upscale_models | Models that enlarge images while preserving or adding detail (e.g. Real-ESRGAN). |
| embeddings | Very small files that teach the model a new concept using a short trigger word you add to your prompt. |
| clip / text_encoders | Text understanding models. Only needed if you are using a split-format model (some newer architectures distribute this as a separate file). |
| unet | The core generation network. Only needed if you are using a split-format model. |
| hypernetworks | An older style-transfer format. Rarely used today — LoRAs have replaced them. |
Generation History Limit
Controls how many automatically saved workflow history entries Black Magik keeps for the local generation tabs.
What it affects
- Text to Image
- Img2Img
- In/Outpaint
- IPAdapter
- ControlNet
Older history entries are pruned automatically when new runs are saved. Manual Save Workflow snapshots are separate from this auto-history.
Workflow Queue
The Workflow Queue is a small floating status window for local ComfyUI generations. It shows the current queue length, the active job progress, and a Cancel Current button.
Show Workflow Queue
Controls whether the Workflow Queue window opens with Grimoire. It is enabled by default. Closing the Workflow Queue window turns this setting off; re-enable it here if you want the queue window back.
This queue is used for local generation workflows and canvas-processing tools such as Pixelization, Palette Reduction, Wang Tileset generation, and K-centroid resize. Hosted API providers can still show provider-specific progress dialogs.
Sampling
Show Seed Number
Controls whether the numeric KSampler seed field is visible in the generation tabs.
This is disabled by default. When it is off, Grimoire still generates and updates seeds internally, and the Seed Generation dropdown plus seed action button still work. Enable it when you need to inspect, copy, or edit an exact seed.
Warning: showing the seed number may cause the Aseprite UI scrollbar to jump.
Saved Tab State
Black Magik stores the last-used UI state for each major tab so the dialog comes back the way you left it.
Clear Saved Tab Settings
Deletes those persisted tab-state files and resets the tabs back toward their defaults.
Use this if:
- a tab keeps reopening with bad values
- the saved state feels stale after a workflow change
- you want a clean reset without deleting models or saved workflow snapshots
This does not remove imported models or saved workflow files.
Generation Menu State
Reset Generation Bounds
Restores the Grimoire dialog window to its default size and position.
Use this if:
- the dialog opens too small
- the dialog moved partly off-screen
- the saved bounds no longer make sense on your current display
Default size: 500x500.
Workflow History
The Workflow History controls sit at the bottom of the Settings tab. They load reusable workflow setups from the ComfyUI output folder and show both manually saved snapshots and automatic history entries from the local generation tabs.
| Control | What It Does |
|---|---|
| Saved and Generated Workflows | Lists saved snapshots first, then automatic history entries. |
| Refresh | Re-reads the output folder and updates the dropdown. |
| Load | Opens the workflow on its original generation tab and restores the saved UI state. |
Entries prefixed with Saved: come from Save Workflow and are not pruned automatically. Entries prefixed with History: are created when you generate from Text to Image, Img2Img, In/Outpaint, IPAdapter, or ControlNet, and are pruned by Generation History Limit.