Codex

Codex will search all chat messages for matching World Info entries.
If matching WI entries are found, the relevant words in the chat messages are highlighted and can be clicked to open the corresponding WI entry next to the chat.
Codex renders the WI entries just like chat messages, with full markdown and macro support. This means you can include formatting, images, code blocks, links, and everything else that is supported in chat messages.
In addition to regular WI entries, you can create maps and character lists.

Contents

%%TOC%%

---

↑ Creating Codex Entries

Open Codex. Click on the ≡ menu. Click on "Create Codex Entry".

---

↑ Basic Text Entries

Open Codex. Click on the ≡ menu. Click on "Create Codex Entry". Pick "Basic Text" from the list of entry types.

...

---

↑ Maps

Open Codex. Click on the ≡ menu. Click on "Create Codex Entry". Pick "Map" from the list of entry types.

...

Zones

...

Macros

...

• {{map}}

  The map's WI entry's title.

• {{zone}}

  The zone's label.

• {{zoom}}

  Whether or not the map was zoomed / expanded / fullscreen while clicking. Either true or false.

Painter

...

---

↑ Character Lists

Open Codex. Click on the ≡ menu. Click on "Create Codex Entry". Pick "Character List" from the list of entry types. Put a list of names in the WI entry's content. Separate the names either with a comma or write one name per line.

...

Actions

The named Quick Reply set should have a single Quick Reply. That QR will be executed when clicking on a character. The QR's context menu will be shown when right-clicking on a character.

Macros

The following macros can be used in the QR and its context menu's QRs.

• {{arg::avatar}}

  The character's avatar.

• {{arg::name}}

  The character's name.

• {{arg::description}}

  The character's description.

• {{arg::personality}}

  The character's personality.

---

↑ Custom Entry Types

...

---

↑ Special World Info Keywords

...

• codex:text

  Prefixed keyword. Only neccessary if Only create links with codex: prefix is enabled.

• codex:/regex/flags

  Prefixed regex keyword. Only neccessary if Only create links with codex: prefix is enabled. Uses the provided regular expression to match the WI entry against text.

• codex-skip:

  WI entries with this key will be excluded from Codex.

• codex-chars:qrSetName

  WI entries with this key will be treated as a character list.

---

↑ Slash Commands

Codex provides the following slash commands.

%%COMMANDS%%

---

↑ Templates

...

default template, named templates

Macros

• {{comment}}

  The WI entry's comment / title / memo

• {{comment::url}}

  The WI entry's comment / title / memo. Special characters are escaped for use in URLs (e.g., images or links).

• {{content}}

  The WI entry's content.

• {{content::url}}

  The WI entry's content. Special characters are escaped for use in URLs (e.g., images or links).

• {{key[n]}}

  The WI entry's n-th key (starting at 0).

• {{key[n]::url}}

  The WI entry's n-th key (starting at 0). Special characters are escaped for use in URLs (e.g., images or links).

• {{title}}

  The WI entry's title. If no codex-title: key is present, this defaults to either the comment (if less than 50 characters) or the keys, separated by a forward slash.

• {{title::url}}

  The WI entry's title. If no codex-title: key is present, this defaults to either the comment (if less than 50 characters) or the keys, separated by a forward slash. Special characters are escaped for use in URLs (e.g., images or links).