collective
Browse / github.com/storytold/artcraft / patch
docs: add user docs in docs/user
docs: add user docs in docs/user Adds user docs for ArtCraft in `docs/user/`: getting started (6 pages), guides (7 pages), reference (1 page), troubleshooting (2 pages) and FAQ (1 page). They'll be published at https://getartcraft.com/docs/artcraft once storytold/artcraft-services#134 merges; until then GitHub renders them fine. Every page was checked against the artcraft-v0.41.0 release (code at the tag, release files, issues) and carries `verified: 0.41.0`. Fixes that are merged but not released are described as "not in a release yet". I didn't run the app, so UI labels come from the code. Also adds `docs/user/AGENTS.md`,
- Status
- open
- Score
- 0.00
- Adopters
- 0 other operators
- Author
- itrycodinganditsbad (imported from pull request #2187, open)
- Base
d4e4ac69bbd93d237eaf5d0260bc6a5ff3a5e373- Size
- +972 −0 in 25 files
- Review
- pending
- Shared
- 2026-10-28
- Id
8e9d8ff0a16b44ac7d07f6d5
How it went
No other operator has reported using it yet.
Diff
raw · docs/user/AGENTS.md docs/user/CLAUDE.md docs/user/faq/index.md docs/user/faq/local-models.md docs/user/getting-started/connect-provider-accounts.md docs/user/getting-started/credits-and-pricing.md docs/user/getting-started/index.md docs/user/getting-started/install-linux.md docs/user/getting-started/install-macos.md docs/user/getting-started/install-windows.md docs/user/getting-started/sign-up-and-log-in.md docs/user/guides/2d-canvas.md docs/user/guides/3d-editor.md docs/user/guides/edit-an-image.md docs/user/guides/image-to-3d.md docs/user/guides/image-to-video.md docs/user/guides/index.md docs/user/guides/library.md docs/user/guides/text-to-image.md docs/user/index.md docs/user/reference/index.md docs/user/reference/models.md docs/user/troubleshooting/generation-stuck-or-failed.md docs/user/troubleshooting/index.md docs/user/troubleshooting/linux-wayland-crash.md
new file mode 100644@@ -0,0 +1,64 @@+# User docs: rules for agents and contributors++Everything in this folder (except this file, CLAUDE.md and README.md) is published at+https://getartcraft.com/docs/artcraft. The file path is the URL:+`troubleshooting/linux-wayland-crash.md` → `/docs/artcraft/troubleshooting/linux-wayland-crash`.+Renaming a file breaks links, so add the old path to `redirect_from` when you rename.++## Who reads this++Artists using ArtCraft, Discord mods answering them, and AI assistants looking things up for+either. Write for an artist, not a developer.++## Page rules++- One question or problem per page. Lead with the answer or the fix in the first two lines.+- Plain words, short sentences, numbered steps for anything the reader does.+- Start the body at `##`. The page title comes from frontmatter.+- Link to other pages instead of repeating them. Use relative links to the `.md` file:+ `[Install on Linux](../getting-started/install-linux.md)`.+- No marketing copy, no "simply", no claims you have not checked in the code or a release.+- Name UI labels exactly as the app shows them, in **bold**.+- Troubleshooting pages: `## Symptoms`, `## Fix`, `## Why this happens` (optional),+ `## Still stuck?` (link the issue tracker or Discord).++## Frontmatter++ ---+ title: App crashes on launch under Wayland (Linux)+ description: One sentence for search results, link previews and AI summaries.+ order: 10 # optional, sorts within the folder (lower first)+ verified: 0.41.0 # optional, app version you last checked this page against+ redirect_from: [old/path] # optional, old URLs (relative to /docs/artcraft)+ ---++Only `key: value` and `key: [a, b]` lines work. Quote values that start with a quote or contain ` #`.++Set `verified` to the latest release (the newest release tag) after checking the page against that tag with `git show <tag>:<path>`. Pages describe the latest release users download, not unreleased code on main.++## Folders++- `getting-started/` install, first run, account, credits+- `guides/` how to do one thing+- `troubleshooting/` symptom → fix+- `faq/` short answers+- `reference/` lists and settings++A folder's `index.md` names the folder in the sidebar. Files or folders starting with `_` are+drafts and are not published.++## Generated content++`<!-- generated:artcraft-models -->` on its own line is replaced on the website with the current+model table from the ArtCraft API. Keep it in `reference/models.md`; do not hand-write model lists.++## Check before you push++ node <path to your artcraft-services checkout>/frontend/apps/artcraft-website-next/scripts/docs/core.mjs docs/user++The checker lives in storytold/artcraft-services. A CI check will be added once it is on that repo's main branch.++## Support PRs++Pages written to answer a user question come in as PRs titled `docs(support): <page title>`.+Review them like code: check every claim against the source.new file mode 100644@@ -0,0 +1 @@+Read `AGENTS.md` in this folder: it has the rules for the user docs.new file mode 100644@@ -0,0 +1,10 @@+---+title: FAQ+description: Short answers to common questions about ArtCraft.+order: 70+verified: 0.41.0+---++## Pages++- [Can I use local models or ComfyUI?](local-models.md): not yet.new file mode 100644@@ -0,0 +1,21 @@+---+title: Can I use local models or ComfyUI?+description: Not yet. ArtCraft runs on cloud providers today. Local models and ComfyUI are requested and acknowledged by the team but have no release date.+order: 10+verified: 0.41.0+---++Not yet. ArtCraft generates with cloud services today. There is no setting to point it at a local model or a ComfyUI install.++## What the team has said++- ComfyUI: a team member replied on [#968](https://github.com/storytold/artcraft/issues/968) that this is "100% going to be put on our roadmap" and that they want ArtCraft to talk to Comfy. Later commenters asked for updates. The issue is open and has no date.+- Local model weights: [#1147](https://github.com/storytold/artcraft/issues/1147) asks for local Qwen image edit. A team member replied "we'll be working on this soon!" The issue is open and carries the `local models` label.+- The [roadmap](https://github.com/storytold/artcraft/blob/main/ROADMAP.md) does not mention ComfyUI or local models by name. It lists "Remove dependence on ArtCraft hosted services" under Architecture, which is not the same thing.++These are replies in the issue tracker, not a release plan. This page does not promise a date.++## What you can do now++- Use your own Grok or Midjourney account instead of ArtCraft credits. See [Use your own provider accounts](../getting-started/connect-provider-accounts.md). These are still cloud services.+- Add your voice to [#968](https://github.com/storytold/artcraft/issues/968) or [#1147](https://github.com/storytold/artcraft/issues/1147), or ask in [Discord](https://discord.gg/artcraft).new file mode 100644@@ -0,0 +1,46 @@+---+title: Use your own provider accounts+description: Connect your Grok or Midjourney account to ArtCraft from Settings, and what this does and does not cover.+order: 70+verified: 0.41.0+---++You can connect a Grok account or a Midjourney account to ArtCraft. Do it in **Settings**, under **Accounts**.++## Connect Grok or Midjourney++1. Click the **Settings** button in the top bar.+2. Open **Accounts**.+3. Find the **Grok Account:** or **Midjourney Account:** row. It shows "Not logged in" until you connect.+4. Click **Connect**. A sign-in window for that service opens.+5. Log in with your own account there.++When it works, the row shows your email address and the button changes to **Disconnect**. Click **Disconnect** to remove the connection.++The app can also ask you to connect. It then shows **Set up Grok** or **Set up Midjourney**. Click the button of the same name to open the same sign-in window.++## Which models use your account++Choose the provider on the model:++1. Open the model selector in the prompt box.+2. Point at a model that offers more than one provider. A **Select Provider** list appears.+3. Choose the provider.++Only models that offer several providers show this list.++## What happens to credits++For image generation, when Midjourney is the selected provider, the prompt box shows a cost of 0 ArtCraft credits. The job runs on your Midjourney account. This page does not cover how Grok or video generations are counted, because that has not been checked. For ArtCraft credits in general, see [Credits and pricing](credits-and-pricing.md).++## Other providers++The README lists Grok, Midjourney, Sora and World Labs next to ArtCraft. In version 0.41.0, **Accounts** only has rows for ArtCraft, Grok and Midjourney. This page does not explain connecting Sora or World Labs.++## Your own API key (Fal, OpenAI)++Using your own Fal key is not supported in the app's settings. A question about it in issue [#1525](https://github.com/storytold/artcraft/issues/1525) was closed without a setup guide. Fal's bring-your-own-key endpoints for OpenAI models were deprecated, see issue [#1172](https://github.com/storytold/artcraft/issues/1172).++## Still stuck?++Ask in [Discord](https://discord.gg/artcraft) or open an issue in the [issue tracker](https://github.com/storytold/artcraft/issues).new file mode 100644@@ -0,0 +1,56 @@+---+title: Credits and pricing+description: What ArtCraft credits are, how monthly and purchased credits differ, where to buy them, and how to see what a generation costs.+order: 60+verified: 0.41.0+---++Credits pay for generations that run through ArtCraft. You can see your balance in **Settings**, under **Plan & Credits**. Prices are on [getartcraft.com/pricing](https://getartcraft.com/pricing).++## Do I have to pay?++No. The pricing page says you can use ArtCraft without a subscription, and that you can bring your own compute and third-party subscriptions. See [Use your own provider accounts](connect-provider-accounts.md).++**Settings** > **Plan & Credits** also says: "You do not have to purchase anything from us to use ArtCraft, but you can support ArtCraft development by subscribing or buying credits."++## Two kinds of credits++- **Monthly credits** come with a paid plan and refill every month.+- **Purchased credits** are one-time packs you buy. The pricing page says credit packs never expire.++Both are added together in your balance.++## Free plan++The app lists a Free plan for accounts without a subscription. Its plan card mentions free daily generations and limited access to ArtCraft tools. How many free generations you get is not documented yet, so this page does not give a number. Check your balance in **Plan & Credits**.++## Check your balance++1. Click the **Settings** button in the top bar.+2. Open **Plan & Credits**.+3. Read **Your ArtCraft credit balance**. Below it, a list shows how many are monthly credits (refilled monthly) and how many are purchased credits.++## Buy credits++1. Open **Settings**, then **Plan & Credits**.+2. Click **Buy credits**.+3. Pick a one-time pack. No subscription is needed.++## Subscribe or change plan++1. Open **Settings**, then **Plan & Credits**.+2. Click **Upgrade plan**. If you already have a plan, the button says **Change plan**.++To cancel, click **Cancel plan** in the same place. It only shows when you have a plan you can cancel.++Plans are Basic, Pro and Max. The pricing page also lists Enterprise, where you contact the team. See [getartcraft.com/pricing](https://getartcraft.com/pricing) for what each plan costs and includes.++## What a generation costs++Cost depends on the model and your settings. Some pages have a **Costs** button. It opens a cost calculator and shows the estimated credits for the current settings.++The pricing page says credits are refunded if a generation fails.++## Still stuck?++Ask in [Discord](https://discord.gg/artcraft) or open an issue in the [issue tracker](https://github.com/storytold/artcraft/issues).new file mode 100644@@ -0,0 +1,24 @@+---+title: Getting started+description: The order of steps to get from download to your first image in ArtCraft.+order: 10+verified: 0.41.0+---++Follow these four steps in order: install, sign up, check your credits, make your first image.++## Steps++1. Install ArtCraft. Pick your system:+ - [Windows](install-windows.md)+ - [macOS](install-macos.md)+ - [Linux](install-linux.md) (no official download yet)+2. [Create an account and log in](sign-up-and-log-in.md). The app asks for this when you first open it.+3. Check your credits in **Settings**, under **Plan & Credits**. See [Credits and pricing](credits-and-pricing.md).+4. Make your first image. See [Text to image](../guides/text-to-image.md).++## Optional++- [Use your own provider accounts](connect-provider-accounts.md) to connect Grok or Midjourney.+- Something went wrong? See [Troubleshooting](../troubleshooting/index.md).+- Short answers are in the [FAQ](../faq/index.md).new file mode 100644@@ -0,0 +1,33 @@+---+title: ArtCraft on Linux+description: ArtCraft has no official Linux download yet. This page says what exists today and what is still open.+order: 40+verified: 0.41.0+---++There is no official Linux download yet. Releases and the download page cover Windows and macOS only. You can build ArtCraft from source.++## Status++- The latest release, 0.41.0, has a Windows installer, a Windows `.msi` and a macOS disk image. It has no Linux file.+- Linux installers (an Ubuntu `.deb` and an AppImage) are proposed in pull request [#2007](https://github.com/storytold/artcraft/pull/2007). It was still open when this page was checked.+- People have asked for Linux support in [#2002](https://github.com/storytold/artcraft/issues/2002), [#1392](https://github.com/storytold/artcraft/issues/1392), [#2075](https://github.com/storytold/artcraft/issues/2075) and [#2035](https://github.com/storytold/artcraft/issues/2035). All are open.+- NixOS (flake) and Flatpak support is requested in [#1974](https://github.com/storytold/artcraft/issues/1974). It is open and has no replies.++## Build from source++The README points Linux users to the [development setup guide](https://github.com/storytold/artcraft/blob/main/_docs/dev_setup.md). That guide is written for developers.++The repository has a build script, `script/artcraft/unix_build.sh`. In issue [#2055](https://github.com/storytold/artcraft/issues/2055) a user built an AppImage with it.++## Known problem: crash on Wayland++A build from source can crash on launch under Wayland. See [ArtCraft crashes on launch under Wayland (Linux)](../troubleshooting/linux-wayland-crash.md) for the workaround.++## What is not supported yet++This page does not list which Linux distributions or graphics drivers work, because the project has not published that. Some issues mention packages made by the community. Those are not checked here.++## Still stuck?++Ask in [Discord](https://discord.gg/artcraft) or comment on one of the issues above.new file mode 100644@@ -0,0 +1,54 @@+---+title: Install ArtCraft on macOS+description: Download the universal ArtCraft disk image for Macs with Apple Silicon or Intel, running macOS 12 or newer.+order: 30+verified: 0.41.0+---++Download the one macOS file from [getartcraft.com/download](https://getartcraft.com/download). It runs on both Apple Silicon and Intel Macs and needs macOS 12.0 or newer.++## What you need++- macOS 12.0 (Monterey) or newer+- 8 GB of RAM recommended+- 2 GB of free storage++## Apple Silicon or Intel++You do not have to choose. The macOS download is a universal build, named like `ArtCraft_<version>_universal.dmg`. It contains both versions.++## Install++1. Open [getartcraft.com/download](https://getartcraft.com/download).+2. Click **Download for Mac**.+3. Open the downloaded `.dmg` file.+4. Install ArtCraft from the window that opens.+5. Start ArtCraft.+6. Create an account or log in. See [Create an account and log in](sign-up-and-log-in.md).++You can also get the file from the [GitHub releases page](https://github.com/storytold/artcraft/releases).++## macOS security prompt++You should not see a warning. The macOS publish workflow signs the build with a Developer ID certificate.++If macOS still blocks ArtCraft, and you downloaded it from getartcraft.com or the GitHub releases page:++1. Try to open ArtCraft once.+2. Open **System Settings**, then **Privacy & Security**.+3. Scroll down and click **Open Anyway** next to the message about ArtCraft.+4. Click **Open** when the warning appears again.++These steps are from Apple's page [Safely open apps on your Mac](https://support.apple.com/en-us/102445). If it still does not open, ask in [Discord](https://discord.gg/artcraft).++## macOS 12 (Monterey)++Sign-up used to freeze on Monterey (issue [#1008](https://github.com/storytold/artcraft/issues/1008)). A fix was merged and the issue is closed.++## Update++ArtCraft has no built-in updater. To get a newer version, download the latest file from [getartcraft.com/download](https://getartcraft.com/download) and install it again.++## Still stuck?++Ask in [Discord](https://discord.gg/artcraft) or open an issue in the [issue tracker](https://github.com/storytold/artcraft/issues).new file mode 100644@@ -0,0 +1,43 @@+---+title: Install ArtCraft on Windows+description: Download the ArtCraft installer for Windows 11 (64-bit), run it, and update to a newer version.+order: 20+verified: 0.41.0+---++Download the installer from [getartcraft.com/download](https://getartcraft.com/download) and run it. ArtCraft for Windows is a 64-bit app.++## What you need++- Windows 11 (64-bit)+- 8 GB of RAM recommended+- 2 GB of free storage++## Install++1. Open [getartcraft.com/download](https://getartcraft.com/download).+2. Click **Download for Windows**. This downloads a file named like `ArtCraft_<version>_x64-setup.exe`.+3. Open the downloaded file and follow the installer.+4. Start ArtCraft.+5. Create an account or log in. See [Create an account and log in](sign-up-and-log-in.md).++You can also get the installer from the [GitHub releases page](https://github.com/storytold/artcraft/releases). Each release lists a `x64-setup.exe` installer and an `.msi` installer. The download page links the `x64-setup.exe` one.++## Windows security prompt++Windows is likely to show a blue "Windows protected your PC" warning (Microsoft Defender SmartScreen) when you run the installer. The Windows publish workflow has no code-signing step, so the installer is probably not signed. See Microsoft's [SmartScreen overview](https://learn.microsoft.com/en-us/windows/security/operating-system-security/virus-and-threat-protection/microsoft-defender-smartscreen/).++If you downloaded the file from getartcraft.com or the GitHub releases page above:++1. Click **More info** in the warning.+2. Click **Run anyway**.++If you got the file anywhere else, do not run it.++## Update++ArtCraft has no built-in updater. To get a newer version, download the latest installer from [getartcraft.com/download](https://getartcraft.com/download) and run it. The download page shows which version it offers.++## Still stuck?++Ask in [Discord](https://discord.gg/artcraft) or open an issue in the [issue tracker](https://github.com/storytold/artcraft/issues).new file mode 100644@@ -0,0 +1,54 @@+---+title: Create an account and log in+description: Sign up for an ArtCraft account in the desktop app, log in with a password or through the website, and what to do if sign-up fails.+order: 50+verified: 0.41.0+---++When you start the desktop app, a window asks you to sign up or log in. You cannot close it without doing one of them.++## Sign up++1. In the window, find **Create your account**. If you see **Welcome back** instead, click **Sign up** at the bottom.+2. Fill in **Username**, **Email**, **Password** and **Confirm Password**. The password needs at least 8 characters.+3. Click **Sign up**.+4. The app can then show **Join Our Community** with a Discord invite. Click **Join Discord** or **Skip for now**.+5. Click **Get Started**.++If the two passwords do not match, the app shows "Passwords do not match."++## Log in with a password++1. In the window, find **Welcome back**. If you see **Create your account**, click **Log in** at the bottom.+2. Enter your email or username in **Email or Username**, and your **Password**.+3. Click **Log in**.++## Log in through the website++Use this if you signed up with Google or are already signed in on the website.++1. On the **Welcome back** window, click **Login with Website** to open your browser, or **Scan to Login** to use your phone.+2. The app shows a QR code and a code. Approve the login on the website and check that the codes match.+3. Wait. The app shows "Waiting for your confirmation on the website…" and then "Signed in successfully."++The code expires. If the app says "Login request expired. Start a new request.", start again with **Login with Website** or **Scan to Login**. If you decline on the website, the app says "Login was declined on the website."++## Log out or switch accounts++1. Click the **Settings** button in the top bar.+2. Open **Accounts**.+3. Next to **ArtCraft Account:**, click **Log Out**, or **Log In** if you are logged out.++## If sign-up fails++Sign-up can fail without a clear reason. Issue [#2004](https://github.com/storytold/artcraft/issues/2004) is open. In it, a user was told the email was already taken when they had never signed up. One person got in by resetting their password on the website and then approving the login in the app. The team has not confirmed this fix.++To get help:++1. Check that you typed the email correctly.+2. Try **Login with Website** instead of the password form.+3. Ask in [Discord](https://discord.gg/artcraft), or add your case to issue [#2004](https://github.com/storytold/artcraft/issues/2004).++## Still stuck?++Ask in [Discord](https://discord.gg/artcraft) or open an issue in the [issue tracker](https://github.com/storytold/artcraft/issues).new file mode 100644@@ -0,0 +1,59 @@+---+title: Compose on the 2D canvas+description: What the tools in Image Editor do, how to add images and shapes, and how to generate from your layout.+order: 40+verified: 0.41.0+---++**Image Editor** is a canvas for laying out images, shapes and brush strokes. When you click **Generate**, ArtCraft uses the canvas as input along with your prompt. Open it from **Image Editor** in the top bar.++## Start a canvas++You begin on a start card with three choices:++- **Select Image**: upload an image from your computer. You can also drag an image onto the card.+- **Pick from Library**: use an image from [My Library](library.md).+- **Blank Canvas**: choose a size in **Choose Canvas Size**, then click **Create Canvas**. Sizes are grouped as Square, Landscape and Portrait.++## The toolbar++The toolbar on the left has these tools. Hover a button to see its name.++- **Select & Move**: pick and move items.+- **Add Shape**: draws a rectangle, circle or triangle. Choose the shape from the small menu next to the button. When a shape is selected, a colour button appears above the toolbar.+- **Upload Image**: adds an image to the canvas.+- **Brush**: draws freehand. Choose a colour and set **Brush Size** in the panel that opens.+- **Mask**: paints a mask for edits. It only works with models that support masks. See [Edit an image with a prompt](edit-an-image.md).+- **Eraser**: erases. Set **Eraser Size** in its panel.+- **Canvas Background**: sets the canvas colour.+- **Undo** and **Redo**.+- A red X button at the bottom of the toolbar, **Reset Canvas**. It asks "Are you sure you want to reset the canvas?" and clears all your work if you click **Reset all**. This cannot be undone.++The button corners show the keyboard shortcut for some tools. You can change shortcuts in **Settings**, under **Keybinds**.++## Add images from your library++Open **My Library** and drag an image onto the canvas. You can also use **Upload Image** in the toolbar.++## Work with items++Right-click a selected item to open a menu with **Remove background**, **Lock**, **Bring to front**, **Bring forward**, **Send backward**, **Send to back**, **Duplicate** and **Delete**. A locked item shows **Unlock** instead.++Click **Fit** in the prompt box to fit the canvas to the window.++## Generate++1. Choose a model in the prompt box.+2. Type a prompt in the box that says "Describe your image...". The canvas already carries your layout, so a short prompt is enough.+3. Click **Generate**.++Results appear in the history stack. Click one to make it the base image. Click **Costs** at the bottom right to see the credit cost.++## Tips++- High-contrast sketches give clearer guidance.+- Mask small areas for local edits such as logos, eyes or hands.++## Watch a walkthrough++[Watch the walkthrough](https://www.youtube.com/watch?v=ZASPqlqUBQc) (recorded in 2025, so the interface may look different).new file mode 100644@@ -0,0 +1,56 @@+---+title: Stage a scene in 3D+description: Add objects and characters to 3D Stage, set up a camera, then generate an image from the current frame with a prompt.+order: 50+verified: 0.41.0+---++Open **3D Stage**, add objects with the **+** button, line up the camera, type a prompt, and click **Generate**. ArtCraft sends the current frame of your scene with the prompt, so the framing and poses carry into the image.++## Build a scene++1. Click **3D Stage** in the top bar.+2. Click the **+** button at the top. Its tooltip is "Add an asset to scene". On an empty scene a hint says "Click + to add your first 3D asset".+3. Choose where the asset comes from:+ - **ArtCraft Presets (B)**: ready-made content in tabs for Characters, Objects, Memes, Sets, Creatures, Animations and Skybox.+ - **Animations**: the animation picker.+ - **My Library**: your own creations. See [Find, download and delete your creations](library.md).+ - **Upload 3D Model**, **Upload Image** or **Upload Splat**: use your own files.+4. You can also drag an item from **My Library** into the scene.++To make a 3D object from a picture, click the wand button next to **+** (tooltip "Create 3D model from image"), or follow [Turn an image into a 3D object](image-to-3d.md).++## Move things++Use the tool buttons at the top to switch between **Move**, **Rotate** and **Scale**. The button next to them toggles **World** and **Local** space. Scale always uses local space.++Click **Outliner** in the top left to show or hide the **Scene** panel. It lists the items in your scene. Each row has controls to show or hide the item and to lock or unlock it.++Click **Shortcuts** in the top left to pin a cheatsheet of the keyboard shortcuts. Holding Ctrl (Cmd on Mac) alone for a few seconds also shows it. To change shortcuts, open **Settings**, then **Keybinds**.++## Set up the camera++- Use the **Camera** picker in the prompt box to choose a camera. The add control in its panel creates more cameras, up to six. Its **Settings** action opens camera settings.+- The pill at the top right reads **Viewport** when you are using the free viewport camera. Click it to look through the render camera, and click again to go back.+- The **Aspect ratio** menu at the top right sets the frame shape: 16:9, 3:2, 1:1, 2:3 or 9:16.+- The grid button in the prompt box toggles the grid. Its tooltip reads "Grid: ON" or "Grid: OFF".++## Generate an image from the scene++1. Choose a model in the prompt box.+2. Type a prompt in the box that says "Describe your image...". Describe style and materials. The scene already supplies the layout.+3. Click **Generate**.++The same row has **Download frame** to save the current frame as a file and **Save frame**. Click **Costs** at the bottom right for the credit cost.++## Save your scene++Open the **File** menu at the top left. It has **New scene**, **Load my scene**, **Save scene**, **Save scene as copy** and **Reset to original**. Saving needs you to be logged in.++## Record mode++The mode switch at the top has **Build** and **Record**. In **Record** mode, **Capture** takes a still of the camera view. **Record** renders an animation timeline to video. It needs a timeline first, and its tooltip says "Add an animation timeline first" until you have one.++## Watch a walkthrough++[Watch the walkthrough](https://www.youtube.com/watch?v=pM4CxN-isrY) (recorded in 2025, so the interface may look different).new file mode 100644@@ -0,0 +1,43 @@+---+title: Edit an image with a prompt+description: Load an image into Image Editor, describe the change, and generate. Use the Mask tool to limit the edit to one area on models that support it.+order: 20+verified: 0.41.0+---++Load an image into **Image Editor**, type what should change, and click **Generate**. To limit the edit to one area, paint a mask first. Masking only works with some models.++## Edit an image++1. Open the image in **Image Editor**. Use any of these:+ - Click **Image Editor** in the top bar, then **Select Image** to upload a file or **Pick from Library** to use something you made.+ - On **Home**, click the **Edit Image** card. It opens the same editor.+ - Open an image from **My Library** and click **Edit Image**.+2. Choose a model with the model picker in the prompt box.+3. Type the change in the box that says "Describe your image...". Short, clear instructions work best, for example "replace with polished chrome".+4. Click **Generate**.++Results appear in the editor's history stack while they run and when they finish. Click one to make it the base image, then edit again. Work from big changes to small ones.++## Limit the edit to one area++1. Click the **Mask** tool in the toolbar on the left. If it looks dimmed and its tooltip says "Mask (Model unsupported)", the model you picked does not support masks. Pick another model.+2. In the bar that appears at the top, choose **Add** to paint the area to change, or **Erase** to remove part of your mask.+3. Set the brush with the **Size** slider. Keep the mask tight around the area you want to change.+4. Type your prompt and click **Generate**.++## Models without mask support++Without a mask, ArtCraft sends the whole canvas as a picture, together with your prompt and any reference images. Anything you drew or placed on the canvas is part of that picture. See [Compose on the 2D canvas](2d-canvas.md) for the drawing tools.++## Start from a blank canvas++On the start card, click **Blank Canvas**, choose a size in **Choose Canvas Size**, and click **Create Canvas**.++## Add reference images++If the model accepts images, click the **Add Image** button at the left of the prompt box and add them there.++## Cost++Click **Costs** at the bottom right to see the credits for the current settings. See [Credits and pricing](../getting-started/credits-and-pricing.md).new file mode 100644@@ -0,0 +1,37 @@+---+title: Turn an image into a 3D object+description: Pick an image in Image to 3D Object, choose a model, and click Generate Object to get a 3D model you can use in 3D Stage or download as a GLB file.+order: 60+verified: 0.41.0+---++Open **Image to 3D Object** from **Home**, add one image, and click **Generate Object**. When the model is ready you can view it, open it in 3D Stage or download it as a GLB file.++## Steps++1. Go to **Home** and click the **Image to 3D Object** card. The page is titled "Generate 3D Object".+2. Click the **Add Image** tile. Hover it to see **Upload image** and **Pick from library**. You can also drag an image onto the tile.+3. Choose a model with the model picker next to the button. See [Models](../reference/models.md).+4. Click **Generate Object**. The credit cost shows on the button.++The button is disabled until you add an image and it finishes uploading.++## Start from an image you already made++- Open the image in **My Library** and click **Make 3D**.+- In [3D Stage](3d-editor.md), click the wand button next to **+** (tooltip "Create 3D model from image").++## Use the result++After you click **Generate Object**, the page splits into a viewer and a **History** list.++- Click an entry in **History** to view it. An entry reads "Generating..." while it runs.+- **Open in 3D Editor** adds the object to your scene in **3D Stage**.+- **GLB** downloads the model as a GLB file.+- **Clear Session** empties the **History** list.++Click **Costs** at the bottom right to see the credit cost. See [Credits and pricing](../getting-started/credits-and-pricing.md). If a generation fails, ArtCraft shows "Failed to generate 3D model" with the reason.++## Watch a walkthrough++[Watch the walkthrough](https://www.youtube.com/watch?v=t8F-sy_zyK4) (recorded in 2025, so the interface may look different).new file mode 100644@@ -0,0 +1,50 @@+---+title: Turn an image into a video+description: Add a starting image in Create Video, write a prompt that describes the motion, and generate a clip.+order: 30+verified: 0.41.0+---++Open **Create Video**, add a **First frame** image, describe what should happen, and click the round arrow button. Many models need a starting image. When one does, the box shows "Starting frame required" until you add it.++## Steps++1. Open **Create Video** in the top bar.+2. Choose a model with the model picker in the row under the prompt box. See [Models](../reference/models.md).+3. Add a starting image to the **First frame** card. Click the card and choose **Upload** or **Pick from library**. You can also drag an image file onto the prompt box.+4. Type the motion and mood in the box that says "Describe what you want to happen in the video...".+5. Set the options you want (see below).+6. Click the round arrow button. The number next to it is the credit cost.++The clip appears in the list above the prompt box while it runs and stays there when it finishes. Click it to open it.++## Start from an image you just made++- In **Create Image**, click the **Make Video** button on an image in the list.+- In a lightbox, click **Make Video**.++Both open **Create Video** with that image already in **First frame**.++## Options++Which options show up depends on the model.++- **Aspect Ratio** and **Resolution**.+- **Duration**: the length of the clip.+- **Bitrate** (**Normal** or **High**) and **Output format**.+- Sound: a toggle that reads "Sound: ON" or "Sound: OFF" in its tooltip.+- **Last frame**: a second card for an ending image, on models that support it. The swap button between the cards switches the two frames.+- **Input Mode**: on models that offer it, choose **Keyframe** (first and last frame) or **Omni Reference** (multiple media references). In **Omni Reference** you can mention uploads in the prompt with @Image1, @Video1 or @Audio1.+- **Number of generations**: shown only when the model allows more than one video per click.++Some models cannot start from text alone. The box then says: "This model can't generate from text alone - add a starting frame to animate your prompt."++## Tips for better clips++- Start from a clean, well-lit image with a clear subject.+- Keep motion small, such as a slow camera drift or a small change in pose.+- Reuse the same wording across clips if you are making a series.++## Cost and problems++Click **Costs** at the bottom right to see the credits for the current settings. See [Credits and pricing](../getting-started/credits-and-pricing.md). If a clip never finishes, see [Generation is stuck or failed](../troubleshooting/generation-stuck-or-failed.md).new file mode 100644@@ -0,0 +1,33 @@+---+title: Guides+description: Step-by-step guides for making images and video, editing on the canvas, staging 3D scenes and managing your library in ArtCraft.+order: 20+verified: 0.41.0+---++Each guide covers one task. Pick the one that matches what you want to do.++## Make and edit images++- [Make an image from a prompt](text-to-image.md): write a prompt in **Create Image** and generate.+- [Edit an image with a prompt](edit-an-image.md): load an image, describe the change, generate.+- [Compose on the 2D canvas](2d-canvas.md): the tools in **Image Editor**.++## Make video++- [Turn an image into a video](image-to-video.md): start from an image in **Create Video**.++## Work in 3D++- [Stage a scene in 3D](3d-editor.md): place objects and a camera in **3D Stage**, then generate from the frame.+- [Turn an image into a 3D object](image-to-3d.md): generate a 3D model from one image.++## Manage your work++- [Find, download and delete your creations](library.md): open **My Library**, download files and delete them.++## Before you start++- You need an account. See [Create an account and log in](../getting-started/sign-up-and-log-in.md).+- Generations cost credits. See [Credits and pricing](../getting-started/credits-and-pricing.md).+- Models differ in the settings they offer. See [Models](../reference/models.md).new file mode 100644@@ -0,0 +1,54 @@+---+title: Find, download and delete your creations+description: Open My Library, filter by type, download files to your computer, and delete one or many items.+order: 70+verified: 0.41.0+---++Click **My Library** in the top bar to see everything you have made and uploaded. Click an item to open it, then use **Download** or **Delete**. On a narrow window the button shows only an icon.++## Find an item++1. Click **My Library**.+2. Use the list on the left to filter by type: **All Assets**, **Image**, **Video**, **Audio**, **Mesh**, **Splat** or **Uploaded**.+3. At the top, **All Assets** shows your files and **Folders** shows your folders.+4. Click **Refresh list** if a new item is missing. **Toggle image fit** switches between cropped and full thumbnails.++Uploads are hidden by default in **All Assets**. Turn on **Show uploads** to see them, or use the **Uploaded** filter.++To sort items into folders, click **New folder** on the **Folders** tab. To file an item, open its menu and choose **Add to Folder**.++## Download an item++1. Open the item from **My Library** by clicking it.+2. Click **Download**.++Where the file goes depends on your download settings. Click **Settings**, open **Downloads**, and check:++- **Default Download Directory**: the folder files are saved to. **Choose Directory** changes it and **Use Default** resets it.+- **Ask location before download**: when on, a file picker opens each time so you choose the folder.+- **Auto Download**: when on, finished generations are downloaded to your computer as soon as they complete.++## Delete an item++1. Open **My Library**.+2. Hover the item and open its menu, or right-click it. Choose **Delete**. You can also open the item and click **Delete**.+3. In the box titled "Delete this media?", click **Delete**. Click **Cancel** to keep it.++Deleting removes the item from your library for good. The confirmation says this cannot be undone.++## Delete many items++1. In **My Library**, click the small checkbox at the top left of each item you want. The checkbox shows when you hover an item.+2. A bar appears at the bottom with **Add to folder** and **Delete**. Click **Delete**.+3. Confirm in the box that asks "Delete N items?".++Click the X at the right of the bar to clear your selection.++## If delete fails++ArtCraft shows an error message when an item cannot be deleted. Deleting generated images from the library was broken in older versions ([issue #969](https://github.com/storytold/artcraft/issues/969), closed in January 2026). Update to the latest version if you still see it. If it persists, ask in [Discord](https://discord.gg/artcraft) or open an issue in the [issue tracker](https://github.com/storytold/artcraft/issues).++## Other things you can do with an item++Open an image and the same panel can also show **Recreate**, **Edit Image**, **Make Video**, **Remove BG**, **Make 3D**, **Make 3D World** and **Share**. Which buttons show depends on the item. **Share** copies a link to the item.new file mode 100644@@ -0,0 +1,50 @@+---+title: Make an image from a prompt+description: Open Create Image, pick a model, write a prompt and click the round arrow button to generate images.+order: 10+verified: 0.41.0+---++Open **Create Image**, write what you want in the prompt box, and click the round arrow button at the right of the box. The button is disabled until you type a prompt.++## Steps++1. In the top bar, click **Create Image**. You can also click the **Create Image** card on **Home**.+2. Choose a model with the model picker at the left of the row under the prompt box. Its tooltip is **Model** and its panel is titled **Select Model**. See [Models](../reference/models.md) for what each one does.+3. Type your prompt in the box that says "Describe what you want in the image...". The counter at the bottom right shows your length against the limit for this model. If you go over, ArtCraft shows "Prompt exceeds the ... character limit for this model".+4. Set options if you want them (see below).+5. Click the round arrow button. The number next to it is the credit cost for the current settings.++Your images appear above the prompt box while they run and stay in the list when they finish. Click one to open it larger.++## Options under the prompt box++Which of these show up depends on the model you picked.++- **Aspect Ratio**: the shape of the image.+- **Resolution**: the size choices the model offers, such as 1K or 2K.+- **Quality**: the quality levels the model offers, such as Auto, Medium or High.+- **Number of generations**: how many images one click makes. The panel is titled **No. of images**. The choices depend on the model.+- Reference images: some models accept images to guide the result. Click the add card next to the prompt box and choose **Upload** or **Pick from library**, or drag image files onto the box. Each model has a maximum number of references.++The **Clear all** button empties the prompt and removes the reference images.++## Send with Enter++By default, Enter adds a new line and only the button sends your prompt. To change this, click **Settings**, open **General**, and turn on **Enter to generate**. Then Enter sends and Shift+Enter adds a new line.++## Tips for prompts++- Name the subject, the action and the style, such as lighting or materials.+- Short, descriptive phrases work better than long paragraphs.+- Use "no text, no watermark" style negatives sparingly.++## After you generate++- Click an image to open it. The panel has **Edit Image**, **Make Video** and **Download**. See [Edit an image with a prompt](edit-an-image.md), [Turn an image into a video](image-to-video.md) and [Find, download and delete your creations](library.md).+- Image items in the list also have a **Make Video** button.+- If a generation fails, a card with a **Dismiss** button appears in the list. See [Generation is stuck or failed](../troubleshooting/generation-stuck-or-failed.md).++## Cost++Click **Costs** at the bottom right of the page to open the cost calculator. See [Credits and pricing](../getting-started/credits-and-pricing.md).new file mode 100644@@ -0,0 +1,23 @@+---+title: ArtCraft docs+description: Install ArtCraft, make your first image and video, and fix common problems.+order: 0+verified: 0.41.0+---++## What ArtCraft is++ArtCraft is a desktop app for making images and video with AI models. You can write a prompt, compose on a 2D canvas, stage a scene in 3D, and pick the model for each job.++## Start here++- [Getting started](getting-started/index.md): install, first run, account and credits+- [Guides](guides/index.md): how to do one thing+- [Troubleshooting](troubleshooting/index.md): find your symptom, get the fix+- [Models](reference/models.md): the models ArtCraft supports+- [FAQ](faq/index.md): short answers++## Get help++- Ask in [Discord](https://discord.gg/artcraft).+- Report a bug or request a feature in the [issue tracker](https://github.com/storytold/artcraft/issues).new file mode 100644@@ -0,0 +1,12 @@+---+title: Reference+description: Lists you can look things up in, such as the image and video models available in ArtCraft.+order: 50+verified: 0.41.0+---++Look-up pages. For steps, see the [guides](../guides/index.md).++## Pages++- [Models in ArtCraft](models.md): the image and video models, with what each one accepts.new file mode 100644@@ -0,0 +1,14 @@+---+title: Models in ArtCraft+description: The image and video models you can pick in ArtCraft, with how many images each makes per run and what inputs it accepts.+order: 10+verified: 0.41.0+---++The table below lists the image and video models you can pick in ArtCraft. The table is built from the ArtCraft service when this site is updated. Models can change without a new app version; if your picker differs, trust the picker.++Some models can run through your own provider account instead of ArtCraft credits. See [Use your own provider accounts](../getting-started/connect-provider-accounts.md). Costs depend on the model and your settings. See [Credits and pricing](../getting-started/credits-and-pricing.md).++## Image and video models++<!-- generated:artcraft-models -->new file mode 100644@@ -0,0 +1,67 @@+---+title: A generation is stuck or failed+description: What to do when a task sits at 95% in the Task Queue, or shows Failed, and what to send when you report it.+order: 10+verified: 0.41.0+---++Open the **Task Queue** and read the task. If it shows **Failed**, point at the reason under it. If it sits at 95%, wait, then clear it and report it.++## Symptoms++- A task in the **Task Queue** shows a progress bar that stops at 95% and says "Almost done...".+- A task shows **Failed**, sometimes with a short reason under it.+- A task shows **Failed** with no useful reason.+- You do not know if you were charged.++## Fix++### A task shows Failed++1. Click the **Task Queue** button in the top bar.+2. Find the task in the **Failed** list.+3. Read the reason under **Failed**. Point at it to see more text, when there is any.+4. If the reason is about content policy, change the prompt or the image and run it again. The app can show these reasons:+ - "Image violates content policy"+ - "Images with faces are not allowed"+ - "Text prompt violates content policy"+ - "Content violates content policy"+ - "Generated video flagged by content policy"+ - "Generated audio flagged by content policy"+ - "Generated content flagged by content policy"+5. If the reason is "Generation failed" or "An unknown error occurred", run it again. Use the copy button next to the task to get your prompt back.+6. To remove a failed task from the list, click the X on it. **Clear failed** removes all failed and cancelled tasks.++### A task is stuck at 95%++The bar at 95% is an estimate, not a real measure. The app fills the bar over the time a model usually takes and stops it at 95% until the result arrives. A slow generation can sit there for a while.++1. Wait a few minutes. Video models can take longer than images.+2. Open the **Task Queue** and check whether the task moved to **Failed** or to completed.+3. A task that has been running for more than 5 minutes gets an X button. Click it to remove the task from the list.+4. To remove all of those at once, click **Show all** at the bottom of the Task Queue. In the window that opens, click **Clear stale** in the top row, next to **Clear completed**, **Clear failed** and **Remove all**. It removes every in-progress task older than 5 minutes and asks you to confirm first. It does not touch tasks under 5 minutes old.+5. Check your balance in **Settings**, under **Plan & Credits**. See [Credits and pricing](../getting-started/credits-and-pricing.md).+6. If it still looks wrong, report it. See below.++### Do I get my credits back?++The pricing page says credits are refunded if a generation fails. In reply to a report of tasks stuck at 95%, a team member wrote that refunds are automatic for failed jobs and that stuck jobs move to failed ([#1068](https://github.com/storytold/artcraft/issues/1068)). That comment is from the issue tracker, not from this app's code, so check your balance. If a failed task was charged and not refunded, tell the team in Discord and include the details below.++If a task never moves to **Failed**, do not rely on a refund. If the task stays at 95% well past the usual time for that model and your balance dropped, take a screenshot of the task before you remove it, then report it with the details under "Still stuck?". Reports like this exist: in [#1068](https://github.com/storytold/artcraft/issues/1068) a user lost 176 credits to two jobs stuck at 95%, and [#1439](https://github.com/storytold/artcraft/issues/1439) is an open report of the same symptom.++## Why this happens++Generations run on a provider's servers, and the app keeps checking their status. A task moves to **Failed** when the service reports a failure. The app shows the failure reason the service sends. When the service gives none, the app shows a generic label.++Earlier reports of tasks stuck at 95% were about Seedance 2.0 ([#1058](https://github.com/storytold/artcraft/issues/1058), [#1068](https://github.com/storytold/artcraft/issues/1068)). Those two issues are closed. A newer report, [#1439](https://github.com/storytold/artcraft/issues/1439), is still open. In the app, Seedance 2.0 shows a note that it is in Early Alpha and that generations may be slow and may have outages.++## Still stuck?++Ask in [Discord](https://discord.gg/artcraft) or open an issue in the [issue tracker](https://github.com/storytold/artcraft/issues). Include:++- the model you used and the settings (length, size, start frame)+- the time you started the generation, with your time zone+- the text of the failure reason, or a screenshot of the task+- your balance before and after, from **Plan & Credits**+- your ArtCraft version and your system+- whether you used ArtCraft credits or your own provider accountnew file mode 100644@@ -0,0 +1,16 @@+---+title: Troubleshooting+description: Fixes for problems with ArtCraft, listed by what you see.+order: 60+verified: 0.41.0+---++Find the page that matches what you see.++## Pages++- [A generation is stuck or failed](generation-stuck-or-failed.md): the progress bar stops at 95%, or a task shows **Failed**.+- [Can't sign up](../getting-started/sign-up-and-log-in.md#if-sign-up-fails): what to check when sign-up does not work.+- [ArtCraft crashes on launch under Wayland (Linux)](linux-wayland-crash.md): a build you made yourself closes at start with a WebKit error.++Not listed? Ask in [Discord](https://discord.gg/artcraft) or open an issue in the [issue tracker](https://github.com/storytold/artcraft/issues).new file mode 100644@@ -0,0 +1,52 @@+---+title: ArtCraft crashes on launch under Wayland (Linux)+description: A source-built ArtCraft closes at start on Wayland with a WebKit error. Start it with WEBKIT_DISABLE_DMABUF_RENDERER=1.+order: 20+verified: 0.41.0+---++Start ArtCraft with the environment variable `WEBKIT_DISABLE_DMABUF_RENDERER=1`. This fixed the crash for the person who reported it. You need it only for a build you made yourself.++## Symptoms++- ArtCraft closes right after you start it, on a Wayland session.+- The terminal shows messages like these:++ Gdk-Message: Error 71 (Protocol error) dispatching to Wayland display.+ ERROR: WebKit encountered an internal error. This is a WebKit bug.++- The same output mentions `networkProcessCrashed`.++The reporter ran ArtCraft 0.42.0 built from source (unreleased code from main) as an AppImage, on CachyOS (Arch) with webkit2gtk-4.1 2.52.6. ArtCraft has no official Linux download yet. See [ArtCraft on Linux](../getting-started/install-linux.md).++## Fix++1. Open a terminal.+2. Start the app with the variable set. For an AppImage you built, run:++ WEBKIT_DISABLE_DMABUF_RENDERER=1 ./<the AppImage you built>++ Replace the file name with the name of your own build. It is not a download.+3. If you start ArtCraft from a launcher or a desktop file, add the same variable to the command there.++## Why this happens++ArtCraft draws its window with WebKitGTK. On this setup the WebKit process crashes when it uses the DMABUF renderer. The variable turns that renderer off.++The project's development scripts already set this variable. Release builds do not, so the crash shows up only outside development.++## Status of the fix++A fix is proposed in pull request [#2056](https://github.com/storytold/artcraft/pull/2056). It sets the variable for you on Linux, unless you set it yourself. The pull request was still open when this page was checked, and the issue ([#2055](https://github.com/storytold/artcraft/issues/2055)) was open. The author of the pull request did not rebuild the AppImage with the change. Until it is released, use the steps above.++The workaround has been reported on one setup only. It has not been tested on others.++## Still stuck?++Ask in [Discord](https://discord.gg/artcraft) or comment on [#2055](https://github.com/storytold/artcraft/issues/2055). Include:++- your distribution and version+- X11 or Wayland, and your graphics card and driver+- the WebKitGTK version+- how you built or installed ArtCraft+- the full text the terminal prints at start