🧬 Formamorph Wiki

A browser-based, AI-driven text RPG framework — play, create, and share interactive worlds powered by your own LLM.

Formamorph runs entirely in the browser and talks to any OpenAI-compatible chat-completions endpoint (local LM Studio / Ollama, OpenAI, etc.), so your games stay on your own machine and model — or, in the desktop app, download and run a model fully locally with no endpoint setup. Pick a built-in world, import one, or build your own in the visual editor.

🌐 Live demo: play Formamorph in your browser → — instant, no install. (18+ — see below.)

[!CAUTION] For adults only (18+). Formamorph is an open-ended AI roleplay engine. Stories are generated by your chosen AI model and worlds can be authored by anyone, so content is effectively unbounded. The in-app world browser surfaces user-created worlds, unmoderated and as-is. See the repository's README for the full responsible-use disclaimer.

🔒 Privacy: Community Creations uses an account. What the server stores about it, and how to delete your account, is in the Privacy Policy.

---

📖 Where to go

Playing

Page	What's inside
🔌 Connect Your Own AI	Moving from the Demo AI to a stronger model — a local server, a hosted API service, or the desktop app
📱 Install on Android	Getting the app on your phone — the download, Android's prompts, and how it updates itself
📚 Library	The main menu's board — the four tabs, tile sizes, Groups, the card menu, and import and export of worlds, entities, dictionaries and avatars
🧍 Avatars	Your 3D player model — importing a VRM file, Character Customization, the details and license, and how it differs from an entity's 3D model and your Profile Image
🚪 Starting a Game	Everything before page one — Enter World, Quick Start, starting traits, the starting location and Library Additions
🎮 How to Play	Taking a turn — actions, choices, [bracket] direction, images, re-generate, edit, rewind, the side panels and the game menu
❓ Formaquestion	The help window in the app — the Help tab and F1, asking a question, searching this guide, reading a page, moving the window, and changing its settings
💾 Saves and Backup	Save, load, Autosave, save files, Backup & Restore of your worlds, saves, library entities and library dictionaries, where your data lives, and app updates
🧠 Story Memory	How a long story is remembered, and how to pin, edit or write its memories yourself
🎭 Entities in Game	Who the story tracks as present — including the entities it invents mid-scene, and how to remove one it got wrong
🪪 Personas	Who you are in the story — making a persona, picking one at Enter World, changing it in game, and the SillyTavern import
🌐 Community Creations	Downloading, Likes, comments and follows, publishing each kind, contests, Reports, and your account
⚙️ Settings	Every setting in the Display, Output, Endpoints and Data tabs, and the Simple and Advanced modes
📜 Prompts	Prompt presets, what each prompt does in a turn, the chip editor, per-prompt endpoints and reasoning, and a world's own prompts
🧰 Tools	The functions the AI can call, the built-in Tools, how to make and try your own, and endpoints with no Tool support
🎨 Image Generation	Connecting ComfyUI, InvokeAI, Automatic1111 / Forge, NovelAI or an OpenAI-compatible service, Scene Images, image presets and ComfyUI workflows

Reference

Page	What's inside
🔤 Glossary	Every Formamorph term in one place, each linked to the page that explains it
✍️ Text Formatting	Every piece of Markdown the app renders, including ==highlights== and their color keys
🛠️ World Editor	The editor's modes, find and replace, the Authoring Tour, and saving your changes
🌍 World Editor: Overview	The world's name, card, avatar, music and AI-facing text, and uploaded or linked images
🎬 World Editor: Openings	The ways a game can start, their weights, and Self openings for personas
📊 World Editor: Stats	The player's numbers, their descriptors, and their scripts
🎭 World Editor: Entities	The people, creatures and things in a world, their names and aliases, and SillyTavern cards
🗺️ World Editor: Locations	The places, nesting, Connections and Travel Hints, and starting locations
🧬 World Editor: Traits	Trait modes, Pick Counts, requirements, entity traits, Blueprints and links
📖 World Editor: Dictionary	Lore entries, what gets scanned, keyword matching, and books
🧩 World Editor: Placeholders	Wildcards, Objects and Variables, rolls, pins, copies and the built-in chips
🧪 Test Bench	Checking a world before you play it — the World Doctor, which dictionary entries fire, what the AI gets at a location, and turn one of a new game
🪪 Personas for Authors	Playable entities, the Allowed Personas and Starts On controls, and the Persona and Player Name chips
📐 World Format	Every field of a world .json file, and how to add a stat, a trait or an entity by hand
🧮 Scripts Guide	Writing JavaScript scripts for stats, traits and the world: formulas, narration rewrites and player prompts
🔗 Linked Content	How a world's entities and dictionaries follow a library item, take updates, publish, download, and repair a missing source

Project

Page	What's inside
📝 Changelog	What's changed, release by release

🚀 Getting started

Prerequisites: Node.js 20.19+ and npm.

npm install
npm run dev      # serves at http://localhost:5173

Open the app, go to Settings, and point it at your AI endpoint. Full setup, configuration, and the optional VRAM monitor are documented in the repository README.

🧱 Tech stack

React 18 · TypeScript (strict) · Vite 5 · Tailwind CSS + shadcn/ui (Radix) · three.js + @pixiv/three-vrm · Kokoro (TTS) · QuickJS (sandboxed scripts)

---

ℹ️ This wiki is generated from the docs/ folder in the repository. Edit the docs there — changes publish here automatically. This is a community fork of the original Formamorph by FieryLionite.