Skip to content

Commit

Permalink
Bump to v0.3
Browse files Browse the repository at this point in the history
  • Loading branch information
Ranzeplay committed Sep 20, 2024
1 parent 5510939 commit 7f62bf1
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 4 deletions.
21 changes: 18 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,24 @@
# SaySomething

![Modrinth Downloads](https://img.shields.io/modrinth/dt/say-something)
![GitHub commit activity](https://img.shields.io/github/commit-activity/m/ranzeplay/saysth)
![GitHub contributors](https://img.shields.io/github/contributors/ranzeplay/saysth)

A Minecraft Mod that connects villagers to AI models.

> We are preparing for v1.0, please wait patiently :)
>
> Any issues are welcome.
## Description

The mod uses `@cf/qwen/qwen1.5-14b-chat-awq` model by default on Cloudflare AI
to enable players to interact with villagers via text. You can customize many things.
to enable players to interact with villagers via text.
You can customize many things.

## Usage

Put `$` sign at the beginning of your chat message
Put the string mentioned in config at the beginning of your chat message
to talk to villagers in front of you.

Villagers may not respond if your message isn't related to them.
Expand All @@ -27,7 +36,10 @@ Configuration in the `config/saysth-config.json`, you will see the content below
"personalities": [],
"nameCandidates": [],
"modelName": "@cf/qwen/qwen1.5-14b-chat-awq",
"conclusionMessageLimit": 10
"conclusionMessageLimit": 10,
"villagerChatPrefix": "$",
"useExistingVillagerName": true,
"showTimeConsumption": false
}
```

Expand All @@ -37,6 +49,9 @@ Configuration in the `config/saysth-config.json`, you will see the content below
- `nameCandidates`: A list of string of names that will be put on villagers.
- `modelName`: The LLM model to be used, should exist on Cloudflare
- `conclusionMessageLimit`: When messages reach this limit, it will be concluded into one concise message.
- `villagerChatPrefix`: Add the string at the beginning of chat message to show that you are talking to villagers.
- `useExistingVillagerName`: Use the existing name of a villager according to `CustomName` if possible.
- `showTimeConsumption`: Show how much time consumed between sending to receiving.

### Villager prompt template

Expand Down
2 changes: 1 addition & 1 deletion gradle.properties
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
org.gradle.jvmargs=-Xmx4G
org.gradle.parallel=true
# Mod properties
mod_version=0.2
mod_version=0.3
maven_group=space.ranzeplay
archives_name=saysth
enabled_platforms=fabric,neoforge,forge
Expand Down

0 comments on commit 7f62bf1

Please sign in to comment.