Ellinox AI Guide

Ellinox AI Guide is a Cities: Skylines mod that adds an in-game chat interface for interacting with a local Large Language Model (LLM) server. The mod provides a seamless way to ask questions and receive AI-powered answers directly within the game, as well as manage the LLM server and view logs from the mod’s options menu.

---

Features

• In-Game Chat Button:
  Adds a movable "eAI" button to the game UI. Click to open the chat window and interact with the LLM.

• Local LLM Integration:
  Communicates with a Python server (e.g., running a Flask app) that hosts your LLM, such as an Ollama or similar model.

• Server Management:

  • Start and restart the Python server process directly from the mod.
  • No need for manual server restarts or external tools.

• Configurable Settings:

  • Enable/disable logging.
  • Set the server URL.

---

Requirements

• Cities: Skylines (original game)
• .NET Framework 3.5 (mod target)
• Python 3.x installed and available in your system PATH
• Ollama LLM server (e.g., serverPostRAGgpt.py) running Flask and your LLM backend

---

Installation

1. Copy the Mod Files:

   • Place the compiled Ellinox AI Guide.dll and related files into your Cities: Skylines Mods folder.

2. Set Up the Python Server:

   • Place serverPostRAGgpt.py and its dependencies in the same directory as the mod or as configured.
   • Ensure your Python environment has all required packages (Flask, langchain, etc.).
   • The mod will automatically start and manage the Python server process.

3. Start Cities: Skylines and Enable the Mod:

   • Enable "Ellinox AI Guide" in the Content Manager > Mods menu.

---

Usage

• Open the Chat:
  Click the "eAI" button in-game to open the chat window. Type your question and press "Send" to interact with the LLM.

• Mod Options:

  • Go to the mod’s options in the Content Manager.
  • Configure logging and server URL.
  • Restart the Python server if needed.
  • Select and view log files, or clear them as needed.

---

Troubleshooting

• 404 Errors:
  If you see 404 errors, ensure the Python server is running and accessible. The mod manages the server process, but check for errors in the log output if issues persist.

• Python Server Window:
  The server runs in a visible window for easier debugging. You can close and restart it from the mod options.

• Log Not Updating:
  Use the dropdown to select the correct log file. Click "Clear Selected Log" to empty it.

---

Credits

• Mod by Connor Vance _ Bsky: @caav.me
• Uses LangChain, Ollama, and Flask

---

License

This mod is provided as-is for personal and educational use. See LICENSE for details.