feat: Add Quick Setup Guide for Turtle Control Center

This commit is contained in:
MayaTheShy
2026-02-15 23:52:56 -05:00
parent 37a3b38f2c
commit b0d070bad7
2 changed files with 77 additions and 0 deletions

77
QUICKSTART.md Normal file
View File

@@ -0,0 +1,77 @@
# 🚀 Quick Setup Guide
## Step 1: Install Dependencies
### Linux/Mac:
```bash
./start.sh
```
### Windows:
```cmd
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:
```lua
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?**
- Verify both servers are running (check terminal output)
- Try accessing http://localhost:3001/api/turtles directly
- Check browser console for errors
**GPS not working?**
- Set up 4 GPS host computers at high altitude
- Run `gps host X Y Z` on each (with their coordinates)
## 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