# CivitasAI - AI-Powered Living Civilization Plugin A Minecraft plugin that creates living, breathing civilizations powered by AI. NPCs have personalities, memories, relationships, and can interact with players using advanced AI models. ## Features - **AI-Powered NPCs**: NPCs with unique personalities that can hold conversations - **Dynamic Villages**: Villages that grow, trade, and evolve over time - **Genetics System**: NPCs inherit traits from parents - **Memory & Relationships**: NPCs remember interactions and form relationships - **Multiple AI Providers**: OpenAI, Google Gemini, Ollama support - **Plugin Integrations**: LuckPerms, TAB, Essentials, Vault ## Requirements - Minecraft 1.21+ - Java 17+ - Spigot/Paper server ## Installation 1. Download the latest release 2. Place `CivitasAI.jar` in your `plugins` folder 3. Restart your server 4. Configure `config.yml` with your AI API keys 5. Reload with `/civ reload` ## Commands ### General Commands | Command | Permission | Description | |---------|-----------|-------------| | `/civ help` | `civitasai.use` | Show all commands | | `/civ reload` | `civitasai.admin` | Reload configuration | ### NPC Commands | Command | Permission | Description | |---------|-----------|-------------| | `/civ npc spawn ` | `civitasai.npc.spawn` | Spawn a new NPC | | `/civ npc info ` | `civitasai.npc.info` | View NPC information | | `/civ npc talk ` | `civitasai.npc.talk` | Talk to an NPC | ### Village Commands | Command | Permission | Description | |---------|-----------|-------------| | `/civ village create ` | `civitasai.village.create` | Create a new village | | `/civ village stats ` | `civitasai.village.stats` | View village statistics | | `/civ village list` | `civitasai.village.list` | List all villages | ### Debug Commands | Command | Permission | Description | |---------|-----------|-------------| | `/civ debug npc ` | `civitasai.debug` | Debug NPC information | | `/civ ai status` | `civitasai.admin` | View AI provider status | ## Permissions ### Basic Permissions - `civitasai.use` - Basic plugin usage (default: true) - `civitasai.admin` - Administrative commands (default: op) - `civitasai.npc` - NPC interaction commands (default: true) - `civitasai.village` - Village commands (default: true) - `civitasai.debug` - Debug commands (default: op) - `civitasai.reload` - Reload configuration (default: op) ### NPC Job Permissions - `village_leader` - Village leader role - `village_guard` - Village guard role - `village_trader` - Village trader role - `village_scholar` - Village scholar role - `village_farmer` - Village farmer role - `village_miner` - Village miner role - `village_builder` - Village builder role - `village_healer` - Village healer role ## LuckPerms Integration ### Setting Up Groups Create groups for each NPC job type: ```bash /lp creategroup village_leader /lp creategroup village_guard /lp creategroup village_trader /lp creategroup village_scholar /lp creategroup village_farmer /lp creategroup village_miner /lp creategroup village_builder /lp creategroup village_healer ``` ### Assigning Permissions to Groups **Village Leader:** ```bash /lp group village_leader permission set civitasai.admin true /lp group village_leader permission set civitasai.village.create true /lp group village_leader meta setprefix "&4[Leader] " ``` **Village Guard:** ```bash /lp group village_guard permission set civitasai.npc.spawn true /lp group village_guard permission set minecraft.command.kill true /lp group village_guard meta setprefix "&c[Guard] " ``` **Village Trader:** ```bash /lp group village_trader permission set civitasai.village.stats true /lp group village_trader permission set essentials.trade true /lp group village_trader meta setprefix "&6[Trader] " ``` **Village Scholar:** ```bash /lp group village_scholar permission set civitasai.npc.info true /lp group village_scholar permission set civitasai.ai.status true /lp group village_scholar meta setprefix "&5[Scholar] " ``` **Village Farmer:** ```bash /lp group village_farmer permission set civitasai.npc.talk true /lp group village_farmer meta setprefix "&a[Farmer] " ``` **Village Miner:** ```bash /lp group village_miner permission set civitasai.npc.talk true /lp group village_miner meta setprefix "&8[Miner] " ``` **Village Builder:** ```bash /lp group village_builder permission set civitasai.village.list true /lp group village_builder meta setprefix "&e[Builder] " ``` **Village Healer:** ```bash /lp group village_healer permission set civitasai.npc.info true /lp group village_healer meta setprefix "&d[Healer] " ``` ### Assigning Groups to Players ```bash /lp user parent add village_leader /lp user parent add village_guard /lp user parent add village_trader ``` ### Setting Primary Group ```bash /lp user parent setprimary village_leader ``` ### Removing Groups ```bash /lp user parent remove village_guard ``` ### Viewing Player Permissions ```bash /lp user info /lp user permission info ``` ## TAB Integration The plugin automatically integrates with TAB to display: - NPC job titles in prefixes - Village names in suffixes - Village statistics in scoreboards - Custom header/footer with village info ### Configuration Enable TAB features in `config.yml`: ```yaml integrations: tab: enabled: true update-prefix: true update-suffix: true scoreboard: true header-footer: true ``` ## Essentials Integration ### Features - Automatic nickname setting based on NPC name and job - Economy integration for village trading - Home system for village locations ### Configuration ```yaml integrations: essentials: enabled: true set-nickname: true economy-integration: true ``` ## Vault Integration Provides economy and permission bridge support for other plugins. ### Configuration ```yaml integrations: vault: enabled: true economy: true permissions: true ``` ## AI Configuration ### OpenAI Setup 1. Get API key from https://platform.openai.com/api-keys 2. Add to config.yml: ```yaml ai: openai: enabled: true api-key: "sk-your-key-here" model: "gpt-4o-mini" ``` ### Google Gemini Setup 1. Get API key from https://makersuite.google.com/app/apikey 2. Add to config.yml: ```yaml ai: gemini: enabled: true api-key: "your-key-here" model: "gemini-2.0-flash-exp" ``` ### Ollama Setup (Local/Free) 1. Install Ollama from https://ollama.ai 2. Run: `ollama pull mistral` 3. Configure: ```yaml ai: ollama: enabled: true url: "http://localhost:11434" model: "mistral" ``` ## Database Configuration ### SQLite (Default) ```yaml database: type: "sqlite" ``` ### MySQL ```yaml database: type: "mysql" mysql: host: "localhost" port: 3306 database: "civitasai" username: "root" password: "password" ``` ## Support For issues, feature requests, or questions: - GitHub Issues: [Create an issue] - Discord: [Join our server] ## License This plugin is licensed under the MIT License. ## Credits Developed with ❤️ for the Minecraft community - AI Integration: OpenAI, Google Gemini, Ollama - Plugin APIs: LuckPerms, TAB, Essentials, Vault