🤖 RimAI Framework - AI-Powered RimWorld Experience
🔧 Core Framework Module
The RimAI Framework is the foundational core of the entire RimAI ecosystem. It is a dependency that handles all communication with Large Language Models (LLMs) and provides a comprehensive API for other content mods.
Github (Open Source)：[url=https://steamcommunity.com/linkfilter/?u=http%3A%2F%2Fgithub.com%2Foidahdsah0%2FRimworld_AI_Framework]github.com/oidahdsah0/Rimworld_AI_Framework[/url]
⚡ V4.1 Key Features
[list]
[*] 🔌 [b]Data-Driven:[/b] Connect to any AI provider (OpenAI, Ollama, Groq, etc.) via simple JSON templates.
[*] 🔄 [b]End-to-End Streaming:[/b] A fully-featured streaming API for real-time, word-by-word responses.
[*] ✨ [b]First-Class Embedding Support:[/b] High-performance API for complex semantic understanding and memory functions.
[*] 📊 [b]Advanced Batching:[/b] Optimized concurrent requests for chat and embeddings to maximize throughput.
[*] 🏠 [b]Full support for local OpenAI-compatible APIs[/b] (Ollama, vLLM, etc.)
[/list]
🔑 IMPORTANT: Setup Required Before Use
[b]⚠️ You MUST configure the mod settings before use! ⚠️[/b]
[b]Step-by-Step Setup Guide:[/b]
[list]
[*] [b]Enable the mod[/b] and restart RimWorld.
[*] Go to [b]Settings → Mod Settings → RimAI Framework[/b].
[*] [b]Fill in the required fields:[/b]
[list]
[*] [b]API Key:[/b] Your key for services like OpenAI. (Leave empty for local providers like Ollama).
[*] [b]Endpoint URL:[/b] The base URL for the API. [b]This is usually pre-filled for you.[/b] Only change it if you have a specific need or the official URL changes. (e.g., [url=https://steamcommunity.com/linkfilter/?u=http%3A%2F%2F%60https%3A%2F%2Fapi.openai.com%2Fv1%60]`https://api.openai.com/v1`[/url] for OpenAI, `[url=https://steamcommunity.com/linkfilter/?u=http%3A%2F%2Flocalhost%3A11434%2Fv1%60]http://localhost:11434/v1`[/url] for local Ollama).
[*] [b]Model Name:[/b] The exact model name (e.g., `gpt-4o-mini`, `llama3`).
[/list]
[*] Use the [b]Test Connection[/b] button to verify your settings.
[*] [b]Save[/b] your configuration. You're ready to go!
[/list]
[b]💡 Quick Start Recommendations:[/b]
[list]
[*] [b]Free option:[/b] Install Ollama locally with a model like `llama3`.
[*] [b]Budget option:[/b] Use OpenAI's `gpt-4o-mini` model (very affordable, ~$0.15 per 1M tokens).
[/list]
💰 Important Cost Notice
[b]⚠️ Token costs are paid directly to your AI service provider, NOT to the mod author! ⚠️[/b] The mod author receives no payment from your API usage. Local models like Ollama are free to run after initial setup.
📋 Important Notice
This framework itself does not add any gameplay content but is a [b]required dependency[/b] for all other RimAI modules.
🎯 Supported Versions
✅ RimWorld 1.5
✅ RimWorld 1.6
🛡️ Open Source & Security
This project is completely open-source. You can review the source code, contribute, and report issues on our GitHub repository: [url=https://steamcommunity.com/linkfilter/?u=https%3A%2F%2Fgithub.com%2Foidahdsah0%2FRimworld_AI_Framework]https://github.com/oidahdsah0/Rimworld_AI_Framework[/url]
[b]🔥 If you enjoy this project, please give it a thumbs-up 👍 and follow ➕ for updates on more RimAI modules![/b]
