1.**Install Fabric Loader & API:** Follow the instructions [here](https://fabricmc.net/use/).
<ol>
2.**Install CreatureChat Mod:** Download and copy `creaturechat-*.jar` and `fabric-api-*.jar` into your `.minecraft/mods` folder.
<li><strong>Install Fabric Loader & API:</strong> Follow the instructions <ahref="https://fabricmc.net/use/">here</a>.</li>
3.**Launch Minecraft** with the Fabric profile.
<li><strong>Install CreatureChat Mod:</strong> Download and copy <code>creaturechat-*.jar</code> and <code>fabric-api-*.jar</code> into your <code>.minecraft/mods</code> folder.</li>
4.**Configure AI:** A LLM (large language model) is required for generating text (AI options **listed below**)
<li><strong>Create an OpenAI API key:</strong> Visit <ahref="https://platform.openai.com/api-keys">https://platform.openai.com/api-keys</a>, and use the <strong>+ Create new secret key</strong> button.
Copy/Paste your key into the <code>/creaturechat key set <YOUR-SECRET-KEY-HERE></code> command.</li>
### Forge (with Sinytra Connector)
<li><strong>Launch Minecraft</strong> with the Fabric profile.</li>
*NOTE: Sintra Connector only supports Minecraft 1.20.1.*
</ol>
</details>
1.**Install Forge:** Download [Forge Installer](https://files.minecraftforge.net/), run it, select "Install client".
<details>
2.**Install Forgified Fabric API:** Download [Forgified Fabric API](https://curseforge.com/minecraft/mc-mods/forgified-fabric-api) and copy the `*.jar` into your `.minecraft/mods` folder.
<summary>Forge (with Sinytra Connector)</summary>
3.**Install Sinytra Connector:** Download [Sinytra Connector](https://www.curseforge.com/minecraft/mc-mods/sinytra-connector) and copy the `*.jar` into your `.minecraft/mods` folder.
<h3>Forge Instructions</h3>
4.**Install CreatureChat Mod:** Download and copy `creaturechat-*.jar` into your `.minecraft/mods` folder.
<h4>NOTE: Sintra Connector only supports Minecraft 1.20.1</h4>
6.**Launch Minecraft** with the Forge profile.
<ol>
7.**Configure AI:** A LLM (large language model) is required for generating text (AI options **listed below**)
<li><strong>Install Forge:</strong> Download <ahref="https://files.minecraftforge.net/">Forge Installer</a>, run it, select "Install client".</li>
<li><strong>Install Forgified Fabric API:</strong> Download <ahref="https://curseforge.com/minecraft/mc-mods/forgified-fabric-api">Forgified Fabric API</a> and copy the <code>*.jar</code> into your <code>.minecraft/mods</code> folder.</li>
## AI Options
<li><strong>Install Sinytra Connector:</strong> Download <ahref="https://www.curseforge.com/minecraft/mc-mods/sinytra-connector">Sinytra Connector</a> and copy the <code>*.jar</code> into your <code>.minecraft/mods</code> folder.</li>
CreatureChat **requires** an AI / LLM (large language model) to generate text (characters and chat). There are many different
<li><strong>Install CreatureChat Mod:</strong> Download and copy <code>creaturechat-*.jar</code> into your <code>.minecraft/mods</code> folder.</li>
options for connecting an LLM.
<li><strong>Create an OpenAI API key:</strong> Visit <ahref="https://platform.openai.com/api-keys">https://platform.openai.com/api-keys</a>, and use the <strong>+ Create new secret key</strong> button.
Copy/Paste your key into the <code>/creaturechat key set <YOUR-SECRET-KEY-HERE></code> command.</li>
1.**Free & Local**: Use open-source and free-to-use LLMs without any API fees. [**Difficulty: Hard**]
<li><strong>Launch Minecraft</strong> with the Forge profile.</li>
2.**Bring Your Own Key**: Use your own API key from providers like OpenAI or Groq. [**Difficulty: Medium**]
</ol>
3.**Token Shop**: Supports CreatureChat by purchasing tokens from the developers on Discord. [**Difficulty: Easy**]
</details>
### 1. Free & Local
### In-game Commands
CreatureChat fully supports **free and open-source** LLMs. To get started:
<details>
<summary>Configure CreatureChat</summary>
- An HTTP endpoint compatible with the OpenAI Chat Completion JSON syntax is required. We highly recommend using:
<ul>
-[Ollama](https://ollama.com/) & [LiteLLM](https://litellm.vercel.app/) as your HTTP proxy.
<li><strong>REQUIRED:</strong><code>/creaturechat key set <key></code>
-**LiteLLM Features:**
<ul>
- Supports over **100+ LLMs** (e.g., Anthropic, VertexAI, HuggingFace, Google Gemini, and Ollama).
<li>Sets the <em>OpenAI API key</em>. This is required for making requests to the LLM.</li>
- Proxies them through a local HTTP endpoint compatible with CreatureChat.
</ul>
-**Note:** Running a local LLM on your computer requires a powerful GPU.
</li>
- Set the local HTTP endpoint in-game:
<li><strong>OPTIONAL:</strong><code>/creaturechat url set "<url>"</code>
-`/creaturechat url set "http://ENTER-YOUR-HTTP-ENDPOINT-FROM-LITE-LLM"`
<ul>
-`/creaturechat model set ENTER-MODEL-NAME`
<li>Sets the URL of the API used to make LLM requests. Defaults to <code>"https://api.openai.com/v1/chat/completions"</code></li>
-`/creaturechat timeout set 360`
</ul>
- Additional help can be found in the **#locall-llm-info** channel on our [Discord](https://discord.gg/m9dvPFmN3e).
</li>
<li><strong>OPTIONAL:</strong><code>/creaturechat model set <model></code>
### 2. Bring Your Own Key
<ul>
For those already using a third-party API (e.g., OpenAI, Groq):
<li>Sets the model used for generating responses in chats. Defaults to <code>gpt-3.5-turbo</code>.</li>
</ul>
- Integrate your own API key for seamless connectivity.
</li>
- Costs depend on the provider’s usage-based pricing model.
<li><strong>OPTIONAL:</strong><code>/creaturechat timeout set <seconds></code>
- By default, CreatureChat uses the OpenAI endpoint and `gpt-3.5-turbo` model, known for its balance of low cost and fast performance.
<ul>
- Be aware that OpenAI’s developer API does not include free usage. Please review the [OpenAI pricing](https://openai.com/pricing#language-models) for detailed information.
<li>Sets the timeout (in seconds) for API HTTP requests. Defaults to <code>10</code> seconds.</li>
- To create an OpenAI API key, visit [https://platform.openai.com/api-keys](https://platform.openai.com/api-keys), and use the **+ Create new secret key** button.
</ul>
- Set the API key & model in-game:
</li>
-`/creaturechat key set <YOUR-SECRET-KEY-HERE>`
<li><strong>OPTIONAL:</strong><code>/creaturechat whitelist <entityType | all | clear></code> - Show chat bubbles
-`/creaturechat model set gpt-3.5-turbo`
<ul>
<li>Shows chat bubbles for the specified entity type or all entities, or clears the whitelist.</li>
### 3. Token Shop
</ul>
Supports CreatureChat by purchasing tokens from the developers:
- Easy setup with simple token packs, created for CreatureChat users.
<ul>
- More info is available in the #token-shop channel on our [Discord](https://discord.gg/m9dvPFmN3e).
<li>Hides chat bubbles for the specified entity type or all entities, or clears the blacklist.</li>
- Set the token-shop API key in-game:
</ul>
-`/creaturechat key set <YOUR-SECRET-KEY-HERE>`
</li>
</ul>
### In-game Commands / Configuration
-**REQUIRED:**`/creaturechat key set <key>`
<h4>Configuration Scope:</h4>
- Sets the *OpenAI API key*. This is required for making requests to the LLM.
<ul>
-**OPTIONAL:**`/creaturechat url set "<url>"`
<li><strong>OPTIONAL:</strong> You can specify the configuration scope at the end of each command to determine where settings should be applied:
- Sets the URL of the API used to make LLM requests. Defaults to `"https://api.openai.com/v1/chat/completions"`.
<ul>
-**OPTIONAL:**`/creaturechat model set <model>`
<li><strong>Default</strong> Configuration (<code>--config default</code>): Applies the configuration universally, unless overridden by a server-specific configuration.</li>
- Sets the model used for generating responses in chats. Defaults to `gpt-3.5-turbo`.
<li><strong>Server</strong>-Specific Configuration (<code>--config server</code>): Applies the configuration only to the server where the command is executed.</li>
-**OPTIONAL:**`/creaturechat timeout set <seconds>`
<li>If the <code>--config</code> option is not specified, the <code>default</code> configuration scope is assumed.</li>
- Sets the timeout (in seconds) for API HTTP requests. Defaults to `10` seconds.
</ul>
-**OPTIONAL:**`/creaturechat whitelist <entityType | all | clear>` - Show chat bubbles
</li>
- Shows chat bubbles for the specified entity type or all entities, or clears the whitelist.
