Lorexicon Docs

Logo

A public space for feature requests and support questions for Lorexicon.

View the Project on GitHub Fergusware/lorexicon-support

← Back to Docs Home

🪄 The Lorexicon Grimoire of Creation

Your PF2e Foundry VTT Arcane Companion


Chapter I: Runes of Compatibility

Before you invoke the Lorexicon’s power, ensure your realm meets these glyphs:


Chapter II: Invoking the Module

  1. In Foundry’s Add-on Modules → Install Module, paste the manifest oracle:

    https://raw.githubusercontent.com/Fergusware/lorexicon-support/refs/heads/main/manifests/module.json
    
  2. Click Install, then in Manage Modules enable Lorexicon.
  3. Restart your Foundry realm if the fates demand it.

Chapter III: Opening the Lorexicon Portal

To call Lorexicon forth:

  1. Venture to either the Actors tab or Journal of your Foundry interface.
  2. Click the Lorexicon button nestled at the bottom.
  3. On first start, you will be prompted to Bind Your Patreon Pact (see below)
  4. Behold the enchanted prompt window, alive with your monthly usage runes.

Chapter IV: Binding Your Patreon Pact

When you first awaken Lorexicon’s arcane circuits, you must forge a Patreon pact:

  1. Upon enabling, a new popup window beckons—ensure your browser allows pop-ups for Foundry.
  2. If you are not yet logged into Patreon, you’ll be prompted for credentials.
  3. In that window, grant access:
    • Lorexicon would like to view your Patreon identity, pledges, and account status
    • This ritual weaves your Patreon allegiance into the very fabric of your Foundry realm.
  4. Success seals the pact -— Lorexicon’s welcome grimoire unfurls in Foundry.
  5. Failure or denial scrawls an error in chat.
  6. At any time, you may unbind the ritual by clicking the 🔗 Unlink icon in the Usage panel.

Chapter V: The Welcome Invocation

When first summoned, Lorexicon will unfurl its greeting as a herald in the Chat tab, welcoming you to the forge of creation.


Chapter VI: Crafting Your Creature

Arcane Element Description
Type Lore Codex: Encounter, NPC, or
Prompt Vast textarea (up to 12,000 characters) for your narrative or mechanical visions
Result When the summoning is complete, displays your creation’s name, linked to its freshly born document
Usage Panel Completed: x / y
Remaining: z (flames red at 0)
Patreon ID: 12345 🔗
Subscription: free
Buttons Submit: commence creation
Cancel: banish or close the portal
Reset: clear all runes

Below the runes, a Progress Bar pulses while the forge works its magic (≈1 minute).


Chapter VII: The Summoning of Your Creation

When the progress bar runs its course:

No further import rituals are required to begin using your creation.


Chapter VIII: Tracking Your Magical Quota

Each month’s magic is finite. Observe your Usage Panel:

Hover any rune for further illumination.


Chapter IX: When the Fates Frown

Should darkness cloud your ritual:

Affliction Lorexicon’s Response
Auth Denied/Failure Chat scrolls an “authentication error” – reopen the popup and retry.
Quota Depleted A red “Remaining” rune blazes 0; a toast and chat warning cry “No more magic.”
Generation Timeout/API Error Chat: “Generation failed -— please try again.”
Popup Blocked/Closed/Timeout Chat: “Patreon authentication failed. Allow pop-ups and retry.”

Chapter X: Sage Advice & Troubleshooting


Go forth, brimming with confidence. May every NPC you summon serve your tale, and may your creatures be legends in their own right.