Loom Engine

An LLM-powered narrative engine and text RPG.

简体中文 | English

Table of Contents

• Quick Start
  • Configuration
  • Usage
• Local Development & Building from Source
• Core Features
• Future Plans
• Settings Guide
• Keyboard Shortcuts
• License

🚀 Quick Start

If you encounter any issues while using this project or have any ideas or suggestions, feel free to reach out! You can contact me via [email protected], or share your feedback and start a discussion through Issues or Discussions. I'll do my best to respond.

⚙️ Configuration

1. Download the pre-built binary for your platform from the Releases page, extract it, and run the executable to enter the main menu.

   

2. Navigate to the Settings page and adjust the Provider and Model fields according to your setup. See the Settings Guide for full details.

   

3. Configure environment variables. The following two variables are required (replace PROVIDER with your actual platform name in uppercase, e.g., OPENAI, ANTHROPIC):

   • PROVIDER_BASE_URL: The Base URL of the model API
   • PROVIDER_API_KEY: Your API key for the corresponding platform

🎮 Usage

1. Main Menu: Use ↑ ↓ to navigate options, Enter to confirm.

   

2. Create Project: On the Create page, use Tab to switch focus. Enter a project name, select a game mode, and fill in the prompt (world-building description or system instructions). Switch to the CONFIRM button and press Enter to start initialization.

   

3. Select Project: After creation, you will be redirected to the Projects page. Use ↑ ↓ to select a project and Enter to enter it.

   

4. Select Save: On the Saves page, choose a save file to load.

   

5. Enter Game: The Gameplay page includes stat panels, inventory, dialogue history, and an input box. Use Tab to switch panel focus, ↑ ↓ to scroll lists or dialogue, and ← → to view truncated text entries. Press Enter to activate the input box, type your action, and press Enter again to send. Wait for the model to respond.

   

6. Save: Before you exit the Gameplay page, remember to enter /save in the input box to save your progress! You can enter /help to view more commands.

🛠️ Local Development & Building from Source

# Clone the repository
git clone https://github.com/Underline-1024/loom-engine.git
cd loom-engine

# Build and run
cargo run

✨ Core Features

• Complete Stat System & Toolchain: Built-in numeric stats, tag-based traits, and inventory system. The LLM can read and write game state in real time via a full suite of tool functions, rather than merely generating text.
• Natural Language Driven Interaction: Players input arbitrary actions in natural language. The LLM automatically parses intent, advances the narrative, and synchronizes underlying stats and inventory state.
• Broad Model Compatibility: Natively supports OpenAI, Anthropic, Ollama, and any local or third-party platform compatible with the OpenAI / Anthropic API standard.

🔮 Future Plans

• Streaming output support
• Plugin extension system
• Local vector database integration

📋 Settings Guide

⌨️ Keyboard Shortcuts

📄 License

This project is open-sourced under the MIT License - see the LICENSE file for details.