## Chat with any mob in Minecraft! All creatures can talk & react using AI! ![CreatureChat Divider](https://cdn.modrinth.com/data/rvR0de1E/images/fb51ae3c2dc5b55528d39825d424497c6732471d.png) ### Features - **AI-Driven Chats:** Using ChatGPT or open-source AI models, each conversation is unique and engaging! - **Behaviors:** Creatures can make decisions on their own and **Follow, Flee, Attack, Protect**, and more! - **Reactions:** Creatures automatically react to being damaged or receiving items from players. - **Friendship:** Track your relationships from friends to foes. - **Multi-Player:** Share the experience; conversations sync across server & players. - **Memory:** Creatures remember your past interactions, making each chat more personal. ### Create meaningful conversations and enduring friendships? A betrayal perhaps? ![CreatureChat Divider](https://cdn.modrinth.com/data/rvR0de1E/images/fb51ae3c2dc5b55528d39825d424497c6732471d.png) [![CreatureChat Trailer Video](https://cdn.modrinth.com/data/rvR0de1E/images/23a65895464984749668bdcbb0f0ac58988de45c.png)](https://youtu.be/GdY969Orsh0?si) ![CreatureChat Divider](https://cdn.modrinth.com/data/rvR0de1E/images/fb51ae3c2dc5b55528d39825d424497c6732471d.png) ### Installation Instructions

Fabric (Recommended)

Fabric Instructions

Install Fabric Loader & API: Follow the instructions here.
Install CreatureChat™ Mod: Download and copy creaturechat-*.jar and fabric-api-*.jar into your .minecraft/mods folder.
Launch Minecraft with the Fabric profile.
Configure AI: A LLM (large language model) is required for generating text (AI options below)

Forge (with Sinytra Connector)

Forge Instructions

NOTE: Sintra Connector only supports Minecraft 1.20.1

Install Forge: Download Forge Installer, run it, select "Install client".
Install Forgified Fabric API: Download Forgified Fabric API and copy the *.jar into your .minecraft/mods folder.
Install Sinytra Connector: Download Sinytra Connector and copy the *.jar into your .minecraft/mods folder.
Install CreatureChat™ Mod: Download and copy creaturechat-*.jar into your .minecraft/mods folder.
Launch Minecraft with the Forge profile.
Configure AI: A LLM (large language model) is required for generating text (AI options below)

### AI Options

Choose AI Option

CreatureChat™ requires an AI / LLM (large language model) to generate text (characters and chat).

Free & Local: Use open-source and free-to-use LLMs without any API fees. [Difficulty: Hard]
Bring Your Own Key: Use your own API key from providers like OpenAI or Groq. [Difficulty: Medium]
Token Shop: Supports CreatureChat™ by purchasing tokens from the developers. [Difficulty: Easy]

1. Free & Local

CreatureChat™ fully supports free and open-source LLMs. To get started:

An HTTP endpoint compatible with the OpenAI Chat Completion JSON syntax is required. We highly recommend using:
- Ollama & LiteLLM as your HTTP proxy.
- LiteLLM Features:
  - Supports over 100+ LLMs (e.g., Anthropic, VertexAI, HuggingFace, Google Gemini, and Ollama).
  - Proxies them through a local HTTP endpoint compatible with CreatureChat™.
  - Note: Running a local LLM on your computer requires a powerful GPU.
Set the local HTTP endpoint in-game:
- /creaturechat url set "http://ENTER-YOUR-HTTP-ENDPOINT-FROM-LITE-LLM"
- /creaturechat model set ENTER-MODEL-NAME
- /creaturechat timeout set 360
Additional help can be found in the #locall-llm-info channel on our Discord.

2. Bring Your Own Key

For those already using a third-party API (e.g., OpenAI, Groq):

Integrate your own API key for seamless connectivity.
Costs depend on the provider’s usage-based pricing model.
By default, CreatureChat uses the OpenAI endpoint and gpt-3.5-turbo model, known for its balance of low cost and fast performance.
Be aware that OpenAI’s developer API does not include free usage. Please review the OpenAI pricing for detailed information.
To create an OpenAI API key, visit https://platform.openai.com/api-keys, and use the + Create new secret key button.
Set the API key & model in-game:
- /creaturechat key set <YOUR-SECRET-KEY-HERE>
- /creaturechat model set gpt-3.5-turbo

