Add MIT licence and a repo README

The repo went public with no LICENSE, which means default copyright — nobody
could legally reuse any of it. MIT throughout, covering the generator and the
VANITY prose alike.

Also adds a README, since the front page was previously a design document that
opened mid-argument, and sets module.json's license field so Foundry shows it.

Module to 0.1.2 so the released zip carries LICENSE too.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This commit is contained in:
2026-08-05 12:55:33 +01:00
co-authored by Claude Opus 5
parent decb3bf930
commit 1be441f775
4 changed files with 99 additions and 2 deletions
+21
View File
@@ -0,0 +1,21 @@
MIT License
Copyright (c) 2026 slaguru666
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
+54
View File
@@ -0,0 +1,54 @@
# DELVE
An authoring system and Foundry VTT module for the **VANITY** tabletop RPG. Press one button and
it generates a whole dungeon — fiction, areas, maps, encounters, hoards and a journal you can read
cold — then drops it into your world.
## Install (Foundry)
**Add-on Modules → Install Module → Manifest URL:**
```
https://github.com/slaguru666/vanity-delve/releases/latest/download/module.json
```
Requires the [VANITY](https://github.com/slaguru666/Vanity) system, **0.10.5 or later**.
* **⛏** raise a dungeon
* **🗑** remove one you don't want — it deletes exactly what it made and nothing else
* **⏩** stage a delve you finished at the desk
## Also a CLI
`core/` is pure JavaScript with no Foundry dependencies, so a delve can be generated, rerolled and
finished outside the VTT:
```bash
node core/cli.mjs --new --seed=my-delve --file=my.json
node core/cli.mjs --file=my.json --worksheet # everything, with prompts for what only you can write
node core/cli.mjs --file=my.json --reroll=3:situation
node core/cli.mjs --file=my.json --play # the tight, table-facing sheet
```
## What it does and does not do
It generates the fiction, the order and the pressure. It does **not** write your read-aloud text
or your climax, and it says so — those are prompts, not output. It gets you to a strong first
draft in a minute instead of an evening, then gets out of the way.
[`DESIGN.md`](DESIGN.md) has the whole design history, including four rounds of adversarial review
and two paper playtests that failed before anything worked.
## Layout
| | |
|---|---|
| `core/` | the generator — pure JS, 39 tests |
| `foundry-module/` | the Foundry module, with `core/` vendored |
| `paper/` | a hand-written delve and both playtest logs |
| `spike/` | the harness that measured VANITY's Forge outside Foundry |
| `samples/` | generated output |
## Licence
MIT — see [LICENSE](LICENSE).
+21
View File
@@ -0,0 +1,21 @@
MIT License
Copyright (c) 2026 slaguru666
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
+3 -2
View File
@@ -2,7 +2,7 @@
"id": "vanity-delve", "id": "vanity-delve",
"title": "DELVE — a dungeon layer for VANITY", "title": "DELVE — a dungeon layer for VANITY",
"description": "Generates a coherent delve and sequences VANITY's Forge to stage it, one area at a time.", "description": "Generates a coherent delve and sequences VANITY's Forge to stage it, one area at a time.",
"version": "0.1.1", "version": "0.1.2",
"compatibility": { "compatibility": {
"minimum": "13", "minimum": "13",
"verified": "14.365" "verified": "14.365"
@@ -32,5 +32,6 @@
"manifest": "https://github.com/slaguru666/vanity-delve/releases/latest/download/module.json", "manifest": "https://github.com/slaguru666/vanity-delve/releases/latest/download/module.json",
"download": "https://github.com/slaguru666/vanity-delve/releases/latest/download/vanity-delve.zip", "download": "https://github.com/slaguru666/vanity-delve/releases/latest/download/vanity-delve.zip",
"url": "https://github.com/slaguru666/vanity-delve", "url": "https://github.com/slaguru666/vanity-delve",
"readme": "https://github.com/slaguru666/vanity-delve/blob/main/foundry-module/README.md" "readme": "https://github.com/slaguru666/vanity-delve/blob/main/foundry-module/README.md",
"license": "https://github.com/slaguru666/vanity-delve/blob/main/LICENSE"
} }