docs: fix stale image-gen refs, Node prereq, version sync; drop dead icons.svg
- README: image gen is sd-server (cross-platform), not macOS/Ollama; Node 23.6+ note for self-checks; prefs store row in the data table. - plan.md: superseded banners on the Ollama image-gen sections. - gitea-release.sh: syncs Cargo.toml too; bumped to 0.1.3 to match. - public/icons.svg: unreferenced — favicon.svg is the icon.
This commit is contained in:
itsamejms
@@ -18,7 +18,7 @@ into **Session** (live) and **World** (prep) tools:
|
|||||||
- **NPC Generator** — portraits, personality, goals, stat blocks
|
- **NPC Generator** — portraits, personality, goals, stat blocks
|
||||||
- **Quest Designer** — multi-step quests with twists and reward breakdown
|
- **Quest Designer** — multi-step quests with twists and reward breakdown
|
||||||
- **Item Forge** — magic items with art and structured mechanics
|
- **Item Forge** — magic items with art and structured mechanics
|
||||||
- **Image Generator** — portraits, maps, scene art (macOS, via Ollama)
|
- **Image Generator** — portraits, maps, scene art (cross-platform, via stable-diffusion.cpp)
|
||||||
- **Session Logger** — Markdown notes, multiple sessions, streaming AI summary
|
- **Session Logger** — Markdown notes, multiple sessions, streaming AI summary
|
||||||
- **Soundboard** — synthesized ambience/SFX with one-click scenes
|
- **Soundboard** — synthesized ambience/SFX with one-click scenes
|
||||||
- **World Builder** — generated regions, landmarks, a draggable-pin map
|
- **World Builder** — generated regions, landmarks, a draggable-pin map
|
||||||
@@ -34,7 +34,7 @@ persistent state round it out — reload loses nothing.
|
|||||||
### Prerequisites
|
### Prerequisites
|
||||||
|
|
||||||
- **Rust** + **Cargo** — https://rustup.rs
|
- **Rust** + **Cargo** — https://rustup.rs
|
||||||
- **Node.js** 20+ — https://nodejs.org
|
- **Node.js** 20+ (23.6+ to run the `npm run check` self-checks) — https://nodejs.org
|
||||||
- **[Ollama](https://ollama.com)** running locally (default `http://localhost:11434`)
|
- **[Ollama](https://ollama.com)** running locally (default `http://localhost:11434`)
|
||||||
|
|
||||||
### Install & run
|
### Install & run
|
||||||
@@ -66,7 +66,8 @@ All campaign data stays on disk under your OS app-data dir (default
|
|||||||
|
|
||||||
| File | Contents |
|
| File | Contents |
|
||||||
|------|----------|
|
|------|----------|
|
||||||
| `lore.db` | RAG chunks + embeddings (SQLite) |
|
| `dm-pal-prefs.json` | App prefs — data-dir setting + LLM config incl. API key (stored locally, one level above `dm-toolkit/`) |
|
||||||
|
| `lore/lore.db` | RAG chunks + embeddings (SQLite) |
|
||||||
| `generations.db` | History of every generated NPC/encounter/item/quest/… |
|
| `generations.db` | History of every generated NPC/encounter/item/quest/… |
|
||||||
| `images/` | Cached generated PNGs, keyed by prompt hash |
|
| `images/` | Cached generated PNGs, keyed by prompt hash |
|
||||||
| `dm-pal-state.json` | UI state (initiative, dice history, calendar events, …) |
|
| `dm-pal-state.json` | UI state (initiative, dice history, calendar events, …) |
|
||||||
|
|||||||
+8
-1
@@ -351,6 +351,13 @@ pub async fn generate_image(
|
|||||||
- **macOS-only today** — Ollama image models only run on macOS (Apple Silicon via MLX). Gate the image-gen UI behind an OS check on first run; on other platforms fall back to a placeholder/emoji or the optional remote API. (This is an Ollama limitation, not ours.)
|
- **macOS-only today** — Ollama image models only run on macOS (Apple Silicon via MLX). Gate the image-gen UI behind an OS check on first run; on other platforms fall back to a placeholder/emoji or the optional remote API. (This is an Ollama limitation, not ours.)
|
||||||
- **Slow + heavy** — 4B is ~5.7GB, 9B is ~12GB, generation is multi-second. Always generate in the background with a progress bar (drive it from the NDJSON `step`/`total` lines), never block the UI thread. Cache results to disk by hash of the prompt.
|
- **Slow + heavy** — 4B is ~5.7GB, 9B is ~12GB, generation is multi-second. Always generate in the background with a progress bar (drive it from the NDJSON `step`/`total` lines), never block the UI thread. Cache results to disk by hash of the prompt.
|
||||||
- **Model picker** — add `image_model` to `LlmConfig` (default `x/flux2-klein:4b`; `x/z-image-turbo` for fast/low-VRAM). Reuse the existing settings panel, don't build a second one.
|
- **Model picker** — add `image_model` to `LlmConfig` (default `x/flux2-klein:4b`; `x/z-image-turbo` for fast/low-VRAM). Reuse the existing settings panel, don't build a second one.
|
||||||
|
|
||||||
|
> **Superseded (2026-09):** image generation now targets a
|
||||||
|
> [stable-diffusion.cpp](https://github.com/leejet/stable-diffusion.cpp)
|
||||||
|
> `sd-server` via its AUTOMATIC1111-compatible API — cross-platform, no
|
||||||
|
> macOS gating, no per-request model field. See README and
|
||||||
|
> `src-tauri/src/commands/image_commands.rs`. Everything below (this section
|
||||||
|
> and §10's image-model rows) is kept as design history only.
|
||||||
- **Prompt engineering is the lever** — FLUX.2 handles readable text and hex colors, so item/NPC name labels can be rendered *into* the image where it helps. Default to 1024×1024.
|
- **Prompt engineering is the lever** — FLUX.2 handles readable text and hex colors, so item/NPC name labels can be rendered *into* the image where it helps. Default to 1024×1024.
|
||||||
|
|
||||||
---
|
---
|
||||||
@@ -759,7 +766,7 @@ Local LLMs are not "fire and forget." Plan for:
|
|||||||
| **Loading state** | Model load can take 5–30 s on HDD/CPU. Show progress bar and cancel button |
|
| **Loading state** | Model load can take 5–30 s on HDD/CPU. Show progress bar and cancel button |
|
||||||
| **GPU offloading** | Expose `n_gpu_layers` slider per model |
|
| **GPU offloading** | Expose `n_gpu_layers` slider per model |
|
||||||
| **Context length** | 2k/4k/8k selector with memory warning |
|
| **Context length** | 2k/4k/8k selector with memory warning |
|
||||||
| **Image model** | Separate `image_model` field in `LlmConfig` (default `x/flux2-klein:4b`, `x/z-image-turbo` for speed). macOS-only — show a gated notice on Linux/Windows and disable the ✨ buttons. Drive the progress bar from NDJSON `step`/`total`. |
|
| **Image model** | Separate `image_model` field in `LlmConfig` (default `x/flux2-klein:4b`, `x/z-image-turbo` for speed). macOS-only — show a gated notice on Linux/Windows and disable the ✨ buttons. Drive the progress bar from NDJSON `step`/`total`. **Superseded 2026-09 — see the banner in §4.4.** |
|
||||||
| **Generation controls** | Streaming toggle, temperature, top-p, repeat-penalty per tool |
|
| **Generation controls** | Streaming toggle, temperature, top-p, repeat-penalty per tool |
|
||||||
| **License acceptance** | First-run "model license + download" wizard; don't silently bundle 4 GB models |
|
| **License acceptance** | First-run "model license + download" wizard; don't silently bundle 4 GB models |
|
||||||
|
|
||||||
|
|||||||
@@ -1,24 +0,0 @@
|
|||||||
<svg xmlns="http://www.w3.org/2000/svg">
|
|
||||||
<symbol id="bluesky-icon" viewBox="0 0 16 17">
|
|
||||||
<g clip-path="url(#bluesky-clip)"><path fill="#08060d" d="M7.75 7.735c-.693-1.348-2.58-3.86-4.334-5.097-1.68-1.187-2.32-.981-2.74-.79C.188 2.065.1 2.812.1 3.251s.241 3.602.398 4.13c.52 1.744 2.367 2.333 4.07 2.145-2.495.37-4.71 1.278-1.805 4.512 3.196 3.309 4.38-.71 4.987-2.746.608 2.036 1.307 5.91 4.93 2.746 2.72-2.746.747-4.143-1.747-4.512 1.702.189 3.55-.4 4.07-2.145.156-.528.397-3.691.397-4.13s-.088-1.186-.575-1.406c-.42-.19-1.06-.395-2.741.79-1.755 1.24-3.64 3.752-4.334 5.099"/></g>
|
|
||||||
<defs><clipPath id="bluesky-clip"><path fill="#fff" d="M.1.85h15.3v15.3H.1z"/></clipPath></defs>
|
|
||||||
</symbol>
|
|
||||||
<symbol id="discord-icon" viewBox="0 0 20 19">
|
|
||||||
<path fill="#08060d" d="M16.224 3.768a14.5 14.5 0 0 0-3.67-1.153c-.158.286-.343.67-.47.976a13.5 13.5 0 0 0-4.067 0c-.128-.306-.317-.69-.476-.976A14.4 14.4 0 0 0 3.868 3.77C1.546 7.28.916 10.703 1.231 14.077a14.7 14.7 0 0 0 4.5 2.306q.545-.748.965-1.587a9.5 9.5 0 0 1-1.518-.74q.191-.14.372-.293c2.927 1.369 6.107 1.369 8.999 0q.183.152.372.294-.723.437-1.52.74.418.838.963 1.588a14.6 14.6 0 0 0 4.504-2.308c.37-3.911-.63-7.302-2.644-10.309m-9.13 8.234c-.878 0-1.599-.82-1.599-1.82 0-.998.705-1.82 1.6-1.82.894 0 1.614.82 1.599 1.82.001 1-.705 1.82-1.6 1.82m5.91 0c-.878 0-1.599-.82-1.599-1.82 0-.998.705-1.82 1.6-1.82.893 0 1.614.82 1.599 1.82 0 1-.706 1.82-1.6 1.82"/>
|
|
||||||
</symbol>
|
|
||||||
<symbol id="documentation-icon" viewBox="0 0 21 20">
|
|
||||||
<path fill="none" stroke="#aa3bff" stroke-linecap="round" stroke-linejoin="round" stroke-width="1.35" d="m15.5 13.333 1.533 1.322c.645.555.967.833.967 1.178s-.322.623-.967 1.179L15.5 18.333m-3.333-5-1.534 1.322c-.644.555-.966.833-.966 1.178s.322.623.966 1.179l1.534 1.321"/>
|
|
||||||
<path fill="none" stroke="#aa3bff" stroke-linecap="round" stroke-linejoin="round" stroke-width="1.35" d="M17.167 10.836v-4.32c0-1.41 0-2.117-.224-2.68-.359-.906-1.118-1.621-2.08-1.96-.599-.21-1.349-.21-2.848-.21-2.623 0-3.935 0-4.983.369-1.684.591-3.013 1.842-3.641 3.428C3 6.449 3 7.684 3 10.154v2.122c0 2.558 0 3.838.706 4.726q.306.383.713.671c.76.536 1.79.64 3.581.66"/>
|
|
||||||
<path fill="none" stroke="#aa3bff" stroke-linecap="round" stroke-linejoin="round" stroke-width="1.35" d="M3 10a2.78 2.78 0 0 1 2.778-2.778c.555 0 1.209.097 1.748-.047.48-.129.854-.503.982-.982.145-.54.048-1.194.048-1.749a2.78 2.78 0 0 1 2.777-2.777"/>
|
|
||||||
</symbol>
|
|
||||||
<symbol id="github-icon" viewBox="0 0 19 19">
|
|
||||||
<path fill="#08060d" fill-rule="evenodd" d="M9.356 1.85C5.05 1.85 1.57 5.356 1.57 9.694a7.84 7.84 0 0 0 5.324 7.44c.387.079.528-.168.528-.376 0-.182-.013-.805-.013-1.454-2.165.467-2.616-.935-2.616-.935-.349-.91-.864-1.143-.864-1.143-.71-.48.051-.48.051-.48.787.051 1.2.805 1.2.805.695 1.194 1.817.857 2.268.649.064-.507.27-.857.49-1.052-1.728-.182-3.545-.857-3.545-3.87 0-.857.31-1.558.8-2.104-.078-.195-.349-1 .077-2.078 0 0 .657-.208 2.14.805a7.5 7.5 0 0 1 1.946-.26c.657 0 1.328.092 1.946.26 1.483-1.013 2.14-.805 2.14-.805.426 1.078.155 1.883.078 2.078.502.546.799 1.247.799 2.104 0 3.013-1.818 3.675-3.558 3.87.284.247.528.714.528 1.454 0 1.052-.012 1.896-.012 2.156 0 .208.142.455.528.377a7.84 7.84 0 0 0 5.324-7.441c.013-4.338-3.48-7.844-7.773-7.844" clip-rule="evenodd"/>
|
|
||||||
</symbol>
|
|
||||||
<symbol id="social-icon" viewBox="0 0 20 20">
|
|
||||||
<path fill="none" stroke="#aa3bff" stroke-linecap="round" stroke-linejoin="round" stroke-width="1.35" d="M12.5 6.667a4.167 4.167 0 1 0-8.334 0 4.167 4.167 0 0 0 8.334 0"/>
|
|
||||||
<path fill="none" stroke="#aa3bff" stroke-linecap="round" stroke-linejoin="round" stroke-width="1.35" d="M2.5 16.667a5.833 5.833 0 0 1 8.75-5.053m3.837.474.513 1.035c.07.144.257.282.414.309l.93.155c.596.1.736.536.307.965l-.723.73a.64.64 0 0 0-.152.531l.207.903c.164.715-.213.991-.84.618l-.872-.52a.63.63 0 0 0-.577 0l-.872.52c-.624.373-1.003.094-.84-.618l.207-.903a.64.64 0 0 0-.152-.532l-.723-.729c-.426-.43-.289-.864.306-.964l.93-.156a.64.64 0 0 0 .412-.31l.513-1.034c.28-.562.735-.562 1.012 0"/>
|
|
||||||
</symbol>
|
|
||||||
<symbol id="x-icon" viewBox="0 0 19 19">
|
|
||||||
<path fill="#08060d" fill-rule="evenodd" d="M1.893 1.98c.052.072 1.245 1.769 2.653 3.77l2.892 4.114c.183.261.333.48.333.486s-.068.089-.152.183l-.522.593-.765.867-3.597 4.087c-.375.426-.734.834-.798.905a1 1 0 0 0-.118.148c0 .01.236.017.664.017h.663l.729-.83c.4-.457.796-.906.879-.999a692 692 0 0 0 1.794-2.038c.034-.037.301-.34.594-.675l.551-.624.345-.392a7 7 0 0 1 .34-.374c.006 0 .93 1.306 2.052 2.903l2.084 2.965.045.063h2.275c1.87 0 2.273-.003 2.266-.021-.008-.02-1.098-1.572-3.894-5.547-2.013-2.862-2.28-3.246-2.273-3.266.008-.019.282-.332 2.085-2.38l2-2.274 1.567-1.782c.022-.028-.016-.03-.65-.03h-.674l-.3.342a871 871 0 0 1-1.782 2.025c-.067.075-.405.458-.75.852a100 100 0 0 1-.803.91c-.148.172-.299.344-.99 1.127-.304.343-.32.358-.345.327-.015-.019-.904-1.282-1.976-2.808L6.365 1.85H1.8zm1.782.91 8.078 11.294c.772 1.08 1.413 1.973 1.425 1.984.016.017.241.02 1.05.017l1.03-.004-2.694-3.766L7.796 5.75 5.722 2.852l-1.039-.004-1.039-.004z" clip-rule="evenodd"/>
|
|
||||||
</symbol>
|
|
||||||
</svg>
|
|
||||||
|
Before Width: | Height: | Size: 4.9 KiB |
@@ -43,9 +43,14 @@ node -e '
|
|||||||
if(out===t)throw new Error("version not replaced in "+f);
|
if(out===t)throw new Error("version not replaced in "+f);
|
||||||
fs.writeFileSync(f,out);
|
fs.writeFileSync(f,out);
|
||||||
}
|
}
|
||||||
|
// Cargo.toml: first top-of-file `version = "x.y.z"` (not the deps below it).
|
||||||
|
{const f="src-tauri/Cargo.toml",t=fs.readFileSync(f,"utf8");
|
||||||
|
const out=t.replace(/^version\s*=\s*"\d+\.\d+\.\d+"/m,`version = "${ver}"`);
|
||||||
|
if(out===t)throw new Error("version not replaced in "+f);
|
||||||
|
fs.writeFileSync(f,out);}
|
||||||
' "$VER"
|
' "$VER"
|
||||||
echo "release $TAG (version files synced)"
|
echo "release $TAG (version files synced)"
|
||||||
git add package.json src-tauri/tauri.conf.json
|
git add package.json src-tauri/tauri.conf.json src-tauri/Cargo.toml
|
||||||
if ! git diff --cached --quiet; then
|
if ! git diff --cached --quiet; then
|
||||||
git commit -m "chore: release $TAG" -q
|
git commit -m "chore: release $TAG" -q
|
||||||
echo "committed version bump"
|
echo "committed version bump"
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
[package]
|
[package]
|
||||||
name = "dm-pal"
|
name = "dm-pal"
|
||||||
version = "0.1.0"
|
version = "0.1.3"
|
||||||
description = "AI-Powered Dungeon Master Toolkit"
|
description = "AI-Powered Dungeon Master Toolkit"
|
||||||
authors = ["DM-Pal Team"]
|
authors = ["DM-Pal Team"]
|
||||||
license = ""
|
license = ""
|
||||||
|
|||||||
Reference in New Issue
Block a user