Clarth/Computercraft-Turtle-Quarry-Script
Clarth
/
Computercraft-Turtle-Quarry-Script
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md

This commit is contained in:
Clarth 2024-01-23 16:52:19 -05:00
parent 0deb7f79cb
commit 01c363d881
1 changed files with 46 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

94
README.md
View File

@ -80,55 +80,53 @@ Note: If you don't know how to access any of the features: Type "quarry help" wh
## Arguments
Welcome!: Welcome to quarry help. Below are help entries for all parameters. Examples and tips are at the bottom.
\-default: This will force no prompts. If you use this and nothing else, only defaults will be used.
\-dim: \[length\] \[width\] \[height\] This sets the dimensions for the quarry
\-invert: \[t/f\] If true, quarry will be inverted (go up instead of down)
\-rednet: \[t/f\] If true and you have a wireless modem on the turtle, will attempt to make a rednet connection for sending important information to a screen
\-restore / -resume: If your quarry stopped in the middle of its run, use this to resume at the point where the turtle was. Not guarenteed to work properly. For more accurate location finding, check out the -GPS parameter
\-autoResume / autoRestore: Turtle will automatically resume if stopped. Replaces startup
\-oreQuarry: \[t/f\] If true, the turtle will use ore quarry mode. It will not mine the blocks that are placed in the turtle initially. So if you put in stone, it will ignore stone blocks and only mine ores.
\-oreQuarry: \[t/f\] If you are using a newer version of CC, you won't have to put in any compare blocks. (CC 1.64+)
\-blacklist: \[file name\] If using oreQuarry, this is the blacklist file it will read. Example --
minecraft:stone
minecraft:sand
ThermalExpansion:Sponge
ThermalFoundation:Storage
# Welcome to Quarry Help
Welcome to Quarry help. Below are help entries for all parameters. Examples and tips are at the bottom.
- **-default:** This will force no prompts. If you use this and nothing else, only defaults will be used.
- **-dim:** [length] [width] [height] This sets the dimensions for the quarry.
- **-invert:** [t/f] If true, the quarry will be inverted (go up instead of down).
- **-rednet:** [t/f] If true and you have a wireless modem on the turtle, will attempt to make a rednet connection for sending important information to a screen.
- **-restore / -resume:** If your quarry stopped in the middle of its run, use this to resume at the point where the turtle was. Not guaranteed to work properly. For more accurate location finding, check out the -GPS parameter.
- **-autoResume / -autoRestore:** Turtle will automatically resume if stopped. Replaces startup.
- **-oreQuarry:** [t/f] If true, the turtle will use ore quarry mode. It will not mine the blocks that are placed in the turtle initially. So if you put in stone, it will ignore stone blocks and only mine ores.
- **-blacklist:** [file name] If using oreQuarry, this is the blacklist file it will read. Example --
```
minecraft:stone
minecraft:sand
ThermalExpansion:Sponge
ThermalFoundation:Storage
```
If you have bspkrsCore, look for "UniqueNames.txt" in your config.
- **-atChest:** [force] This is for use with "-restore," telling the restarting turtle that it is at its home chest, so that if it had gotten lost, it now knows where it is.
- **-doRefuel:** [t/f] If true, the turtle will refuel itself with coal and planks it finds on its mining run.
- **-doCheckFuel:** [t/f] If you, for some reason, don't want the program to check fuel usage, set to false. This is honestly a hold-over from when the refueling algorithm was awful...
- **-uniqueExtras:** [number] The expected number of slots filled with low-stacking items like ore. Higher numbers request more fuel.
- **-chest:** [side] This specifies what side the chest at the end will be on. You can say "top," "bottom," "front," "left," or "right."
- **-enderChest:** This one is special. If you use "-enderChest true" then it will use an enderChest in the default slot. However, you can also do "-enderChest [slot]" then it will take the ender chest from whatever slot you tell it to. Like 7... or 14... or whatever.
- **-GPS:** [force] If you use "-GPS" and there is a GPS network, then the turtle will record its first two positions to precisely calculate its position if it has to restart. This will only take two GPS readings.
- **-sendChannel:** [number] This is what channel your turtle will send rednet messages on.
- **-receiveChannel:** [number] This is what channel your turtle will receive rednet messages on.
- **-startY:** [current Y coord] Randomly encountering bedrock? This is the parameter for you! Just give it what y coordinate you are at right now. If it is not within bedrock range, it will never say it found bedrock.
- **-startupRename:** [file name] What to rename any existing startup to.
- **-startupName:** [file name] What the turtle will save its startup file to.
- **-extraDropItems:** [force] If oreQuarry then this will prompt the user for extra items to drop, but not compare to (like cobblestone).
- **-dumpCompareItems:** [t/f] If oreQuarry and this is true, the turtle will dump off compare blocks instead of storing them in a chest.
- **-oldOreQuarry:** [t/f] If you are using new CC versions, you can use this to use the old oreQuarry.
- **-maxTries:** [number] This is the number of times the turtle will try to dig before deciding its run into bedrock.
- **-logging:** [t/f] If true, will record information about its mining run in a folder at the end of the mining run.
- **-doBackup:** [t/f] If false, will not back up important information and cannot restore, but will not make an annoying file (Actually I don't really know why anyone would use this...).
- **-saveFile:** [word] This is what the backup file will be called.
- **-logFolder:** [word] The folder that quarry logs will be stored in.
- **-logExtension:** [word] The extension given to each quarry log (e.g., ".txt" or ".notepad" or whatever).
- **-keepOpen:** [number] This is the number of the slots the turtle will make sure are open. It will check every time it mines.
- **-careAboutResources:** [t/f] Who cares about the materials! If set to false, it will just keep mining when its inventory is full.
- **-startDown:** [number] If you set this, the turtle will go down this many blocks from the start before starting its quarry.
- **-promptAll:** This is the opposite of -Default, it prompts for everything.
- **-manualPos:** [xPos] [zPos] [yPos] [facing] This is for advanced use. If the server reset when the turtle was in the middle of a 100x100x100 quarry, fear not, you can now manually set the position of the turtle. yPos is always positive. The turtle's starting position is 0, 1, 1, 0. Facing is measured 0 - 3. 0 is forward, and it progresses clockwise. Example- "-manualPos 65 30 30 2"
- **-help:** That's what this is :D
If you have bspkrsCore, look for "UniqueNames.txt" in your config
\-atChest: \[force\] This is for use with "-restore," this will tell the restarting turtle that it is at its home chest, so that if it had gotten lost, it now knows where it is.
\-doRefuel: \[t/f\] If true, the turtle will refuel itself with coal and planks it finds on its mining run
\-doCheckFuel: \[t/f\] If you for some reason don't want the program to check fuel usage, set to false. This is honestly a hold-over from when the refueling algorithm was awful...
\-uniqueExtras: \[number\] The expected number of slots filled with low-stacking items like ore. Higher numbers request more fuel.
\-chest: \[side\] This specifies what side the chest at the end will be on. You can say "top", "bottom", "front", "left", or "right"
\-enderChest: This one is special. If you use "-enderChest true" then it will use an enderChest in the default slot. However, you can also do "-enderChest \[slot\]" then it will take the ender chest from whatever slot you tell it to. Like 7... or 14... or whatever.
\-GPS: \[force\] If you use "-GPS" and there is a GPS network, then the turtle will record its first two positions to precisly calculate its position if it has to restart. This will only take two GPS readings
\-sendChannel: \[number\] This is what channel your turtle will send rednet messages on
\-receiveChannel: \[number\] This is what channel your turtle will receive rednet messages on
\-startY: \[current Y coord\] Randomly encountering bedrock? This is the parameter for you! Just give it what y coordinate you are at right now. If it is not within bedrock range, it will never say it found bedrock
\-startupRename: \[file name\] What to rename any existing startup to.
\-startupName: \[file name\] What the turtle will save its startup file to.
\-extraDropItems: \[force\] If oreQuarry then this will prompt the user for extra items to drop, but not compare to (like cobblestone)
\-dumpCompareItems: \[t/f\] If oreQuarry and this is true, the turtle will dump off compare blocks instead of storing them in a chest
\-oldOreQuarry: \[t/f\] If you are using new CC versions, you can use this to use the old oreQuarry.
\-maxTries: \[number\] This is the number of times the turtle will try to dig before deciding its run into bedrock.
\-logging: \[t/f\] If true, will record information about its mining run in a folder at the end of the mining run
\-doBackup: \[t/f\] If false, will not back up important information and cannot restore, but will not make an annoying file (Actually I don't really know why anyone would use this...)
\-saveFile: \[word\] This is what the backup file will be called
\-logFolder: \[word\] The folder that quarry logs will be stored in
\-logExtension: \[word\] The extension given to each quarry log (e.g. ".txt" or ".notepad" or whatever)
\-keepOpen: \[number\] This is the number of the slots the turtle will make sure are open. It will check every time it mines
\-careAboutResources: \[t/f\] Who cares about the materials! If set to false, it will just keep mining when its inventory is full
\-startDown: \[number\] If you set this, the turtle will go down this many blocks from the start before starting its quarry
\=
C \_ |
|
|
|
|\_ \_ \_ \_ >
\-promptAll: This is the opposite of -Default, it prompts for everything
\-manualPos: \[xPos\] \[zPos\] \[yPos\] \[facing\] This is for advanced use. If the server reset when the turtle was in the middle of a 100x100x100 quarry, fear not, you can now manually set the position of the turtle. yPos is always positive. The turtle's starting position is 0, 1, 1, 0. Facing is measured 0 - 3. 0 is forward, and it progresses clockwise. Example- "-manualPos 65 30 30 2"
\-help: Thats what this is ![:D](https://www.computercraft.info/forums2/public/style_emoticons/default/biggrin.png)
## Examples: Everything below is examples and tips for use