mirrors/mindcraft
1
0
Fork 0
mirror of https://github.com/kolbytn/mindcraft.git synced 2025-07-29 11:25:28 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

better readme

Browse source
This commit is contained in:
Maximus 2024-04-05 17:25:06 -05:00
parent 6a387e60e0
commit 97e2bfbe88
1 changed files with 11 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -19,13 +19,16 @@ Add one of these environment variables:
- `GEMINI_API_KEY` - `GEMINI_API_KEY`
- `ANTHROPIC_API_KEY` (and optionally `OPENAI_API_KEY` for embeddings. not necessary, but without embeddings performance will suffer) - `ANTHROPIC_API_KEY` (and optionally `OPENAI_API_KEY` for embeddings. not necessary, but without embeddings performance will suffer)
⭐[How do I add the API key as an environment variable?](https://phoenixnap.com/kb/windows-set-environment-variable)⭐
Clone/Download this repository Clone/Download this repository
Run `npm install` Run `npm install`
Install the minecraft version specified in `settings.json`, currently supports up to 1.20.2 Install the minecraft version specified in `settings.json`, currently supports up to 1.20.4
## Run ## Running Locally
Start a minecraft world and open it to LAN on localhost port `55916` Start a minecraft world and open it to LAN on localhost port `55916`
@ -33,17 +36,21 @@ Run `node main.js`
You can configure the agent's name, model, and prompts in their profile like `andy.json`. You can configure the agent's name, model, and prompts in their profile like `andy.json`.
You can configure project details in `settings.json`.
You can configure project details in `settings.json`. Here is an example settings for connecting to a non-local server:
## Online Servers
To connect to online servers your bot will need an official Microsoft/Minecraft account. You can use your own personal one, but will need another account if you want to connect with it. Here is an example settings for this:
``` ```
{ {
"minecraft_version": "1.20.1", "minecraft_version": "1.20.4",
"host": "111.222.333.444", "host": "111.222.333.444",
"port": 55920, "port": 55920,
"auth": "microsoft", "auth": "microsoft",
"allow_insecure_coding": false "allow_insecure_coding": false
} }
``` ```
‼️Make sure your bot's name in the profile.json matches the account name! Otherwise the bot will spam talk to itself.
## Patches ## Patches