Compare commits
18
Commits
2026-02-28
...
836fe55e58
| Author | SHA1 | Date | |
|---|---|---|---|
 Madison Grubb
|
836fe55e58 | ||
 Renovate Bot
|
e621505cf2 | ||
|
Renovate Bot
|
9cc8cb5f9b | ||
|
Renovate Bot
|
869f0b0c55 | ||
|
Renovate Bot
|
f8f4da4613 | ||
|
Renovate Bot
|
ecbc7e79e9 | ||
|
Renovate Bot
|
866cb8b43f | ||
|
Renovate Bot
|
5495d7640f | ||
|
Renovate Bot
|
cd5a5bff79 | ||
|
Renovate Bot
|
e6036fd831 | ||
|
Renovate Bot
|
b42210cb0c | ||
 Keli Grubb
|
2cb57aed41 | ||
|
Keli Grubb
|
1e7c5855e5 | ||
|
Keli Grubb
|
7ea9f93dc8 | ||
|
Renovate Bot
|
4428cd4cb8 | ||
|
Renovate Bot
|
90eb88d26e | ||
|
Keli GrubbandMadison Grubb
|
fb2ffeb4fe | ||
|
Keli GrubbandMadison Grubb
|
01d1b369b7 |
@@ -0,0 +1,43 @@
|
||||
name: PR
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
|
||||
jobs:
|
||||
lint:
|
||||
name: lint
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: https://git.keligrubb.com/actions/checkout@v7
|
||||
|
||||
- name: Setup Node
|
||||
uses: https://git.keligrubb.com/actions/setup-node@v6
|
||||
with:
|
||||
node-version: "24"
|
||||
cache: "npm"
|
||||
|
||||
- name: Install dependencies
|
||||
run: npm ci
|
||||
|
||||
- name: Lint
|
||||
run: npm run lint
|
||||
|
||||
test-coverage:
|
||||
name: test-coverage
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: https://git.keligrubb.com/actions/checkout@v7
|
||||
|
||||
- name: Setup Node
|
||||
uses: https://git.keligrubb.com/actions/setup-node@v6
|
||||
with:
|
||||
node-version: "24"
|
||||
cache: "npm"
|
||||
|
||||
- name: Install dependencies
|
||||
run: npm ci
|
||||
|
||||
- name: Test with coverage
|
||||
run: npm run test:coverage
|
||||
@@ -0,0 +1,87 @@
|
||||
name: Release
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [main]
|
||||
schedule:
|
||||
- cron: "0 0 * * *"
|
||||
|
||||
jobs:
|
||||
generate-dungeon:
|
||||
name: generate-dungeon
|
||||
runs-on: ubuntu-latest
|
||||
container:
|
||||
image: ghcr.io/puppeteer/puppeteer:latest
|
||||
env:
|
||||
OLLAMA_API_URL: https://ai.keligrubb.com/api/chat/completions
|
||||
OLLAMA_API_KEY: ${{ secrets.OLLAMA_API_KEY }}
|
||||
OLLAMA_MODEL: qwen3.5-122b-a10b
|
||||
COMFYUI_URL: http://192.168.1.124:8188
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: https://git.keligrubb.com/actions/checkout@v7
|
||||
|
||||
- name: Setup Node
|
||||
uses: https://git.keligrubb.com/actions/setup-node@v6
|
||||
with:
|
||||
node-version: "24"
|
||||
cache: "npm"
|
||||
|
||||
- name: Install dependencies
|
||||
run: npm ci
|
||||
|
||||
- name: Generate dungeon PDF
|
||||
run: npm start
|
||||
|
||||
- name: Upload PDF artifact
|
||||
uses: https://git.keligrubb.com/actions/upload-artifact@v3
|
||||
with:
|
||||
name: release-pdf
|
||||
path: "*.pdf"
|
||||
|
||||
upload-to-gitea-release:
|
||||
name: upload-to-gitea-release
|
||||
runs-on: ubuntu-latest
|
||||
needs: generate-dungeon
|
||||
env:
|
||||
GITEA_TOKEN: ${{ secrets.SCROLLSMITH_GITEA_TOKEN }}
|
||||
steps:
|
||||
- name: Download PDF artifact
|
||||
uses: https://git.keligrubb.com/actions/download-artifact@v3
|
||||
with:
|
||||
name: release-pdf
|
||||
path: .
|
||||
|
||||
- name: Create release and upload PDF
|
||||
run: |
|
||||
api_base="https://git.keligrubb.com/api/v1/repos/${{ gitea.repository }}"
|
||||
pdf=$(ls *.pdf | head -n1)
|
||||
tag=$(date +%F)
|
||||
echo "Creating release for tag $tag..."
|
||||
create_resp=$(curl -s -w "%{http_code}" -o /tmp/create.json -X POST \
|
||||
-H "Authorization: token $GITEA_TOKEN" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d "{\"tag_name\":\"$tag\",\"name\":\"$tag\"}" \
|
||||
"$api_base/releases")
|
||||
echo "Create release HTTP status: $create_resp"
|
||||
echo "Fetching release ID..."
|
||||
release_id=$(curl -s \
|
||||
-H "Authorization: token $GITEA_TOKEN" \
|
||||
"$api_base/releases/tags/$tag" |
|
||||
awk -F: '/"id"[ ]*:/ {gsub(/[^0-9]/,"",$2); print $2; exit}')
|
||||
echo "Release ID = $release_id"
|
||||
echo "Checking if asset $pdf already exists..."
|
||||
assets=$(curl -s -H "Authorization: token $GITEA_TOKEN" \
|
||||
"$api_base/releases/$release_id/assets")
|
||||
echo "Assets response: $assets"
|
||||
if echo "$assets" | grep -q "\"name\":\"$pdf\""; then
|
||||
echo "Asset $pdf already uploaded, skipping."
|
||||
exit 0
|
||||
fi
|
||||
echo "Uploading $pdf to release $release_id..."
|
||||
upload_resp=$(curl -s -w "%{http_code}" -o /tmp/upload.json -X POST \
|
||||
-H "Authorization: token $GITEA_TOKEN" \
|
||||
-F "attachment=@$pdf" \
|
||||
"$api_base/releases/$release_id/assets")
|
||||
echo "Upload HTTP status: $upload_resp"
|
||||
echo "Upload response: $(cat /tmp/upload.json)"
|
||||
@@ -1,19 +0,0 @@
|
||||
workspace:
|
||||
base: /woodpecker
|
||||
path: pr
|
||||
|
||||
when:
|
||||
- event: pull_request
|
||||
|
||||
steps:
|
||||
- name: lint
|
||||
image: node:24-slim
|
||||
commands:
|
||||
- npm ci
|
||||
- npm run lint
|
||||
|
||||
- name: test-coverage
|
||||
image: node:24-slim
|
||||
commands:
|
||||
- npm ci
|
||||
- npm run test:coverage
|
||||
@@ -1,61 +0,0 @@
|
||||
workspace:
|
||||
base: /woodpecker
|
||||
path: release
|
||||
|
||||
when:
|
||||
- event: cron
|
||||
branch: main
|
||||
- event: push
|
||||
branch: main
|
||||
|
||||
steps:
|
||||
- name: generate-dungeon
|
||||
image: ghcr.io/puppeteer/puppeteer:latest
|
||||
environment:
|
||||
OLLAMA_API_URL:
|
||||
from_secret: OLLAMA_API_URL
|
||||
OLLAMA_API_KEY:
|
||||
from_secret: OLLAMA_API_KEY
|
||||
COMFYUI_URL:
|
||||
from_secret: COMFYUI_URL
|
||||
commands:
|
||||
- npm ci
|
||||
- npm start
|
||||
|
||||
- name: upload-to-gitea-release
|
||||
image: curlimages/curl:latest
|
||||
environment:
|
||||
GITEA_TOKEN:
|
||||
from_secret: GITEA_TOKEN
|
||||
commands:
|
||||
- pdf=$(ls *.pdf | head -n1)
|
||||
- tag=$(date +%F)
|
||||
- |
|
||||
echo "Creating release for tag $tag..."
|
||||
create_resp=$(curl -s -w "%{http_code}" -o /tmp/create.json -X POST \
|
||||
-H "Authorization: token $GITEA_TOKEN" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d "{\"tag_name\":\"$tag\",\"name\":\"$tag\"}" \
|
||||
https://git.keligrubb.com/api/v1/repos/keligrubb/scrollsmith/releases)
|
||||
echo "Create release HTTP status: $create_resp"
|
||||
echo "Fetching release ID..."
|
||||
release_id=$(curl -s \
|
||||
-H "Authorization: token $GITEA_TOKEN" \
|
||||
https://git.keligrubb.com/api/v1/repos/keligrubb/scrollsmith/releases/tags/$tag |
|
||||
awk -F: '/"id"[ ]*:/ {gsub(/[^0-9]/,"",$2); print $2; exit}')
|
||||
echo "Release ID = $release_id"
|
||||
echo "Checking if asset $pdf already exists..."
|
||||
assets=$(curl -s -H "Authorization: token $GITEA_TOKEN" \
|
||||
https://git.keligrubb.com/api/v1/repos/keligrubb/scrollsmith/releases/$release_id/assets)
|
||||
echo "Assets response: $assets"
|
||||
if echo "$assets" | grep -q "\"name\":\"$pdf\""; then
|
||||
echo "Asset $pdf already uploaded, skipping."
|
||||
exit 0
|
||||
fi
|
||||
echo "Uploading $pdf to release $release_id..."
|
||||
upload_resp=$(curl -s -w "%{http_code}" -o /tmp/upload.json -X POST \
|
||||
-H "Authorization: token $GITEA_TOKEN" \
|
||||
-F "attachment=@$pdf" \
|
||||
https://git.keligrubb.com/api/v1/repos/keligrubb/scrollsmith/releases/$release_id/assets)
|
||||
echo "Upload HTTP status: $upload_resp"
|
||||
echo "Upload response: $(cat /tmp/upload.json)"
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
[](https://ci.keligrubb.com/repos/2)
|
||||
|
||||
Scrollsmith is a Node.js tool for generating Dungeons & Dragons one-page dungeon PDFs automatically. It uses an Ollama LLM server to create dungeon content, proofreads and refines it, then formats it into a structured PDF with maps, rooms, encounters, treasure, and NPCs.
|
||||
Scrollsmith is a Node.js tool for generating Dungeons & Dragons one-page dungeon PDFs automatically. It calls an LLM (Open WebUI `/api/chat/completions` or Ollama `/api/generate`, inferred from `OLLAMA_API_URL`), proofreads and refines the result, then builds a structured PDF with maps, rooms, encounters, treasure, and NPCs.
|
||||
|
||||
---
|
||||
|
||||
@@ -14,20 +14,21 @@ Scrollsmith is a Node.js tool for generating Dungeons & Dragons one-page dungeon
|
||||
3. JSON conversion: output strictly valid JSON for PDF generation
|
||||
- Automatically generates a PDF named after the dungeon title
|
||||
- PDF layout includes three columns: map & hooks, rooms, encounters & treasure & NPCs
|
||||
- Easy to integrate with a local Ollama server
|
||||
- Open WebUI or Ollama
|
||||
|
||||
---
|
||||
|
||||
## Requirements
|
||||
|
||||
- Node.js 22+
|
||||
- Ollama server running and accessible
|
||||
- LLM endpoint (see below)
|
||||
- Gitea Releases (optional) for PDF uploads
|
||||
- `.env` file with:
|
||||
|
||||
```env
|
||||
OLLAMA_API_URL=http://localhost:3000/api/chat/completions
|
||||
OLLAMA_API_URL=https://your-openwebui-host/api/chat/completions
|
||||
OLLAMA_API_KEY=your_api_key_here
|
||||
OLLAMA_MODEL=qwen3.5-122b-a10b
|
||||
COMFYUI_URL=http://192.168.1.124:8188
|
||||
```
|
||||
|
||||
@@ -56,17 +57,18 @@ OLLAMA_API_URL=http://localhost:11434/api/generate
|
||||
### Open WebUI API
|
||||
For Open WebUI API calls, set:
|
||||
```env
|
||||
OLLAMA_API_URL=http://localhost:3000/api/chat/completions
|
||||
OLLAMA_API_URL=https://your-openwebui-host/api/chat/completions
|
||||
OLLAMA_API_KEY=your_open_webui_api_key
|
||||
OLLAMA_MODEL=qwen3.5-122b-a10b
|
||||
```
|
||||
|
||||
> Note: The API type is automatically inferred from the endpoint URL. If the URL contains `/api/chat/completions`, it uses Open WebUI API. If it contains `/api/generate`, it uses direct Ollama API. No `OLLAMA_API_TYPE` environment variable is required.
|
||||
> Note: The API type is inferred from the URL (`/api/chat/completions` vs `/api/generate`); no `OLLAMA_API_TYPE` variable.
|
||||
|
||||
---
|
||||
|
||||
## Usage
|
||||
|
||||
1. Make sure your Ollama server is running and `.env` is configured.
|
||||
1. Configure `.env` and ensure the LLM endpoint is reachable.
|
||||
2. Run:
|
||||
|
||||
```bash
|
||||
@@ -81,7 +83,7 @@ Optional: update the map path in `index.js` if you have a local dungeon map.
|
||||
|
||||
## Project structure
|
||||
|
||||
- **`index.js`** – Entry point: loads env, initializes the Ollama model, runs dungeon generation, image generation, and PDF output.
|
||||
- **`index.js`** – Entry point: env, model init, dungeon + image + PDF.
|
||||
- **`src/`** – Application modules:
|
||||
- `dungeonGenerator.js` – LLM-backed dungeon content generation and validation.
|
||||
- `dungeonTemplate.js` – HTML template and layout for the PDF.
|
||||
@@ -105,7 +107,7 @@ Optional: update the map path in `index.js` if you have a local dungeon map.
|
||||
|
||||
## Notes
|
||||
|
||||
* Make sure your Ollama server is accessible and API key is valid.
|
||||
* Open WebUI needs a valid `OLLAMA_API_KEY` when the server requires it.
|
||||
* Dungeon generation can take a few minutes depending on your LLM response time.
|
||||
|
||||
---
|
||||
|
||||
@@ -2,7 +2,7 @@ import "dotenv/config";
|
||||
import { generateDungeon } from "./src/dungeonGenerator.js";
|
||||
import { generateDungeonImages } from "./src/imageGenerator.js";
|
||||
import { generatePDF } from "./src/generatePDF.js";
|
||||
import { OLLAMA_MODEL, initializeModel } from "./src/ollamaClient.js";
|
||||
import { initializeModel } from "./src/ollamaClient.js";
|
||||
|
||||
// Utility to create a filesystem-safe filename from the dungeon title
|
||||
function slugify(text) {
|
||||
@@ -18,18 +18,15 @@ function slugify(text) {
|
||||
throw new Error("OLLAMA_API_URL environment variable is required");
|
||||
}
|
||||
console.log("Using Ollama API URL:", process.env.OLLAMA_API_URL);
|
||||
|
||||
// Initialize model (will fetch default from API or use fallback)
|
||||
await initializeModel();
|
||||
console.log("Using Ollama model:", OLLAMA_MODEL);
|
||||
|
||||
const model = await initializeModel();
|
||||
console.log("Using Ollama model:", model);
|
||||
|
||||
// Generate the dungeon data
|
||||
const dungeonData = await generateDungeon();
|
||||
|
||||
// Generate dungeon map image (uses dungeonData.flavor)
|
||||
const mapPath = await generateDungeonImages(dungeonData);
|
||||
|
||||
dungeonData.map = mapPath;
|
||||
if (mapPath) dungeonData.map = mapPath;
|
||||
|
||||
// Generate PDF filename based on the title
|
||||
const filename = `${slugify(dungeonData.title)}.pdf`;
|
||||
|
||||
Generated
+1048
-2318
File diff suppressed because it is too large
Load Diff
+6
-6
@@ -15,15 +15,15 @@
|
||||
"license": "SEE LICENSE IN README.md",
|
||||
"description": "",
|
||||
"dependencies": {
|
||||
"dotenv": "^17.2.1",
|
||||
"puppeteer": "^24.17.1",
|
||||
"sharp": "^0.34.3"
|
||||
"dotenv": "^17.4.2",
|
||||
"puppeteer": "^25.3.0",
|
||||
"sharp": "^0.35.3"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@eslint/js": "^10.0.0",
|
||||
"@eslint/js": "^10.0.1",
|
||||
"@vitest/coverage-v8": "^4.0.18",
|
||||
"eslint": "^10.0.0",
|
||||
"globals": "^17.0.0",
|
||||
"eslint": "^10.7.0",
|
||||
"globals": "^17.7.0",
|
||||
"vitest": "^4.0.18"
|
||||
}
|
||||
}
|
||||
|
||||
+147
-116
@@ -117,132 +117,163 @@ Output ONLY the two numbered items, one per line. Use colons (:) to separate roo
|
||||
console.log("Climax Room:", climaxRoom);
|
||||
|
||||
// Step 5: Main Content (Locations, Encounters, NPCs, Treasures, Random Events)
|
||||
const mainContentRaw = await callOllama(
|
||||
`Based on the following dungeon elements and the need for narrative flow:
|
||||
Title: "${title}"
|
||||
// To avoid overloading the AI server with a single huge prompt, we generate
|
||||
// each section in smaller, focused calls and then stitch them together.
|
||||
|
||||
const sharedContext = `Title: "${title}"
|
||||
Description: "${flavor}"
|
||||
Core Concepts:
|
||||
${coreConcepts}
|
||||
Entrance Room: ${JSON.stringify(entranceRoom)}
|
||||
Climax Room: ${JSON.stringify(climaxRoom)}
|
||||
Climax Room: ${JSON.stringify(climaxRoom)}`;
|
||||
|
||||
Generate the rest of the dungeon's content to fill the space between the entrance and the climax. CRITICAL: All content must fit on a single one-page dungeon layout with three columns. Keep descriptions rich and evocative with tactical/environmental details.
|
||||
const locationsRaw = await callOllama(
|
||||
`${sharedContext}
|
||||
|
||||
- **Strictly 3 Locations (EXACTLY 3, no more, no less):** Each with a name (max 6 words) and a description (25-35 words). Each room MUST include:
|
||||
- Rich environmental features that affect gameplay (lighting, sounds, smells, textures, temperature, visibility)
|
||||
- Interactable elements that players can use (levers, objects, portals, mechanisms, environmental hazards)
|
||||
- Multiple approaches or solutions to challenges in the room
|
||||
- Tactical considerations (cover, elevation, movement restrictions, line of sight)
|
||||
- Hidden aspects discoverable through interaction or investigation
|
||||
Format as "Name: description" using colons, NOT em-dashes.
|
||||
Generate EXACTLY 3 intermediate dungeon locations between the entrance and climax.
|
||||
|
||||
EXAMPLE LOCATION:
|
||||
"Whispering Gallery: Dim phosphorescent fungi line the walls, casting an eerie green glow. The air hums with a low-frequency vibration that makes conversation difficult. Two collapsed pillars create natural cover, while a narrow ledge 10 feet up offers a sniper position. A hidden pressure plate near the entrance triggers a portcullis trap."
|
||||
Requirements:
|
||||
- Each location gets a unique name (max 6 words) and a description (25-35 words).
|
||||
- Include sensory details and environmental features that affect gameplay (lighting, sounds, smells, textures, temperature, visibility).
|
||||
- Include interactable elements (levers, objects, portals, mechanisms, environmental hazards).
|
||||
- Include tactical considerations (cover, elevation, movement restrictions, line of sight) and at least one hidden aspect per room.
|
||||
|
||||
- **Strictly 6 Encounters:** Numbered 1-6 (for d6 rolling). Name (max 6 words) and details (2 sentences MAX, approximately 25-40 words). Each encounter MUST:
|
||||
- Start with the room/location name followed by a colon, then the details (e.g., "Location Name: Details text")
|
||||
- The location name must match one of the actual room names from this dungeon
|
||||
- Include environmental hazards/opportunities (cover, elevation, traps, interactable objects, terrain features)
|
||||
- Include tactical considerations (positioning, line of sight, escape routes, bottlenecks, high ground)
|
||||
- Offer multiple resolution options (combat, negotiation, stealth, puzzle-solving, environmental manipulation, timing-based solutions)
|
||||
- Include consequences and outcomes tied to player choices
|
||||
- Integrate with the environmental dynamic element from core concepts
|
||||
- At least two encounters must be directly tied to the primary faction
|
||||
Format as "Name: Location Name: details" using colons, NOT em-dashes. CRITICAL: Always start encounter details with the location name and a colon.
|
||||
Format:
|
||||
1. Room Name: Description text.
|
||||
2. Room Name: Description text.
|
||||
3. Room Name: Description text.
|
||||
|
||||
EXAMPLE ENCOUNTER:
|
||||
"Guardian Golem: Chamber of Echoes: The golem activates when the lever is pulled, blocking the exit. It's vulnerable to water damage from the dripping stalactites. Players can use the pillars for cover or try to disable it by breaking the rune on its back. If defeated peacefully, it reveals a hidden passage."
|
||||
|
||||
- **Strictly 4-5 NPCs:** Proper name (max 4 words) and a description (50-65 words). Each NPC MUST include:
|
||||
- Clear motivation or goal
|
||||
- Relationship to primary faction
|
||||
- How they can help or hinder the party
|
||||
- Quirks or memorable traits
|
||||
- Multiple interaction possibilities (negotiation, intimidation, help, betrayal)
|
||||
- One NPC should be a key figure tied to the central conflict
|
||||
- One should be a member of the primary faction, one should be a potential ally, one should be a rival
|
||||
Format as "Name: description" using colons, NOT em-dashes.
|
||||
|
||||
EXAMPLE NPC:
|
||||
"Kaelen the Warden: A former guard who was left behind when the faction retreated. He knows the secret passages but demands the party help him escape. He's paranoid and checks over his shoulder constantly. Can be bribed with food or convinced through shared stories of betrayal. Will turn on the party if he thinks they're working with the faction."
|
||||
|
||||
- **Strictly 4-5 Treasures:** Name (max 5 words) and a description (30-40 words). Each treasure MUST:
|
||||
- Include a clear danger or side-effect
|
||||
- Be connected to a specific encounter, NPC, or room
|
||||
- Have story significance beyond just value
|
||||
- Have potential for creative use beyond obvious purpose
|
||||
- Some should be cursed, have activation requirements, or serve dual purposes
|
||||
Format as "Name — Description" using em-dash.
|
||||
|
||||
EXAMPLE TREASURE:
|
||||
"Whispering Blade — This dagger amplifies the wielder's voice to a deafening roar when drawn. Found in the Guardian Golem's chamber, it was used to command the construct. The blade is cursed: each use permanently reduces the wielder's hearing. Can be used to shatter glass or stun enemies, but the curse cannot be removed."
|
||||
|
||||
- **Strictly 1 Random Events Table:** A d6 table (EXACTLY 6 entries, no more, no less) with random events/wandering encounters. Each entry MUST:
|
||||
- Have a short, evocative event name (max 4 words)
|
||||
- Provide interesting complications or opportunities (not just combat)
|
||||
- Tie to the core concepts and dynamic element
|
||||
- Add replayability and surprise
|
||||
- Description should be 15-20 words maximum
|
||||
- Be UNIQUE and DIFFERENT from each other (no duplicates or generic placeholders)
|
||||
- Be SPECIFIC to this dungeon's theme, conflict, and dynamic element
|
||||
Format as numbered 1-6 list under "Random Events:" label. Each event must be formatted as "Event Name: Description text" using colons, NOT em-dashes.
|
||||
|
||||
CRITICAL: Each item must be on its own numbered line. DO NOT combine multiple items into a single numbered entry.
|
||||
|
||||
EXACT FORMAT REQUIRED (DO NOT use placeholder names like "Location Name", "NPC Name", or "Treasure Name" - use actual creative names):
|
||||
Locations:
|
||||
1. Actual Room Name: Description text.
|
||||
2. Actual Room Name: Description text.
|
||||
3. Actual Room Name: Description text.
|
||||
|
||||
Encounters:
|
||||
1. Actual Encounter Name: Actual Room Name: Details text.
|
||||
2. Actual Encounter Name: Actual Room Name: Details text.
|
||||
3. Actual Encounter Name: Actual Room Name: Details text.
|
||||
4. Actual Encounter Name: Actual Room Name: Details text.
|
||||
5. Actual Encounter Name: Actual Room Name: Details text.
|
||||
6. Actual Encounter Name: Actual Room Name: Details text.
|
||||
|
||||
NPCs:
|
||||
1. Actual Character Name: Description text.
|
||||
2. Actual Character Name: Description text.
|
||||
3. Actual Character Name: Description text.
|
||||
4. Actual Character Name: Description text.
|
||||
|
||||
Treasures:
|
||||
1. Actual Item Name — Description text.
|
||||
2. Actual Item Name — Description text.
|
||||
3. Actual Item Name — Description text.
|
||||
4. Actual Item Name — Description text.
|
||||
|
||||
Random Events:
|
||||
1. Event Name: Event description.
|
||||
2. Event Name: Event description.
|
||||
3. Event Name: Event description.
|
||||
4. Event Name: Event description.
|
||||
5. Event Name: Event description.
|
||||
6. Event Name: Event description.
|
||||
|
||||
CRITICAL: Every name must be unique and creative. Never use generic placeholders like "Location Name", "NPC Name", "Encounter Name", or "Treasure Name". Use actual descriptive names that fit the dungeon's theme.
|
||||
|
||||
CRITICAL: Ensure all spelling is correct. Double-check all words, especially proper nouns, character names, and location names. Verify consistency of names across all sections.
|
||||
|
||||
CRITICAL: Location name matching - When writing encounters, the location name in the encounter details MUST exactly match one of the room names you've created (Entrance Room, Climax Room, or one of the 3 Locations). Double-check that every encounter location matches an actual room name.
|
||||
|
||||
CRITICAL: Avoid vague language - Do not use words like "some", "various", "several", "many", "few", "things", "stuff", "items", or "objects" without specific details. Be concrete and specific in all descriptions.
|
||||
|
||||
CRITICAL: All names required - Every room, encounter, NPC, and treasure MUST have a name. Do not leave names blank or use placeholders. If you cannot think of a name, create one based on the dungeon's theme.
|
||||
|
||||
CRITICAL: You MUST output exactly five separate sections with these exact labels on their own lines:
|
||||
"Locations:"
|
||||
"Encounters:"
|
||||
"NPCs:"
|
||||
"Treasures:"
|
||||
"Random Events:"
|
||||
|
||||
Each section must start with its label on its own line, followed by numbered items. Do NOT combine sections. Do NOT embed encounters in location descriptions. Each item must be on its own numbered line. Do not use any bolding, preambles, or extra text. Do not use em-dashes (—) in encounters or NPCs, only use colons for those sections. Absolutely do not use the word "Obsidian" or "obsidian" anywhere in the output.`,
|
||||
undefined, 5, "Step 5: Main Content"
|
||||
Plain text only. Do not use em-dashes (—). Absolutely do not use the word "Obsidian" or "obsidian" anywhere in the output.`,
|
||||
undefined,
|
||||
5,
|
||||
"Step 5a: Locations"
|
||||
);
|
||||
|
||||
const encountersRaw = await callOllama(
|
||||
`${sharedContext}
|
||||
|
||||
Existing rooms:
|
||||
- Entrance: ${entranceRoom?.name}
|
||||
- Climax: ${climaxRoom?.name}
|
||||
You will add 3 more locations (from the locations list) and must reference only real room names.
|
||||
|
||||
Generate EXACTLY 6 encounters, numbered 1-6 for a d6 table.
|
||||
|
||||
Requirements:
|
||||
- Name (max 6 words) and details (2 sentences MAX, ~25-40 words).
|
||||
- Each encounter MUST start with the room/location name followed by a colon, then the details (e.g., "Room Name: details").
|
||||
- The location name must match either the entrance room, climax room, or one of the 3 new locations.
|
||||
- Include environmental hazards/opportunities and tactical considerations (cover, elevation, traps, bottlenecks, escape routes, high ground).
|
||||
- Offer multiple resolution options (combat, negotiation, stealth, puzzle-solving, environmental manipulation, timing, etc.).
|
||||
- At least two encounters must be directly tied to the primary faction from the core concepts.
|
||||
|
||||
Format:
|
||||
1. Encounter Name: Room Name: Details text.
|
||||
2. Encounter Name: Room Name: Details text.
|
||||
3. Encounter Name: Room Name: Details text.
|
||||
4. Encounter Name: Room Name: Details text.
|
||||
5. Encounter Name: Room Name: Details text.
|
||||
6. Encounter Name: Room Name: Details text.
|
||||
|
||||
Plain text only. Use colons, NOT em-dashes. Absolutely do not use the word "Obsidian" or "obsidian" anywhere in the output.`,
|
||||
undefined,
|
||||
5,
|
||||
"Step 5b: Encounters"
|
||||
);
|
||||
|
||||
const npcsRaw = await callOllama(
|
||||
`${sharedContext}
|
||||
|
||||
Generate 4-5 important NPCs tied to this dungeon.
|
||||
|
||||
Requirements:
|
||||
- Proper name (max 4 words) and a description (50-65 words).
|
||||
- Each NPC must have: clear motivation, relationship to the primary faction, how they can help or hinder the adventurers, and memorable quirks/traits.
|
||||
- Include multiple interaction possibilities (negotiation, intimidation, help, betrayal).
|
||||
- At least one NPC is a key figure tied to the central conflict.
|
||||
- At least one NPC is a member of the primary faction, one is a potential ally, and one is a rival.
|
||||
|
||||
Format:
|
||||
1. NPC Name: Description text.
|
||||
2. NPC Name: Description text.
|
||||
3. NPC Name: Description text.
|
||||
4. NPC Name: Description text.
|
||||
5. NPC Name: Description text. (omit the 5th if only 4 NPCs)
|
||||
|
||||
Plain text only. Use colons, NOT em-dashes. Absolutely do not use the word "Obsidian" or "obsidian" anywhere in the output.`,
|
||||
undefined,
|
||||
5,
|
||||
"Step 5c: NPCs"
|
||||
);
|
||||
|
||||
const treasuresRaw = await callOllama(
|
||||
`${sharedContext}
|
||||
|
||||
Generate 4-5 unique treasures for this dungeon.
|
||||
|
||||
Requirements:
|
||||
- Each treasure has a name (max 5 words) and a description (30-40 words).
|
||||
- Each treasure includes a clear danger or side-effect.
|
||||
- Each treasure is connected to a specific encounter, NPC, or room.
|
||||
- Each has story significance beyond raw value and potential for creative non-obvious uses.
|
||||
- Some should be cursed, have activation requirements, or serve dual purposes.
|
||||
|
||||
Format:
|
||||
1. Item Name — Description text.
|
||||
2. Item Name — Description text.
|
||||
3. Item Name — Description text.
|
||||
4. Item Name — Description text.
|
||||
5. Item Name — Description text. (omit the 5th if only 4 treasures)
|
||||
|
||||
Plain text only. Use an em-dash (—) between name and description. Absolutely do not use the word "Obsidian" or "obsidian" anywhere in the output.`,
|
||||
undefined,
|
||||
5,
|
||||
"Step 5d: Treasures"
|
||||
);
|
||||
|
||||
const randomEventsRaw = await callOllama(
|
||||
`${sharedContext}
|
||||
|
||||
Generate a d6 Random Events table for this dungeon (EXACTLY 6 entries).
|
||||
|
||||
Requirements:
|
||||
- Short, evocative event name (max 4 words) plus description (15-20 words).
|
||||
- Provide interesting complications or opportunities (not just combat).
|
||||
- Tie directly to the core concepts and the dynamic environmental element.
|
||||
- Each event must be UNIQUE and clearly different from the others.
|
||||
|
||||
Format:
|
||||
Random Events:
|
||||
1. Event Name: Description text.
|
||||
2. Event Name: Description text.
|
||||
3. Event Name: Description text.
|
||||
4. Event Name: Description text.
|
||||
5. Event Name: Description text.
|
||||
6. Event Name: Description text.
|
||||
|
||||
Plain text only. Use colons, NOT em-dashes. Absolutely do not use the word "Obsidian" or "obsidian" anywhere in the output.`,
|
||||
undefined,
|
||||
5,
|
||||
"Step 5e: Random Events"
|
||||
);
|
||||
|
||||
const mainContentRaw = [
|
||||
"Locations:",
|
||||
locationsRaw.trim(),
|
||||
"",
|
||||
"Encounters:",
|
||||
encountersRaw.trim(),
|
||||
"",
|
||||
"NPCs:",
|
||||
npcsRaw.trim(),
|
||||
"",
|
||||
"Treasures:",
|
||||
treasuresRaw.trim(),
|
||||
"",
|
||||
"Random Events:",
|
||||
randomEventsRaw.replace(/Random Events:\s*/i, "").trim(),
|
||||
].join("\n");
|
||||
|
||||
const { intermediateRoomsSection, encountersSection, npcsSection, treasureSection, randomEventsSection } =
|
||||
parseMainContentSections(mainContentRaw);
|
||||
|
||||
|
||||
+17
-17
@@ -2,7 +2,7 @@ import sharp from 'sharp';
|
||||
import path from "path";
|
||||
import { mkdir, writeFile } from "fs/promises";
|
||||
import { fileURLToPath } from "url";
|
||||
import { callOllama, OLLAMA_MODEL } from "./ollamaClient.js";
|
||||
import { callOllama } from "./ollamaClient.js";
|
||||
|
||||
const COMFYUI_ENABLED = process.env.COMFYUI_ENABLED !== 'false';
|
||||
const __dirname = path.dirname(fileURLToPath(import.meta.url));
|
||||
@@ -63,7 +63,7 @@ Input:
|
||||
${flavor}
|
||||
|
||||
Output:`,
|
||||
OLLAMA_MODEL,
|
||||
undefined,
|
||||
3,
|
||||
"Generate Visual Prompt"
|
||||
);
|
||||
@@ -239,22 +239,22 @@ export async function generateDungeonImages({ flavor }) {
|
||||
return path.join(__dirname, "dungeon_upscaled.png");
|
||||
}
|
||||
|
||||
const finalPrompt = await generateVisualPrompt(flavor);
|
||||
console.log("Engineered visual prompt:\n", finalPrompt);
|
||||
try {
|
||||
const finalPrompt = await generateVisualPrompt(flavor);
|
||||
console.log("Engineered visual prompt:\n", finalPrompt);
|
||||
|
||||
const baseFilename = `dungeon.png`;
|
||||
const upscaledFilename = `dungeon_upscaled.png`;
|
||||
const baseFilename = `dungeon.png`;
|
||||
const upscaledFilename = `dungeon_upscaled.png`;
|
||||
|
||||
const filepath = await generateImageViaComfyUI(finalPrompt, baseFilename);
|
||||
if (!filepath) {
|
||||
throw new Error("Failed to generate dungeon image.");
|
||||
const filepath = await generateImageViaComfyUI(finalPrompt, baseFilename);
|
||||
if (!filepath) return null;
|
||||
|
||||
const upscaledPath = await upscaleImage(filepath, upscaledFilename, 1456, 1024);
|
||||
if (!upscaledPath) return null;
|
||||
|
||||
return upscaledPath;
|
||||
} catch (err) {
|
||||
console.warn("Map image failed:", err.message);
|
||||
return null;
|
||||
}
|
||||
|
||||
// Upscale 2x (half of A4 at 300dpi)
|
||||
const upscaledPath = await upscaleImage(filepath, upscaledFilename, 1456, 1024);
|
||||
if (!upscaledPath) {
|
||||
throw new Error("Failed to upscale dungeon image.");
|
||||
}
|
||||
|
||||
return upscaledPath;
|
||||
}
|
||||
|
||||
+28
-14
@@ -1,10 +1,16 @@
|
||||
import { cleanText } from "./textUtils.js";
|
||||
|
||||
const OLLAMA_API_URL = process.env.OLLAMA_API_URL;
|
||||
export let OLLAMA_MODEL = process.env.OLLAMA_MODEL || "gemma3:latest";
|
||||
|
||||
export const OLLAMA_MODEL = "qwen3.6-35b-a3b";
|
||||
|
||||
function effectiveModel(explicit) {
|
||||
if (explicit !== undefined && explicit !== null) return explicit;
|
||||
return process.env.OLLAMA_MODEL || OLLAMA_MODEL;
|
||||
}
|
||||
|
||||
export async function initializeModel() {
|
||||
if (process.env.OLLAMA_MODEL) return;
|
||||
if (process.env.OLLAMA_MODEL) return process.env.OLLAMA_MODEL;
|
||||
try {
|
||||
const apiUrl = process.env.OLLAMA_API_URL;
|
||||
const isOpenWebUI = apiUrl?.includes("/api/chat/completions");
|
||||
@@ -16,17 +22,20 @@ export async function initializeModel() {
|
||||
const res = await fetch(url, { headers });
|
||||
if (res.ok) {
|
||||
const data = await res.json();
|
||||
const model = isOpenWebUI
|
||||
const model = isOpenWebUI
|
||||
? data.data?.[0]?.id || data.data?.[0]?.name
|
||||
: data.models?.[0]?.name;
|
||||
if (model) {
|
||||
OLLAMA_MODEL = model;
|
||||
process.env.OLLAMA_MODEL = model;
|
||||
console.log(`Using default model: ${model}`);
|
||||
return model;
|
||||
}
|
||||
}
|
||||
} catch {
|
||||
console.warn(`Could not fetch default model, using: ${OLLAMA_MODEL}`);
|
||||
// fall through to warn below
|
||||
}
|
||||
console.warn(`Could not fetch default model, using: ${OLLAMA_MODEL}`);
|
||||
return OLLAMA_MODEL;
|
||||
}
|
||||
|
||||
export { cleanText };
|
||||
@@ -45,8 +54,10 @@ async function sleep(ms) {
|
||||
async function callOllamaBase(prompt, model, retries, stepName, apiType) {
|
||||
const isUsingOpenWebUI = apiType === "open-webui";
|
||||
const isUsingOllamaChat = apiType === "ollama-chat";
|
||||
const resolvedModel = effectiveModel(model);
|
||||
const attempts = Array.from({ length: retries }, (_, index) => index + 1);
|
||||
|
||||
for (let attempt = 1; attempt <= retries; attempt++) {
|
||||
for (const attempt of attempts) {
|
||||
try {
|
||||
const promptCharCount = prompt.length;
|
||||
const promptWordCount = prompt.split(/\s+/).length;
|
||||
@@ -58,14 +69,17 @@ async function callOllamaBase(prompt, model, retries, stepName, apiType) {
|
||||
`Prompt: ${promptCharCount} chars, ~${promptWordCount} words`,
|
||||
);
|
||||
|
||||
const headers = { "Content-Type": "application/json" };
|
||||
if (isUsingOpenWebUI && process.env.OLLAMA_API_KEY) {
|
||||
headers["Authorization"] = `Bearer ${process.env.OLLAMA_API_KEY}`;
|
||||
}
|
||||
const headers =
|
||||
isUsingOpenWebUI && process.env.OLLAMA_API_KEY
|
||||
? {
|
||||
"Content-Type": "application/json",
|
||||
"Authorization": `Bearer ${process.env.OLLAMA_API_KEY}`,
|
||||
}
|
||||
: { "Content-Type": "application/json" };
|
||||
|
||||
const body = isUsingOpenWebUI || isUsingOllamaChat
|
||||
? { model, messages: [{ role: "user", content: prompt }] }
|
||||
: { model, prompt, stream: false };
|
||||
? { model: resolvedModel, messages: [{ role: "user", content: prompt }] }
|
||||
: { model: resolvedModel, prompt, stream: false };
|
||||
|
||||
const response = await fetch(OLLAMA_API_URL, {
|
||||
method: "POST",
|
||||
@@ -108,7 +122,7 @@ async function callOllamaBase(prompt, model, retries, stepName, apiType) {
|
||||
|
||||
export async function callOllama(
|
||||
prompt,
|
||||
model = OLLAMA_MODEL,
|
||||
model,
|
||||
retries = 5,
|
||||
stepName = "unknown",
|
||||
) {
|
||||
@@ -118,7 +132,7 @@ export async function callOllama(
|
||||
|
||||
export async function callOllamaExplicit(
|
||||
prompt,
|
||||
model = OLLAMA_MODEL,
|
||||
model,
|
||||
retries = 5,
|
||||
stepName = "unknown",
|
||||
apiType = "ollama-generate",
|
||||
|
||||
@@ -6,46 +6,46 @@ import path from "path";
|
||||
|
||||
const hasOllama = !!process.env.OLLAMA_API_URL;
|
||||
|
||||
describe.skipIf(!hasOllama)("Dungeon generation (Ollama)", () => {
|
||||
let dungeonData;
|
||||
describe.skipIf(!hasOllama)("Dungeon generation (Ollama)", { timeout: 120000 }, () => {
|
||||
const fixture = {};
|
||||
|
||||
beforeAll(async () => {
|
||||
dungeonData = await generateDungeon();
|
||||
}, 120000);
|
||||
fixture.dungeon = await generateDungeon();
|
||||
});
|
||||
|
||||
it("generates dungeon data", () => {
|
||||
expect(dungeonData).toBeDefined();
|
||||
expect(fixture.dungeon).toBeDefined();
|
||||
});
|
||||
|
||||
it("title is 2-4 words, no colons", () => {
|
||||
expect(dungeonData.title).toBeTruthy();
|
||||
const words = dungeonData.title.split(/\s+/);
|
||||
expect(fixture.dungeon.title).toBeTruthy();
|
||||
const words = fixture.dungeon.title.split(/\s+/);
|
||||
expect(words.length).toBeGreaterThanOrEqual(2);
|
||||
expect(words.length).toBeLessThanOrEqual(4);
|
||||
expect(dungeonData.title).not.toContain(":");
|
||||
expect(fixture.dungeon.title).not.toContain(":");
|
||||
});
|
||||
|
||||
it("flavor text is ≤60 words", () => {
|
||||
expect(dungeonData.flavor).toBeTruthy();
|
||||
const words = dungeonData.flavor.split(/\s+/);
|
||||
expect(fixture.dungeon.flavor).toBeTruthy();
|
||||
const words = fixture.dungeon.flavor.split(/\s+/);
|
||||
expect(words.length).toBeLessThanOrEqual(60);
|
||||
});
|
||||
|
||||
it("hooks have no title prefixes", () => {
|
||||
expect(dungeonData.hooksRumors).toBeDefined();
|
||||
dungeonData.hooksRumors.forEach((hook) => {
|
||||
expect(fixture.dungeon.hooksRumors).toBeDefined();
|
||||
fixture.dungeon.hooksRumors.forEach((hook) => {
|
||||
expect(hook).not.toMatch(/^[^:]+:\s/);
|
||||
});
|
||||
});
|
||||
|
||||
it("has exactly 6 random events", () => {
|
||||
expect(dungeonData.randomEvents).toBeDefined();
|
||||
expect(dungeonData.randomEvents.length).toBe(6);
|
||||
expect(fixture.dungeon.randomEvents).toBeDefined();
|
||||
expect(fixture.dungeon.randomEvents.length).toBe(6);
|
||||
});
|
||||
|
||||
it("encounter details do not start with encounter name", () => {
|
||||
expect(dungeonData.encounters).toBeDefined();
|
||||
dungeonData.encounters.forEach((encounter) => {
|
||||
expect(fixture.dungeon.encounters).toBeDefined();
|
||||
fixture.dungeon.encounters.forEach((encounter) => {
|
||||
if (encounter.details) {
|
||||
const detailsLower = encounter.details.toLowerCase();
|
||||
const nameLower = encounter.name.toLowerCase();
|
||||
@@ -55,8 +55,8 @@ describe.skipIf(!hasOllama)("Dungeon generation (Ollama)", () => {
|
||||
});
|
||||
|
||||
it("treasure descriptions do not start with 'description'", () => {
|
||||
expect(dungeonData.treasure).toBeDefined();
|
||||
dungeonData.treasure.forEach((item) => {
|
||||
expect(fixture.dungeon.treasure).toBeDefined();
|
||||
fixture.dungeon.treasure.forEach((item) => {
|
||||
if (typeof item === "object" && item.description) {
|
||||
expect(item.description.toLowerCase().startsWith("description")).toBe(false);
|
||||
}
|
||||
@@ -64,8 +64,8 @@ describe.skipIf(!hasOllama)("Dungeon generation (Ollama)", () => {
|
||||
});
|
||||
|
||||
it("NPC traits do not start with 'description'", () => {
|
||||
expect(dungeonData.npcs).toBeDefined();
|
||||
dungeonData.npcs.forEach((npc) => {
|
||||
expect(fixture.dungeon.npcs).toBeDefined();
|
||||
fixture.dungeon.npcs.forEach((npc) => {
|
||||
if (npc.trait) {
|
||||
expect(npc.trait.toLowerCase().startsWith("description")).toBe(false);
|
||||
}
|
||||
@@ -75,11 +75,11 @@ describe.skipIf(!hasOllama)("Dungeon generation (Ollama)", () => {
|
||||
it("PDF fits on one page", async () => {
|
||||
const testPdfPath = path.join(process.cwd(), "test-output.pdf");
|
||||
try {
|
||||
await generatePDF(dungeonData, testPdfPath);
|
||||
await generatePDF(fixture.dungeon, testPdfPath);
|
||||
const pdfBuffer = await fs.readFile(testPdfPath);
|
||||
const pdfText = pdfBuffer.toString("binary");
|
||||
const pageCount = (pdfText.match(/\/Type\s*\/Page[^s]/g) || []).length;
|
||||
const expectedPages = dungeonData.map ? 2 : 1;
|
||||
const expectedPages = fixture.dungeon.map ? 2 : 1;
|
||||
expect(pageCount).toBeLessThanOrEqual(expectedPages);
|
||||
} finally {
|
||||
try {
|
||||
|
||||
@@ -203,16 +203,16 @@ describe("initializeModel (mocked fetch)", () => {
|
||||
expect(globalThis.fetch).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("leaves OLLAMA_MODEL unchanged when fetch returns not ok", async () => {
|
||||
it("does not set env when fetch returns not ok", async () => {
|
||||
process.env.OLLAMA_MODEL = "";
|
||||
const before = OLLAMA_MODEL;
|
||||
vi.mocked(globalThis.fetch).mockResolvedValueOnce({
|
||||
ok: false,
|
||||
status: 404,
|
||||
json: () => Promise.resolve({}),
|
||||
});
|
||||
await initializeModel();
|
||||
expect(OLLAMA_MODEL).toBe(before);
|
||||
const resolved = await initializeModel();
|
||||
expect(resolved).toBe(OLLAMA_MODEL);
|
||||
expect(process.env.OLLAMA_MODEL).toBe("");
|
||||
});
|
||||
|
||||
it("fetches /api/tags when OLLAMA_MODEL not set", async () => {
|
||||
@@ -222,11 +222,13 @@ describe("initializeModel (mocked fetch)", () => {
|
||||
ok: true,
|
||||
json: () => Promise.resolve({ models: [{ name: "test-model" }] }),
|
||||
});
|
||||
await initializeModel();
|
||||
const resolved = await initializeModel();
|
||||
expect(globalThis.fetch).toHaveBeenCalled();
|
||||
const [url, opts] = vi.mocked(globalThis.fetch).mock.calls[0];
|
||||
expect(String(url)).toMatch(/\/api\/tags$/);
|
||||
expect(opts?.method || "GET").toBe("GET");
|
||||
expect(resolved).toBe("test-model");
|
||||
expect(process.env.OLLAMA_MODEL).toBe("test-model");
|
||||
});
|
||||
|
||||
it("fetches /api/v1/models when URL has open-webui path and sets model from data.data id", async () => {
|
||||
@@ -239,7 +241,7 @@ describe("initializeModel (mocked fetch)", () => {
|
||||
await initializeModel();
|
||||
const [url] = vi.mocked(globalThis.fetch).mock.calls[0];
|
||||
expect(String(url)).toMatch(/\/api\/v1\/models$/);
|
||||
expect(OLLAMA_MODEL).toBe("webui-model");
|
||||
expect(process.env.OLLAMA_MODEL).toBe("webui-model");
|
||||
});
|
||||
|
||||
it("sets model from data.data[0].name when id missing", async () => {
|
||||
@@ -250,7 +252,7 @@ describe("initializeModel (mocked fetch)", () => {
|
||||
json: () => Promise.resolve({ data: [{ name: "webui-model-name" }] }),
|
||||
});
|
||||
await initializeModel();
|
||||
expect(OLLAMA_MODEL).toBe("webui-model-name");
|
||||
expect(process.env.OLLAMA_MODEL).toBe("webui-model-name");
|
||||
});
|
||||
|
||||
it("catches fetch failure and warns", async () => {
|
||||
|
||||
Reference in New Issue
Block a user