This project provides an AI-powered dialogue generation system for Animal Crossing villagers using Large Language Models (LLMs). It targets Animal Crossing players and content creators seeking to imbue in-game characters with dynamic, contextual, and more meaningful conversations, enhancing the player experience through advanced AI integration.

How It Works

The mod operates by interfacing with the Dolphin emulator to read dialogue memory from a running Animal Crossing game. It analyzes the conversation context, optionally using screenshots for richer input, and then leverages LLMs (Google Gemini or OpenAI) to generate natural, context-aware responses. These AI-generated dialogues are subsequently written back into the game's memory in real-time, creating a continuously evolving conversational experience.

Quick Start & Requirements

• Installation: Install Python 3.8+ and run pip install -r requirements.txt.
• Prerequisites: Dolphin emulator, Animal Crossing (GAFE01) ROM, and API keys for either Google Gemini or OpenAI. A .env file is required for API key configuration.
• Execution: Launch Animal Crossing in Dolphin, ensuring the game world is loaded. Then, run the mod via python ac_parser_encoder.py --watch for continuous generation or python ac_parser_encoder.py --write for a single generation.

Highlighted Details

• Smart Dialogue Generation: Creates context-aware responses based on in-game state.
• Real-time Updates: Continuously monitors and generates dialogue.
• Screenshot Integration: Utilizes visual context for improved AI response quality.
• Gossip System: Enables villagers to remember and reference past conversations.
• Multi-LLM Support: Compatible with both Google Gemini and OpenAI models.
• Memory Safety: Implements measures to prevent overwriting dialogue during active game processes.

Maintenance & Community

The project actively seeks community contributions, particularly for fixing bugs, improving platform compatibility (Windows/Linux), enhancing memory reading stability, and adding new features. Bug reports and pull requests are encouraged to stabilize and expand the mod's capabilities.

Licensing & Compatibility

The specific software license is not detailed in the provided README. The mod is designed to work exclusively with the Dolphin emulator and accesses GameCube memory. While tested on macOS, cross-platform compatibility for Windows and Linux is a stated area needing community development.

Limitations & Caveats

This is experimental software with known bugs and potential stability issues, including unexpected crashes. It has only been tested on macOS, and Windows/Linux compatibility is not guaranteed. The mod requires precise timing, needing to be launched only after the game world has loaded in the emulator, not during the initial loading screens. It is not compatible with original hardware.