Files
remoteturtle/QUICKSTART.md

2.5 KiB

🚀 Quick Setup Guide

Step 1: Install Dependencies

Linux/Mac:

./start.sh

Windows:

start.bat

The script will automatically:

  • Check for Node.js
  • Install all dependencies
  • Start both servers

Step 2: Configure Minecraft Bridge

  1. In Minecraft, place a computer with wireless modem
  2. Copy webbridge.lua to the computer
  3. Edit line 5 to match your setup:
    local SERVER_URL = "http://localhost:3001"  -- Change if needed
    
  4. Run the script:
    webbridge
    

Step 3: Deploy Turtles

  1. Place mining turtles with wireless modems
  2. Copy turtle.lua to each turtle
  3. Run on each turtle:
    turtle
    
  4. First command for each turtle: setHome (via pocket or web)

Step 4: Access Web Interface

Open your browser to: http://localhost:3000

You should see:

  • Connection status (top right)
  • 🐢 Turtle list (left panel)
  • 🗺️ 3D map (center)

Troubleshooting

Turtles not showing up?

  • Check webbridge.lua is running
  • Verify SERVER_URL matches your server
  • Ensure turtles have wireless modems equipped

Can't connect from web?

GPS not working?

  • Set up 4 GPS host computers at high altitude
  • Run gps host X Y Z on each (with their coordinates)
  • Alternative: If running Opus OS, use its gpsServer package — a single turtle can self-build a complete GPS constellation (replaces 4 host computers)

Pathfinding

The turtle now includes a built-in pathfinding module exposed as _G._pathfind. You can trigger it from the web UI via eval commands:

-- Navigate to coordinates (avoids obstacles)
_pathfind.goto(100, 65, -200)

-- Navigate with block digging enabled
_pathfind.goto(100, 65, -200, { dig = true })

-- Go home
_pathfind.goHome()

-- Face a specific heading (0=south, 1=west, 2=north, 3=east)
_pathfind.face(3)

-- Get current heading name
_pathfind.headingName()  -- "east"

The pathfinder:

  • Uses GPS for initial position, then tracks movement locally
  • Auto-detects heading on startup via GPS triangulation
  • Handles obstacles by trying to go over/around them
  • Supports optional block digging for clearing paths

Next Steps

  1. Select a turtle in the web interface
  2. Use "Set Home" button
  3. Try "Explore" command
  4. Watch the 3D map update in real-time!

Need more help? Check the full README.md