Docs/Creating & Managing Documents

Creating & Managing Documents

Upload world-knowledge documents, choose who can read them, assign them to NPCs and audiences, track their status, and publish them. Everything you do day-to-day on the World Knowledge page.

Open a project and select World Knowledge from the sidebar (under World). The Documents tab is where you upload knowledge, control who can read it, and push it live.

Upload a document

1
Click Add document. A panel slides in from the right.
2
Choose a .txt, .md or .pdf file (your plan sets the maximum size and number of documents).
3
Pick who can read it — Restricted (default) or Everyone.
4
Optionally turn on 'Make it readable now' (off by default, so the document starts as a draft).
5
Click Add document. It appears in the grid with a status badge and starts processing.

Choose who can read it

Restricted (default) — only the audiences and NPCs you assign can read it. You assign them after uploading.
Everyone — every NPC in the project can read it. No assignment needed.

Heads up

A Restricted document with nothing assigned is readable by no one. Remember to open it and add at least one audience or NPC.

Go live

Make it readable now is the one switch. When on, the document goes live, for the NPCs it is shared with, as soon as it finishes processing. When off (the default), it stays a draft nobody can read until you publish it or click Deploy.

Assign a document to NPCs & audiences

1
Click a document card to open its panel.
2
Set visibility to Restricted, then tick the audiences and/or individual NPCs that should read it.
3
Click Save access. The chosen NPCs/audiences appear under 'Currently assigned'. On a published document the change applies to the NPC's next reply.

Note

An NPC you assign by name keeps the document even if it is also in an assigned audience and later leaves that audience.

Document status

Every document moves through a lifecycle as it is ingested. The dashboard refreshes until it settles.

Pending

Queued for ingestion. Not usable yet.

Processing

Being split and embedded.

Ready

Indexed. Readable by the NPCs it is shared with once published.

Failed

Ingestion failed. Delete and re-upload, or check the file format.

Publish all drafts

If you uploaded documents as drafts, the Deploy button at the top of the page publishes every draft in the project in one action. Use it when a batch of content is ready to ship.

Delete a document

1
Open the document's panel.
2
Click Delete document and confirm. The document and its indexed chunks are removed.

Overview

Audiences