Commit b1972f55 by Jonathan Thomas

Small tweaks to README

parent becadabf
Pipeline #12011 passed with stage
in 26 seconds
...@@ -32,9 +32,9 @@ The CreatureChat mod allows users to configure settings via in-game commands. He ...@@ -32,9 +32,9 @@ The CreatureChat mod allows users to configure settings via in-game commands. He
- `/creaturechat key set <key>` - `/creaturechat key set <key>`
Sets the **OpenAI API key**. This is required for making requests to the LLM. Sets the **OpenAI API key**. This is required for making requests to the LLM.
- `/creaturechat url set <url>` - `/creaturechat url set <url>`
**Optional:** Sets the URL of the API used to make LLM requests. **OPTIONAL:** Sets the URL of the API used to make LLM requests.
- `/creaturechat model set <model>` - `/creaturechat model set <model>`
**Optional:** Sets the model used for generating responses in chats. **OPTIONAL:** Sets the model used for generating responses in chats.
### Configuration Scope: ### Configuration Scope:
You can specify the **optional** configuration scope at the end of each command to determine where settings should be applied: You can specify the **optional** configuration scope at the end of each command to determine where settings should be applied:
...@@ -63,16 +63,6 @@ be updated. Below are the general steps for this upgrade process. ...@@ -63,16 +63,6 @@ be updated. Below are the general steps for this upgrade process.
1. Re-run: `./gradlew runClient` 1. Re-run: `./gradlew runClient`
1. **Optional:** Re-start **IntelliJ IDEA** to clear cached gradle 1. **Optional:** Re-start **IntelliJ IDEA** to clear cached gradle
## Authors
- Jonathan Thomas <jonathan@openshot.org>
- owlmaddie <owlmaddie@gmail.com>
## Contact & Resources
- [Source Code](http://gitlab.openshot.org/minecraft/creature-chat)
- [Join us on Discord](https://discord.gg/m9dvPFmN3e)
## Costs Associated with Third-Party LLM APIs ## Costs Associated with Third-Party LLM APIs
Using third-party Large Language Model (LLM) APIs, such as OpenAI, will incur usage-based fees. Using third-party Large Language Model (LLM) APIs, such as OpenAI, will incur usage-based fees.
These fees are typically based on the amount of data processed or the number of requests made These fees are typically based on the amount of data processed or the number of requests made
...@@ -90,6 +80,16 @@ Exposing your API key publicly can lead to security risks, unauthorized usage, a ...@@ -90,6 +80,16 @@ Exposing your API key publicly can lead to security risks, unauthorized usage, a
service abuse. Treat your API keys as sensitive information and only share them with trusted service abuse. Treat your API keys as sensitive information and only share them with trusted
parties within secure environments. parties within secure environments.
## Authors
- Jonathan Thomas <jonathan@openshot.org>
- owlmaddie <owlmaddie@gmail.com>
## Contact & Resources
- [Source Code](http://gitlab.openshot.org/minecraft/creature-chat)
- [Join us on Discord](https://discord.gg/m9dvPFmN3e)
## License ## License
CreatureChat is a Minecraft mod which allows chat conversations with entities. CreatureChat is a Minecraft mod which allows chat conversations with entities.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment