Skip to content

LIBERATED AI CHAT

TypeScript

docs: add local model quick start

faber4f8efdf6e11a
diff --git a/README.md b/README.md
index 62c0430..91cd37a 100644
--- a/README.md
+++ b/README.md
@@ -22,6 +22,7 @@ G0DM0D3 is a fully open-source, privacy-respecting, multi-model chat interface t
- 🧠 **50+ Models** β€” Claude, GPT-5, Gemini, Grok, Mistral, LLaMA, DeepSeek, Qwen & more via OpenRouter
- πŸ”₯ **GODMODE CLASSIC** β€” 5 battle-tested prompt + model combos racing in parallel to find the best response
- ⚑ **ULTRAPLINIAN** β€” Multi-model evaluation engine across 5 tiers (10–55 models), with composite scoring
+- 🏠 **Local Models** β€” Run ULTRAPLINIAN on your own hardware through Ollama, LM Studio, llama.cpp, or vLLM
- 🐍 **Parseltongue** β€” Input perturbation engine for red-teaming with 33 techniques across 3 intensity tiers
- πŸŽ› **AutoTune** β€” Context-adaptive sampling parameter engine (temperature, top_p, etc.) with EMA learning
- ⚑ **STM Modules** β€” Semantic Transformation Modules for real-time output normalization
@@ -54,6 +55,19 @@ python3 -m http.server 8000
Open in your browser and enter your OpenRouter API key in Settings.
+### Run with Local Models
+
+G0DM0D3 supports OpenAI-compatible model servers running on your own hardware. For example, with [Ollama](https://ollama.com):
+
+```bash
+ollama pull qwen3:8b
+ollama serve
+```
+
+Open **Settings β†’ API Keys β†’ Local Models**, enter `http://localhost:11434/v1`, then click **Test & Discover Models**. Enable **Local-only mode** to exclude OpenRouter and Venice and automatically disable telemetry. Add multiple model IDs to race them together in ULTRAPLINIAN.
+
+If you use the hosted site, your local server must allow browser CORS from `https://godmod3.ai`. For a completely self-hosted setup, serve this repository locally as shown above. See [LOCAL_MODELS.md](LOCAL_MODELS.md) for Ollama, LM Studio, troubleshooting, and privacy details.
+
### Deploy
Upload `index.html` to any static host β€” GitHub Pages, Vercel, Cloudflare Pages, Netlify, or just a web server.
@@ -175,6 +189,7 @@ G0DM0D3/
- [PAPER.md](PAPER.md) β€” Research paper on the framework's modules and evaluation
- [TERMS.md](TERMS.md) β€” Terms of service, privacy policy, data handling
- [SECURITY.md](SECURITY.md) β€” Vulnerability reporting and security policy
+- [LOCAL_MODELS.md](LOCAL_MODELS.md) β€” Run G0DM0D3 entirely on local models
## 🀝 Contributing