Help
How to use LoreMonkey
Step-by-step guides to everything LoreMonkey does.
Just want to get playing?
These three will get you started. You don't need anything else on this page for your first game.
The full guide
Further reading, for when you want to know more. It follows a game night from start to finish, and you can dip into any part of it. Each guide starts with the short answer and says which plan it needs and whether it uses your AI allowance.
Before your first game
Install, set up a campaign, and check LoreMonkey can hear the table.
- What LoreMonkey doesLoreMonkey listens to your game, writes down what was said on your own PC, offers the odd idea during play, and afterwards turns the evening into a recap, a memory it can answer from, and updated campaign notes.Video, 0:48
- Install LoreMonkey and get it readyDownload, sign in, and follow the setup checklist to get started.Video, 0:47
- Set up a campaignCreate the campaign in Settings, choosing Player or Game Master and your game system. Then fill in its four notes files on the Character & Campaign tab, either from a document you already have or one step at a time by hand.Video, 0:46
- Connect Discord for speaker namesMake a private Discord application, paste its Client ID and Client Secret into LoreMonkey, connect, and tag each person in your voice channel with their character. Only the person running LoreMonkey does this, and no bot joins your call.Video, 2:51
- Set up your audio and test itSpeakers is what you hear, which is how LoreMonkey hears Discord or your game audio. Mic is your own voice, and can be None if your voice already reaches the speakers. Run Test setup before a real game and again whenever you change audio devices.Video, 0:54
On the night
Start, pause and finish a session, and choose how much help you get.
- Run a sessionPress Start session when the game starts, Pause for breaks, and Finish at the end of the night. Finish only saves the transcript. Nothing is sent to the AI until you choose what to do with the evening.Video, 0:51
- Choose how much help you get during playGuidance decides how readily LoreMonkey offers an idea during play, from Off to Hands-on. Balanced suits most tables. Check in gets you an idea whenever you press it, whatever the setting.Video, 0:52
After the game
Turn the evening into a recap, a memory and updated notes.
- After the game: which button to pressFinish only saves the transcript. Then choose what to make of the evening. Session recap writes it up, Add to memory lets Ask and later sessions recall it, and Update campaign notes proposes edits to your notes for you to approve. Each one runs once per session.Video, 0:55
- Review updates to your notesProposed changes wait on the Character & Campaign tab under Updates waiting for you. Untick what you don't want, edit or rename anything that's off, then press Apply selected. Nothing is saved until you do.Video, 0:42
- Recaps: length, sections and styleRecap settings decide each campaign's recaps. Pick a length, tick the sections you want, and choose whose writing to copy. Changes apply to the next recap. Rewrite in Memory redoes an old one.Video, 0:52
- Illustrate a session and share itWrite the recap, then press Illustrate Session. LoreMonkey picks the evening's best moments, you check the text and the cast, and it generates the pictures. Share gives your players one page with the illustration and the recap.
- Clean up a transcriptAfter a recorded session, Clean up transcript listens to the recording again with the most accurate speech model your PC can run and puts misheard names right, for free. It can also have the AI look at doubtful lines. Your original transcript is kept.Video, 0:47
Between sessions
Bring in old games, look things up, and keep the notes tidy.
- Import old recordingsOpen Settings, then Recordings, and press Choose recordings. Check each session's date, since the session is named after the night it was played, then press Import. Transcribing is free and runs on your PC. Adding the sessions to memory afterwards uses your allowance.Video, 0:50
- Add notes, write-ups and documentsFeed the Monkey, on the Character & Campaign tab, takes anything LoreMonkey should remember, typed or uploaded. It condenses it into memory and proposes note updates for you to review. Old notes from before LoreMonkey can be imported for free from the Memory page.Video, 0:50
- The Memory pageSettings, then Memory, holds every session one at a time, with its recap, what LoreMonkey remembers from it, the full transcript and its audio. Correct a memory here if LoreMonkey got something wrong.Video, 0:50
- Ask LoreMonkey about your campaignType a question on the Ask LoreMonkey tab, such as "what did we promise the smith?". It answers from your campaign notes and the sessions in memory, names the sessions it drew on, and says so when the answer isn't there.Video, 0:39
- Use the Compendium and timelineThe Compendium lists every character, place, faction, item and thread in your campaign notes, with how often each was mentioned at the table. Press Ctrl+K anywhere to look one up mid-session. Editing an entry edits your notes, so there is only ever one copy.Video, 0:51
- Fix misheard namesOpen Spellings in the Compendium, pick the name, type the spelling you want and press Rename everywhere. It changes your notes, memory, recaps and Discord tags in one go, and remembers the old spelling so the same mistake is put right next time.Video, 0:51
- Share a world between campaignsA world holds the setting several campaigns share. Every campaign in it sees the world's entries, and adds its own notes on top. What happens in one campaign never reaches the world or another campaign unless you move it there yourself.Video, 0:53
- Export, import and sync with ObsidianExport writes your campaign's notes, entries and recaps into an Obsidian vault as linked notes. Import from vault brings files back. Sync does both, only when you press it, and skips any file changed on both sides instead of guessing.Video, 0:51
Your plan and your data
What the AI allowance covers, and where everything is kept.
- Plans, the AI allowance and creditsEverything that runs on your PC is free on every plan. Each plan adds an AI allowance for the parts a language model writes. The header shows how much you've used, and Settings, then Billing, shows where it went.Video, 1:00
- Your data: exports, files and deleting your accountYour campaigns, transcripts and recordings are kept on your PC. Settings, then Your data, exports any session's transcript, opens the folder everything lives in, and downloads the little our server holds about your account.Video, 0:48
When something goes wrong
Fixes for the common problems, and how to reach us.
Not here? Ask in #help on our Discord or email hello@loremonkey.com.