mirrors/mindcraft
1
0
Fork 0
mirror of https://github.com/kolbytn/mindcraft.git synced 2025-03-28 14:56:24 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Added faq link

Browse source
This commit is contained in:
Max Robinson 2024-11-02 14:08:59 -05:00 • committed by GitHub
parent 771f5de708
commit 7fd505c4b5
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 8 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -2,7 +2,10 @@
Crafting minds for Minecraft with LLMs and Mineflayer! Crafting minds for Minecraft with LLMs and Mineflayer!
[Join the discord for support!](https://discord.gg/ZsrAAByEnr) [FAQ](https://github.com/kolbytn/mindcraft/blob/main/FAQ.md)
[Discord Support](https://discord.gg/ZsrAAByEnr)
#### ‼️Warning‼️ #### ‼️Warning‼️
@ -28,6 +31,8 @@ This project allows an LLM to write/execute code on your computer. While the cod
6. Run `node main.js` from the installed directory 6. Run `node main.js` from the installed directory
If you encounter issues, check the [FAQ](https://github.com/kolbytn/mindcraft/blob/main/FAQ.md) or find support on [discord](https://discord.gg/ZsrAAByEnr). We are currently not very responsive to github issues.
## Customization ## Customization
You can configure project details in `settings.js`. [See file.](settings.js) You can configure project details in `settings.js`. [See file.](settings.js)
@ -59,6 +64,8 @@ To connect to online servers your bot will need an official Microsoft/Minecraft
``` ```
‼️ The bot's name in the profile.json must exactly match the Minecraft profile name! Otherwise the bot will spam talk to itself. ‼️ The bot's name in the profile.json must exactly match the Minecraft profile name! Otherwise the bot will spam talk to itself.
To use different accounts, Mindcraft will connect with the account that the Minecraft launcher is currently using. You can switch accounts in the launcer, then run `node main.js`, then switch to your main account after the bot has connected.
### Docker Container ### Docker Container
If you intend to `allow_insecure_coding`, it is a good idea to run the app in a docker container to reduce risks of running unknown code. This is strongly recommended before connecting to remote servers. If you intend to `allow_insecure_coding`, it is a good idea to run the app in a docker container to reduce risks of running unknown code. This is strongly recommended before connecting to remote servers.