3. Token Shop

Supports CreatureChat by purchasing tokens from the developers:

Easy setup with simple token packs, created for CreatureChat users.
More info is available in the #token-shop channel on our Discord.
Set the token-shop API key in-game:
- /creaturechat key set <YOUR-SECRET-KEY-HERE>

![CreatureChat Divider](https://cdn.modrinth.com/data/rvR0de1E/images/fb51ae3c2dc5b55528d39825d424497c6732471d.png) ### In-game Commands

Configure CreatureChat

REQUIRED: /creaturechat key set <key>
- Sets the OpenAI API key. This is required for making requests to the LLM.
OPTIONAL: /creaturechat url set "<url>"
- Sets the URL of the API used to make LLM requests. Defaults to "https://api.openai.com/v1/chat/completions".
OPTIONAL: /creaturechat model set <model>
- Sets the model used for generating responses in chats. Defaults to gpt-3.5-turbo.
OPTIONAL: /creaturechat timeout set <seconds>
- Sets the timeout (in seconds) for API HTTP requests. Defaults to 10 seconds.
OPTIONAL: /creaturechat whitelist <entityType | all | clear> - Show chat bubbles
- Shows chat bubbles for the specified entity type or all entities, or clears the whitelist.
OPTIONAL: /creaturechat blacklist <entityType | all | clear> - Hide chat bubbles
- Hides chat bubbles for the specified entity type or all entities, or clears the blacklist.
OPTIONAL: /story set "<story-text>"
- Sets a custom story (included in character creation and chat prompts).
OPTIONAL: /story display | clear
- Display or clear the current story.

Configuration Scope:

OPTIONAL: You can specify the configuration scope at the end of each command to determine where settings should be applied:
- Default Configuration (--config default): Applies the configuration universally, unless overridden by a server-specific configuration.
- Server-Specific Configuration (--config server): Applies the configuration only to the server where the command is executed.
- If the --config option is not specified, the default configuration scope is assumed.

![CreatureChat Divider](https://cdn.modrinth.com/data/rvR0de1E/images/fb51ae3c2dc5b55528d39825d424497c6732471d.png) [![How To Install Tutorial Video](https://cdn.modrinth.com/data/rvR0de1E/images/f11e78072907c239c870306fc0808ebf7931ee84.png)](https://youtu.be/P2txUop_kSM?si=4quU-kubGLBvb8HB) ![CreatureChat Divider](https://cdn.modrinth.com/data/rvR0de1E/images/fb51ae3c2dc5b55528d39825d424497c6732471d.png) ## License - [![REUSE Status](https://img.shields.io/badge/REUSE-compliant-brightgreen)](https://reuse.software) - **Source code:** [GNU GPL v3](https://github.com/CreatureChat/creature-chat/blob/develop/LICENSE.md) - **Non-code assets:** [CC-BY-NC-SA-4.0](https://github.com/CreatureChat/creature-chat/blob/develop/LICENSE-ASSETS.md) ## Legal Notices - CreatureChat™ is an independent project and is **not** endorsed by Mojang AB, Microsoft Corp., or OpenAI. *Minecraft®* is a trademark of Mojang AB. *ChatGPT®* is a trademark of OpenAI OpCo, LLC. All trademarks appear here for identification only. - *CreatureChat™* is a trademark of owlmaddie LLC (registration pending). Factual nominative references such as “Fork of CreatureChat” that do **not** imply endorsement are allowed; all other uses of the name or logo require prior permission. ## Contact & Resources - [Join us on Discord](https://discord.gg/m9dvPFmN3e) - [Documentation](http://gitlab.openshot.org/minecraft/creature-chat) ([Source Code](http://gitlab.openshot.org/minecraft/creature-chat)) - Follow Us: [YouTube](https://www.youtube.com/@CreatureChat/featured) | [Twitter](https://twitter.com/TheCreatureChat) | [TikTok](https://www.tiktok.com/@creaturechat) ![CreatureChat Divider](https://cdn.modrinth.com/data/rvR0de1E/images/fb51ae3c2dc5b55528d39825d424497c6732471d.png)