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

improved readme

Browse source
This commit is contained in:
MaxRobinsonTheGreat 2024-01-30 22:26:27 -06:00
parent 86ab1686b4
commit 74e061c48f
1 changed files with 11 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
README.md
View file

@ -1,33 +1,32 @@
# Mindcraft # Mindcraft
Crafting minds for Minecraft with AI! Crafting minds for Minecraft with ChatGPT and Mineflayer
### ‼️Warning‼️ #### ‼️Warning‼️
This project allows an AI model to write/execute code on your computer that may be insecure, dangerous, and vulnerable to injection attacks by human players. This is disabled by default, you can enable it by setting `allow_insecure_coding` to `true` in `settings.json`. Use with caution. This project allows an AI model to write/execute code on your computer that may be insecure, dangerous, and vulnerable to injection attacks on public servers. Code writing is disabled by default, you can enable it by setting `allow_insecure_coding` to `true` in `settings.json`. Enable only on local or private servers, **never** on public servers. Ye be warned.
## Requirements
**Do not** connect this bot to public servers, only run on local or private servers. - [OpenAI API Subscription](https://openai.com/blog/openai-api)
- [Minecraft Java Edition](https://www.minecraft.net/en-us/store/minecraft-java-bedrock-edition-pc) (at most v1.20.2)
- [Node.js](https://nodejs.org/) (at least v14)
## Installation ## Installation
Install Minecraft Java Edition <= 1.20.2 Add `OPENAI_API_KEY` (and optionally `OPENAI_ORG_ID`) to your environment variables
Install Node.js >= 14 from [nodejs.org](https://nodejs.org/)
Clone/Download this repository Clone/Download this repository
Run `npm install` Run `npm install`
Add `OPENAI_API_KEY` (and optionally `OPENAI_ORG_ID`) to your environment variables. ## Run
## Running Start a minecraft world and open it to LAN on localhost port `55916`
Start minecraft game and open it to LAN on localhost port `55916`
Run `node main.js` Run `node main.js`
You can configure the bot in `settings.json`. Here is an example settings for connecting to a non-local server: You can configure details in `settings.json`. Here is an example settings for connecting to a non-local server:
``` ```
{ {
"host": "111.222.333.444", "host": "111.222.333.444",