README.md
58 lines · 2.0 KB
Copy & run
wget https://perlytiara.github.io/turtles.tips/raw/programs/perlytiara/stairs/README.md
| 1 | # Stairs System |
| 2 | |
| 3 | Simple, fast stair builder for ComputerCraft turtles. |
| 4 | |
| 5 | ## Files |
| 6 | |
| 7 | - `stairs.lua` - Main stair builder program |
| 8 | - `client.lua` - Remote listener for turtle clients |
| 9 | - `multi.lua` - Send jobs to multiple turtles |
| 10 | - `startup.lua` - Auto-start client on turtle boot |
| 11 | - `download.lua` - Install system to computer/turtle |
| 12 | |
| 13 | ## Quick Start |
| 14 | |
| 15 | ### Single Turtle |
| 16 | ```lua |
| 17 | stairs -- Interactive prompts (shows resource scan) |
| 18 | stairs 3 -- Headroom 3, up to surface |
| 19 | stairs 4 down 50 -- Headroom 4, down 50 steps |
| 20 | stairs 2 up 100 -- Headroom 2, up exactly 100 steps |
| 21 | stairs 3 up auto -- Headroom 3, up using all available blocks |
| 22 | stairs 2 down 25 place -- Headroom 2, down 25 steps, place floors |
| 23 | ``` |
| 24 | |
| 25 | ### Multiple Turtles |
| 26 | 1. Run `client` on each turtle (or use `startup.lua`) |
| 27 | 2. Run `multi` on a computer to send jobs |
| 28 | |
| 29 | ## Features |
| 30 | |
| 31 | - **Resource scanning**: Automatically scans and counts fuel/blocks in inventory |
| 32 | - **Smart block placement**: Uses any non-fuel items as building blocks |
| 33 | - **Flexible length control**: Set exact steps, use surface detection, or auto-use available blocks |
| 34 | - **Efficient fuel usage**: Only refuels when needed, preserves fuel items |
| 35 | - **Clear UI**: Shows resource counts and build estimates |
| 36 | - **Remote control**: Control multiple turtles from one computer |
| 37 | |
| 38 | ## Arguments |
| 39 | |
| 40 | Format: `stairs [headroom] [up/down] [length] [place]` |
| 41 | |
| 42 | - `headroom` - Blocks of clearance above each step (default: 3) |
| 43 | - `up/down` - Direction (default: up) |
| 44 | - `length` - Steps to build, "auto" for max blocks, or surface detection (default: surface for up, 32 for down) |
| 45 | - `place` - Place floor blocks if missing |
| 46 | |
| 47 | ## Examples |
| 48 | |
| 49 | **Basic Usage:** |
| 50 | - `stairs 3` → Headroom 3, up to surface |
| 51 | - `stairs 4 down 50` → Headroom 4, down exactly 50 steps |
| 52 | - `stairs 2 up 100` → Headroom 2, up exactly 100 steps |
| 53 | |
| 54 | **Advanced:** |
| 55 | - `stairs 3 up auto place` → Use all available blocks going up, place floors |
| 56 | - `stairs 2 down 25 place` → Down 25 steps with floor placement |
| 57 | - Interactive mode shows: "Resources: 64 fuel, 128 blocks" |
| 58 |