CreatureChat™

Fabric Instructions

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

Forge Instructions

NOTE: Sintra Connector only supports Minecraft 1.20.1

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

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

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

• 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.