Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
CreatureChat
Overview
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Jobs
Commits
Open sidebar
Public
CreatureChat
Commits
f80faf0a
Commit
f80faf0a
authored
Apr 14, 2024
by
Jonathan Thomas
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Updated README with command usage
parent
874d53ba
Pipeline
#11987
passed with stage
in 20 seconds
Changes
1
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
20 additions
and
1 deletion
+20
-1
README.md
README.md
+20
-1
No files found.
README.md
View file @
f80faf0a
...
...
@@ -15,7 +15,6 @@ Looking to enrich your Minecraft journey with deep conversations and lasting all
**Step into the world of CreatureChat 🗨 and spark your first conversation today!**
## Installation
1.
**Install Fabric Loader**
: Follow the instructions
[
here
](
https://fabricmc.net/use/
)
.
2.
**Download Fabric API**
: Get the version which we support (refer to
`gradle.properties`
for supported Minecraft and Fabric versions)
from
[
Modrinth
](
https://modrinth.com/mod/fabric-api
)
...
...
@@ -23,6 +22,26 @@ Looking to enrich your Minecraft journey with deep conversations and lasting all
3.
**Install Mob GPT Mod**
: Place
`mobgpt-*.jar`
and
`fabric-api-*.jar`
into your
`.minecraft/mods`
folder.
## Commands
The CreatureChat mod allows users to configure settings via in-game commands. Here's how to use them:
### Command Usage
-
`/creaturechat key set <key>`
Sets the
**OpenAI API key**
. This is required for making requests to the LLM.
-
`/creaturechat url set <url>`
**Optional:**
Sets the URL of the API used to make LLM requests.
-
`/creaturechat model set <model>`
**Optional:**
Sets the model used for generating responses in chats.
### Configuration Scope:
You can specify the
**optional**
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.
## Screenshots
![
Pig Teaching Player
](
src/main/resources/assets/mobgpt/screenshots/pig-teaching.png
"Pig Teaching Player"
)
![
Villager Greeting Player
](
src/main/resources/assets/mobgpt/screenshots/villager_greeting.png
"Villager Greeting Player"
)
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment