## Chat with any mob in Minecraft! All creatures can talk using AI!
## Chat with any mob in Minecraft! All creatures can talk & react using AI!
### Features
### Features
-**AI-Driven Chats:** Using ChatGPT or open-source AI models, each conversation is unique and engaging!
-**AI-Driven Chats:** Using ChatGPT or open-source AI models, each conversation is unique and engaging!
...
@@ -17,50 +17,76 @@
...
@@ -17,50 +17,76 @@
### Installation Instructions
### Installation Instructions
<details>
<details>
<summary>Fabric (Recommended)</summary>
<summary>Fabric (Recommended)</summary>
<h3>Fabric Instructions</h3>
## Fabric Instructions
<ol>
1.**Install Fabric Loader & API**: Follow the instructions [here](https://fabricmc.net/use/).
<li><strong>Install Fabric Loader & API:</strong> Follow the instructions <ahref="https://fabricmc.net/use/">here</a>.</li>
1.**Install CreatureChat Mod**: Download and copy `creaturechat-*.jar` and `fabric-api-*.jar` into your `.minecraft/mods` folder.
<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>
1.**Create an OpenAI API key**: Visit https://platform.openai.com/api-keys, and use the **+ Create new secret key** button.
<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 `/creaturechat key set <YOUR-SECRET-KEY-HERE>` command.
Copy/Paste your key into the <code>/creaturechat key set <YOUR-SECRET-KEY-HERE></code> command.</li>
1.**Launch Minecraft** with the Fabric profile
<li><strong>Launch Minecraft</strong> with the Fabric profile.</li>
</ol>
</details>
</details>
<details>
<details>
<summary>Forge (with Sinytra Connector)</summary>
<summary>Forge (with Sinytra Connector)</summary>
<h3>Forge Instructions</h3>
## Forge Instructions
<h4>NOTE: Sintra Connector only supports Minecraft 1.20.1</h4>
### NOTE: Sintra Connector only supports Minecraft 1.20.1
<ol>
<li><strong>Install Forge:</strong> Download <ahref="https://files.minecraftforge.net/">Forge Installer</a>, run it, select "Install client".</li>
1.**Install Forge:** Download [Forge Installer](https://files.minecraftforge.net/), run it, select "Install client".
<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>
1.**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.
<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>
1.**Install Sinytra Connector:** Download [Sinytra Connector](https://www.curseforge.com/minecraft/mc-mods/sinytra-connector) and copy the `*.jar` into your `.minecraft/mods` folder.
<li><strong>Install CreatureChat Mod:</strong> Download and copy <code>creaturechat-*.jar</code> into your <code>.minecraft/mods</code> folder.</li>
1.**Install CreatureChat Mod**: Download and copy `creaturechat-*.jar` into your `.minecraft/mods` folder.
<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.
1.**Create an OpenAI API key**: Visit https://platform.openai.com/api-keys, and use the **+ Create new secret key** button.
Copy/Paste your key into the <code>/creaturechat key set <YOUR-SECRET-KEY-HERE></code> command.</li>
Copy/Paste your key into the `/creaturechat key set <YOUR-SECRET-KEY-HERE>` command.
<li><strong>Launch Minecraft</strong> with the Forge profile.</li>
1.**Launch Minecraft** with the Forge profile
</ol>
</details>
</details>
### In-game Commands
### In-game Commands
<details>
<details>
<summary>Configure CreatureChat</summary>
<summary>Configure CreatureChat</summary>
<ul>
-**REQUIRED:**`/creaturechat key set <key>`
<li><strong>REQUIRED:</strong><code>/creaturechat key set <key></code>
- Sets the _OpenAI API key_. This is required for making requests to the LLM.
<ul>
-**OPTIONAL:**`/creaturechat url set "<url>"`
<li>Sets the <em>OpenAI API key</em>. This is required for making requests to the LLM.</li>
- 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>
- Sets the model used for generating responses in chats. Defaults to `gpt-3.5-turbo`.
<li><strong>OPTIONAL:</strong><code>/creaturechat url set "<url>"</code>
-**OPTIONAL:**`/creaturechat timeout set <seconds>`
<ul>
- Sets the timeout (in seconds) for API HTTP requests. Defaults to `10` seconds.
<li>Sets the URL of the API used to make LLM requests. Defaults to <code>"https://api.openai.com/v1/chat/completions"</code></li>
</ul>
### Configuration Scope:
</li>
**OPTIONAL:** You can specify the configuration scope at the end of each command to determine where settings should be applied:
<li><strong>OPTIONAL:</strong><code>/creaturechat model set <model></code>
<ul>
-**Default** Configuration (`--config default`):
<li>Sets the model used for generating responses in chats. Defaults to <code>gpt-3.5-turbo</code>.</li>
Applies the configuration universally, unless overridden by a server-specific configuration.
<li>Hides chat bubbles for the specified entity type or all entities, or clears the blacklist.</li>
</ul>
</li>
</ul>
<h4>Configuration Scope:</h4>
<ul>
<li><strong>OPTIONAL:</strong> You can specify the configuration scope at the end of each command to determine where settings should be applied:
<ul>
<li><strong>Default</strong> Configuration (<code>--config default</code>): Applies the configuration universally, unless overridden by a server-specific configuration.</li>
<li><strong>Server</strong>-Specific Configuration (<code>--config server</code>): Applies the configuration only to the server where the command is executed.</li>
<li>If the <code>--config</code> option is not specified, the <code>default</code> configuration scope is assumed.</li>
