Arcane Artifex README
Arcane Artifex is a powerful Foundry VTT module that facilitates the creation of visual content directly within your gaming sessions. This module integrates with several AI-powered image generation systems, enabling Game Masters to enhance their storytelling by generating images based on textual prompts provided within the Foundry VTT chat interface.
Supported Endpoints
Stable Diffusion endpoints (either local or via appropriate tunnel e.g. ngrok) with selectable models, schedulers, sampler, and resolutions with optional upscalers and LoRAs (with weights)
- ComfyUI: A local or accessible installation using Stable Diffusion with custom workflows including support for custom workflows. Current workflows include fast, complex-prompt, and animation flows with more to come.
- Automatic1111: A local or accessible online installation using Stable Diffusion with Face Restore and Creative Upscaling
Web-Based Image Solutions
- AI Horde: An online service offering cloud-based image generation with SD1.5 and SDXL models and LoRAs, usable with an API key.
- Stable Diffusion 3: An advanced iteration of Stable Diffusion available online that requires a Stability API key for operation.
- DALL-E 3: Utilizes OpenAI's DALL-E 3 for generating high-quality images from prompts, accessible online with an API key.
Setup Instructions for Local Install - Automatic1111 or ComfyUI
Before using Arcane Artifex in your Foundry VTT environment, ensure that your webUI for Stable Diffusion is operational. Follow these steps to prepare the environment:
-
Start Stable Diffusion with Necessary Flags: For Automatic1111:
--listen --api --cors-allow-origins="[your_local_ip_of_foundry]"
For ComfyUI, start the service with:
python main.py --enable-cors-header [your_local_ip_of_foundry] (e.g. http://localhost:30000)
-
Launching Foundry VTT: Launch your Foundry VTT world where Arcane Artifex is installed, ensuring it can access the machine where Stable Diffusion is running.
Configuration of Web-Based Image Generation
To use web-based image generation services like Stable Horde, Stable Diffusion 3, or DALL-E 3, follow these setup instructions:
-
Obtain API Keys: Secure an API key for each service you intend to use. These keys are necessary to access the services and generate images.
-
Store API Keys Securely: Enter and store the API keys as passwords within Foundry VTT's Game Settings to ensure they are kept secure.
-
Select Your Service: In the Arcane Artifex settings panel within Foundry VTT, choose the web-based service you wish to use for image generation.
Generating Images
-
In-Game Image Generation: To generate an image, the Game Master initiates a chat message starting with the trigger
:aa:
followed by the desired prompt. For example::aa: A majestic castle at sunset
The content after the trigger is sent as a prompt to the configured image generation backend.
-
Customizing Prompts: The beginning of the prompt can be customized in the module's settings to include any required prefixes or stylistic choices that influence the generation style (e.g. Pony scores, etc.)