diff --git a/README.md b/README.md index 8e2afec..9739816 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,9 @@ # ⛏️ minecraft-llm-agent-community -[🤖 Documentation Blog](https://naem1023.github.io/minecraft-llm-agent-community/) +- [🤖 Documentation Blog](https://naem1023.github.io/minecraft-llm-agent-community/) + - [Installation Guide](https://naem1023.github.io/minecraft-llm-agent-community/docs/Installation) +- [📚 Analysis of Prior Projects](https://naem1023.github.io/minecraft-llm-agent-community/docs/Analysis-of-Prior-Projects) + - [Simple Analysis of Voyager](https://naem1023.github.io/minecraft-llm-agent-community/docs/Analysis-of-Prior-Projects/voyager) --- diff --git a/docs/docs/Documents/Installation.md b/docs/docs/Documents/Installation.md new file mode 100644 index 0000000..fce2768 --- /dev/null +++ b/docs/docs/Documents/Installation.md @@ -0,0 +1,66 @@ +--- +sidebar_position: 1 +--- + +# Installation + +### Dependenceis +- Pyhton: v3.9 +- Node: v18 + +### Prepare JDK 21>= +- For example, donwload the installation file from [https://www.oracle.com/java/technologies/downloads/#jdk22-mac](https://www.oracle.com/java/technologies/downloads/#jdk22-mac). + +### Download and Run Fabric Minecraft Server Launcher on local +```sh +chmod 751 scripts/*run*.sh + +# If a server isn't installed +scripts/download_run_server.sh + +# IF a server is already install +scripts/run_server.sh +``` +### Set world +- seed: 637184628307790 +- coordinate: 63 94 168 +Set the x y z position on the server command +``` +/setworldspawn 63 94 168 +``` + +server.properties: These settings will automatically set via download_run_server.sh. +```txt +difficulty=peaceful +gamemode=survival +online-mode=false +enable-rcon=true # Only needed if you wish to use RCON features +rcon.password=hunter2 +rcon.port=25575 +spawn-protection=0 # This is important, otherwise the bot can't do anything near the spawn +``` +### Prepare minecraft mods for client +- Check the [fabric mods installation document](installation/fabric_mods_install.md) +### Make python environment +```sh +conda create -n mw python=3.9 -y +conda activate mw +make install +``` + +### Install mineflayer and additional minecraft interface library +```sh +npm install mineflayer + +cd voyager/env/mineflayer +npm install -g npx +npm install +cd mineflayer-collectblock +npm install +npx tsc +cd .. +npm install +``` + +### Set environment variables +Make `.env` file and set environment variables like `.env.sample`. \ No newline at end of file diff --git a/docs/docs/Documents/create-a-page.md b/docs/docs/Documents/create-a-page.md deleted file mode 100644 index 5676223..0000000 --- a/docs/docs/Documents/create-a-page.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Installation - -Still constructing... Please read [README.md](https://github.com/naem1023/minecraft-llm-agent-community) in the repository.