View difference between Paste ID: nXTEu7K6 and NFYUgsLJ
SHOW: | | - or go back to the newest paste.
1
--Civilwargeeky's Quarry Program--
2
  VERSION = "3.6.4.5 w/ basicFuelChest"
3
--[[
4
Recent Changes:
5
  Parameter Files! Create a file of parameters, and use -file to load it!
6
    Works will with -forcePrompt
7
  Quarry no longer goes to start at end of row!
8
  Turtle can go left!
9
  QuadCopters! Check Lyqyd's thread
10
New Parameters:
11
    -overfuel/fuelMultiplier [number]: This number is is what neededFuel is multiplied by when fuel is low.
12
    -version: This will display the current version number and end the program
13
    -file [fileName]: This will load a custom configuration file (basically a list of parameters). "##" starts comment lines. In the future "#" will start programs to run (but only through shell)
14
    -preciseTotals [t/f]: If true, turtle will write exactly what it mined to the logs. It may also transmit it over rednet.
15
    -forcePrompt [param]: This will add to a list of parameters to force prompt for. So if you say "-forcePrompt doRefuel" it will prompt you "Length","Width","Height","Invert","Do Refuel" etc.
16
]]
17
--Defining things
18
civilTable = nil; _G.civilTable = {}; setmetatable(civilTable, {__index = getfenv()}); setfenv(1,civilTable)
19
originalDay = os.day() --Used in logging
20
numResumed = 0 --Number of times turtle has been resumed
21
-------Defaults for Arguments----------
22
--Arguments assignable by text
23
x,y,z = 3,3,3 --These are just in case tonumber fails
24
inverted = false --False goes from top down, true goes from bottom up [Default false]
25
rednetEnabled = false --Default rednet on or off  [Default false]
26
--Arguments assignable by tArgs
27
dropSide = "front" --Side it will eject to when full or done [Default "front"]
28
careAboutResources = true --Will not stop mining once inventory full if false [Default true]
29
doCheckFuel = true --Perform fuel check [Default true]
30
doRefuel = false --Whenever it comes to start location will attempt to refuel from inventory [Default false]
31
keepOpen = 1 --How many inventory slots it will attempt to keep open at all times [Default 1]
32
fuelSafety = "moderate" --How much fuel it will ask for: safe, moderate, and loose [Default moderate]
33
excessFuelAmount = math.huge --How much fuel the turtle will get maximum. Limited by turtle.getFuelLimit in recent CC [Default math.huge]
34
fuelMultiplier = 1 --How much extra fuel turtle will ask for when it does need fuel [Default 1]
35
saveFile = "Civil_Quarry_Restore" --Where it saves restore data [Default "Civil_Quarry_Restore"]
36
autoResume = true --If true, turtle will auto-restart when loaded. [Default true]
37
startupRename = "oldStartup.quarry" --What the startup is temporarily renamed to [Default "oldStartup.quarry"]
38
startupName = "startup" --What the turtle auto-resumes with [Default "startup"]
39
doBackup = true --If it will keep backups for session persistence [Default true]
40
uniqueExtras = 8 --How many different items (besides cobble) the turtle expects. [Default 8]
41
maxTries = 200 --How many times turtle will try to dig a block before it "counts" bedrock [Default 200]
42
gpsEnabled = false -- If option is enabled, will attempt to find position via GPS api [Default false]
43
gpsTimeout = 3 --The number of seconds the program will wait to get GPS coords. Not in arguments [Default 3]
44
legacyRednet = false --Use this if playing 1.4.7
45
logging = true --Whether or not the turtle will log mining runs. [Default ...still deciding]
46
logFolder = "Quarry_Logs" --What folder the turtle will store logs in [Default "Quarry_Logs"]
47
logExtension = "" --The extension of the file (e.g. ".txt") [Default ""]
48
flatBedrock = false --If true, will go down to bedrock to set startDown [Default false]
49
startDown = 0 --How many blocks to start down from the top of the mine [Default 0]
50
preciseTotals = false --If true, will record exact totals and names for all materials [Default false]
51
goLeftNotRight = false --Quarry to left, not right (parameter is "left") [Default false]
52
oreQuarry = false --Enables ore quarry functionality [Default false]
53
oreQuarryBlacklistName = "oreQuarryBlacklist.txt" --This is the file that will be parsed for item names [Default "oreQuarryBlacklist"]
54
dumpCompareItems = true --If ore quarry, the turtle will dump items compared to (like cobblestone) [Default true]
55
frontChest = false --If oreQuarry and chest checking, you can turn this on to make turtle check in front of itself for chests as well [Default false]
56
lavaBuffer = 500 --If using a lava bucket, this is the buffer it will wait for before checking for lava [Default 500]
57
inventoryMax = 16 --The max number of slots in the turtle inventory [Default 16] (Not assignable by parameter)
58
quadEnabled = false --Whether or not to request a quadRotor when out of fuel [Default false]
59
quadTimeout = 60 * 5 --How long the turtle will wait for a quadRotor [Default 5 minutes]
60
--Standard number slots for fuel (you shouldn't care)
61
fuelTable = { --Will add in this amount of fuel to requirement.
62
safe = 1000,
63
moderate = 200,
64
loose = 0 } --Default 1000, 200, 0
65
--Standard rednet channels
66
channels = {
67
send = os.getComputerID() + 1  ,
68
receive = os.getComputerID() + 101 ,
69
confirm = "Turtle Quarry Receiver",
70
message = "Civil's Quarry",
71
fingerprint = "quarry"
72
}
73
74
--AVERAGE USER: YOU DON'T CARE BELOW THIS POINT
75
76
local help_paragraph = [[
77
Welcome!: Welcome to quarry help. Below are help entries for all parameters. Examples and tips are at the bottom.
78
-default: This will force no prompts. If you use this and nothing else, only defaults will be used.
79
-dim: [length] [width] [height] This sets the dimensions for the quarry
80
-invert: [t/f] If true, quarry will be inverted (go up instead of down)
81
-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
82
-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
83
-autoResume / autoRestore: Turtle will automatically resume if stopped. Replaces startup
84
-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.
85
-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+)
86
-blacklist: [file name] If using oreQuarry, this is the blacklist file it will read. Example --
87
  minecraft:stone
88
  minecraft:sand
89
  ThermalExpansion:Sponge
90
  ThermalFoundation:Storage
91
  
92
  Note: If you have bspkrsCore, look 
93
  for "UniqueNames.txt" in your config
94
-file: [file name] Will load a file of parameters. One parameter per line. # is a comment line (See the forum thread for more detailed directions)
95
-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.
96
-doRefuel: [t/f] If true, the turtle will refuel itself with coal and planks it finds on its mining run
97
-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...
98
-overfuel: [number] When fuel is below required, fuel usage is multiplied by this. Large numbers permit more quarries without refueling
99
-fuelMultiplier: [number] See overfuel
100
-uniqueExtras: [number] The expected number of slots filled with low-stacking items like ore. Higher numbers request more fuel.
101
-maxFuel: [number] How much the turtle will fuel to max (limited by turtle in most cases)
102
-chest: [side] This specifies what side the chest at the end will be on. You can say "top", "bottom", "front", "left", or "right"
103
-enderChest: [slot] 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.
104
-fuelChest: [slot] See the above, but for a fueling chest. Reccommend use with -maxFuel and -doCheckFuel false
105
-lava: [slot] If using an oreQuarry, will fill itself with lava it finds to maxFuel
106
-lavaBuffer: [number] The amount of fuel below maxFuel the turtle will wait for before using lava again
107
-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
108
-quad: [t/f] This forces the use of GPS. Make sure you have a network set up. This will request to be refueled by a quadrotor from Lyqyd's mod if the turtle is out of fuel
109
-quadTimeout: [number] The amount of time the turtle will wait for a quadRotor
110
-sendChannel: [number] This is what channel your turtle will send rednet messages on
111
-receiveChannel: [number] This is what channel your turtle will receive rednet messages on
112
-legacyRednet: [t/f] Check true if using 1.4.7
113
-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
114
-startupRename: [file name] What to rename any existing startup to.
115
-startupName: [file name] What the turtle will save its startup file to.
116
-extraDropItems: [force] If oreQuarry then this will prompt the user for extra items to drop, but not compare to (like cobblestone)
117
-dumpCompareItems: [t/f] If oreQuarry and this is true, the turtle will dump off compare blocks instead of storing them in a chest
118
-oldOreQuarry: [t/f] If you are using new CC versions, you can use this to use the old oreQuarry.
119
-compareChest: [slot] If using oldOreQuarry, this will allow you to check for dungeon chests and suck from them.
120
-frontChest: [t/f] If using oreQuarry/oldOreQuarry, this will check in front of itself for chests as well.
121
-left: [t/f] If true, turtle will quarry to the left instead of the right
122
-maxTries: [number] This is the number of times the turtle will try to dig before deciding its run into bedrock.
123
-forcePrompt: [parameter] Whatever parameter you specify, it will always prompt you, like it does now for invert and dim.
124
-logging: [t/f] If true, will record information about its mining run in a folder at the end of the mining run
125
-preciseTotals: [t/f] If true (and turtle.inspect exists), it will log a detailed record of every block the turtle mines and send it over rednet
126
-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...)
127
-saveFile: [word] This is what the backup file will be called
128
-logFolder: [word] The folder that quarry logs will be stored in
129
-logExtension: [word] The extension given to each quarry log (e.g. ".txt" or ".notepad" or whatever)
130
-keepOpen: [number] This is the number of the slots the turtle will make sure are open. It will check every time it mines
131
-careAboutResources: [t/f] Who cares about the materials! If set to false, it will just keep mining when its inventory is full
132
-startDown: [number] If you set this, the turtle will go down this many blocks from the start before starting its quarry
133
  =
134
  C _ |
135
      |
136
      |
137
      |
138
      |_ _ _ _ >
139
-flatBedrock: [t/f] If true, turtle will find bedrock and "zero" itself so it ends on bedrock level
140
-promptAll: This is the opposite of -Default, it prompts for everything
141
-listParams: This will list out all your selected parameters and end quarry. Good for testing
142
-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"
143
-version: Displays the current quarry version and stops the program
144
-help: Thats what this is :D
145
Examples: Everything below is examples and tips for use
146
Important Note:
147
  None of the above parameters are necessary. They all have default values, and the above are just if you want to change them.
148
Examples [1]:
149
  Want to just start a quarry from the interface, without going through menus? It's easy! Just use some parameters. Assume you called the program "quarry." To start a 10x6x3 quarry, you just type in "quarry -dim 10 6 3 -default".
150
  You just told it to start a quarry with dimensions 10x6x3, and "-default" means it won't prompt you about invert or rednet. Wasn't that easy?
151
Examples [2]:
152
  Okay, so you've got the basics of this now, so if you want, you can type in really long strings of stuff to make the quarry do exactly what you want. Now, say you want a 40x20x9, but you want it to go down to diamond level, and you're on the surface (at y = 64). You also want it to send rednet messages to your computer so you can see how its doing.
153
Examples [2] [cont.]:
154
  Oh yeah! You also want it to use an ender chest in slot 12 and restart if the server crashes. Yeah, you can do that. You would type
155
  "quarry -dim 40x20x9 -invert false -startDown 45 -rednet true -enderChest 12 -restore"
156
  BAM. Now you can just let that turtle do it's thing
157
Tips:
158
  The order of the parameters doesn't matter. "quarry -invert false -rednet true" is the same as "quarry -rednet true -invert false"
159
  
160
  Capitalization doesn't matter. "quarry -iNVErt FALSe" does the same thing as "quarry -invert false"
161
Tips [cont.]:
162
  For [t/f] parameters, you can also use "yes" and "no" so "quarry -invert yes"
163
  
164
  For [t/f] parameters, it only cares about the first letter. So you can use "quarry -invert t" or "quarry -invert y"
165
Tips [cont.]:
166
  If you are playing with fuel turned off, the program will automatically change settings for you so you don't have to :D
167
  
168
  If you want, you can load this program onto a computer, and use "quarry -help" so you can have help with the parameters whenever you want.
169
Internal Config:
170
  At the top of this program is an internal configuration file. If there is some setup that you use all the time, you can just change the config value at the top and run "quarry -default" for a quick setup.
171
  
172
  You can also use this if there are settings that you don't like the default value of.
173
]]
174
--NOTE: BIOS 114 MEANS YOU FORGOT A COLON
175
--NOTE: THIS ALSO BREAKS IF YOU REMOVE "REDUNDANT" WHITESPACE
176
--Parsing help for display
177
--[[The way the help table works:
178
All help indexes are numbered. There is a help[i].title that contains the title,
179
and the other lines are in help[i][1] - help[i][#help[i] ]
180
Different lines (e.g. other than first) start with a space.
181
As of now, the words are not wrapped, fix that later]]
182
local help = {}
183
local i = 0
184
local titlePattern = ".-%:" --Find the beginning of the line, then characters, then a ":"
185
local textPattern = "%:.+" --Find a ":", then characters until the end of the line
186
for a in help_paragraph:gmatch("\n?.-\n") do --Matches in between newlines
187
  local current = string.sub(a,1,-2).."" --Concatenate Trick
188
  if string.sub(current,1,1) ~= " " then
189
    i = i + 1
190
    help[i] = {}
191
    help[i].title = string.sub(string.match(current, titlePattern),1,-2)..""
192
    help[i][1] = string.sub(string.match(current,textPattern) or " ",3,-1)
193
  elseif string.sub(current,1,1) == " " then
194
    table.insert(help[i], string.sub(current,2, -1).."")
195
  end
196
end
197
198
local supportsRednet
199
if peripheral.find then
200
  supportsRednet = peripheral.find("modem") or false
201
else
202
  supportsRednet = (peripheral.getType("right") == "modem") or false
203
end
204
205
--Pre-defining variables that need to be saved
206
      xPos,yPos,zPos,facing,percent,mined,moved,relxPos, rowCheck, connected, isInPath, layersDone, attacked, startY, chestFull, gotoDest, atChest, fuelLevel, numDropOffs, allowedItems, compareSlots, dumpSlots, selectedSlot, extraDropItems, oldOreQuarry, specialSlots, relzPos, eventInsertionPoint, basicFuelChest
207
    = 0,   1,   1,   0,     0,      0,    0,    1,       true   ,  false,     true,     1,          0,        0,      false,     "",       false,   0,         0,           {},             {},           {},      1,            false,          false,        {explicit = {}},    0, 1,                     false
208
209
--These are slot options that need to exist as variables for parameters to work.
210
  enderChest, fuelChest, lavaBucket, compareChest
211
= false,      false,     false,      false
212
213
local chestID, lavaID, lavaMeta = "minecraft:chest", "minecraft:flowing_lava", 0
214
215
local statusString
216
217
--Initializing various inventory management tables
218
for i=1, inventoryMax do
219
  allowedItems[i] = 0 --Number of items allowed in slot when dropping items
220
  dumpSlots[i] = false --Does this slot contain junk items?
221
end --compareSlots is a table of the compare slots, not all slots with a condition
222
totals = {cobble = 0, fuel = 0, other = 0} -- Total for display (cannot go inside function), this goes up here because many functions use it
223
224
local function newSpecialSlot(index, value, explicit) --If isn't explicit, it will move whatever is already in the slot around to make room.
225
  value = tonumber(value) or 0 --We only want numerical indexes
226
  local flag = false --Used in slot moving, moved slot is returned for ease of use
227
  local function check(num) return num >= 1 and num <= inventoryMax end
228
  if not check(value) then error("from newSpecialSlot: number "..value.." out of range",2) end
229
  local function getFirstFree(start)
230
    for i=1, math.max(inventoryMax-value,value-1) do
231
      for a=-1,1,2 do
232
        local num = value + (a*i)
233
        if check(num) and not specialSlots[num] then return num end
234
      end
235
    end
236
    return false
237
  end
238
  if specialSlots[value] and specialSlots[value] ~= index then --If we aren't trying to override the same slot :P
239
    if not explicit then
240
      value = getFirstFree(value) or error("from newSpecialSlots: all slots full, could not add")
241
    elseif explicit and not specialSlots.explicit[value] then --Moving around other slots
242
      flag = getFirstFree(value)
243
      if not flag then error("from newSpecialSlots: could not add explicit in slot: "..index.." "..value.." Taken by "..specialSlots[value],2) end
244
      specialSlots[flag] = specialSlots[value]
245
      specialSlots[specialSlots[value]] = flag --These will get set to the new thing later
246
    else
247
      error('You cannot put a "'..index..'" in the same slot as a "'..specialSlots.explicit[value]..'" (Slot '..value..")",0) --Show the user an understandable error :)
248
    end
249
  end
250
  specialSlots[index] = value
251
  specialSlots[value] = index
252
  if explicit then
253
    specialSlots.explicit[value] = index
254
  end
255
  return value, flag
256
end
257
258
function resetDumpSlots()
259
    for i=1, inventoryMax do
260
      if oldOreQuarry then
261
        if turtle.getItemCount(i) > 0 and i~= specialSlots.enderChest then
262
          dumpSlots[i] = true
263
        else
264
          dumpSlots[i] = false
265
        end
266
      else
267
        dumpSlots[i] = false
268
      end
269
    end
270
    if not oldOreQuarry and specialSlots.enderChest == 1 then
271
      dumpSlots[2] = true
272
    elseif not oldOreQuarry then
273
      dumpSlots[1] = true
274
    end
275
end
276
277
local function copyTable(tab) if type(tab) ~= "table" then error("copyTable received "..type(tab)..", expected table",2) end local toRet = {}; for a, b in pairs(tab) do toRet[a] = b end; return toRet end --This goes up here because it is a basic utility
278
279
--NOTE: rowCheck is a bit. true = "right", false = "left"
280
281
local foundBedrock = false
282
283
local checkFuel, checkFuelLimit
284
if turtle then --Function inits
285
  checkFuel = turtle.getFuelLevel
286
  if turtle.getFuelLevel() == "unlimited" then --Fuel is disabled --Unlimited screws up my calculations
287
    checkFuel = function() return math.huge end --Infinite Fuel
288
  end --There is no "else" because it will already return the regular getFuel
289
  if turtle.getFuelLimit then
290
    checkFuelLimit = function() return math.min(turtle.getFuelLimit(), excessFuelAmount) end --Return the limiting one
291
    if turtle.getFuelLimit() == "unlimited" then
292
      checkFuelLimit = function() return math.huge end
293
    end
294
  else
295
    checkFuelLimit = function() return excessFuelAmount end --If the function doesn't exist
296
  end
297
298
299
  turtle.select(1) --To ensure this is correct
300
end
301
302
303
function select(slot)
304
  if slot ~= selectedSlot and slot > 0 and slot <= inventoryMax then
305
    selectedSlot = slot
306
    return turtle.select(slot), selectedSlot
307
  end
308
end
309
310
311
 -----------------------------------------------------------------
312
--Input Phase
313
local function screen(xPos,yPos)
314
xPos, yPos = xPos or 1, yPos or 1
315
term.setCursorPos(xPos,yPos); term.clear(); end
316
local function screenLine(xPos,yPos)
317
term.setCursorPos(xPos,yPos); term.clearLine(); end
318
319
screen(1,1)
320
print("----- Welcome to Quarry! -----")
321
print("")
322
323
local sides = {top = "top", right = "right", left = "left", bottom = "bottom", front = "front"} --Used to whitelist sides
324
local tArgs --Will be set in initializeArgs
325
local originalArgs = {...}
326
local changedT, tArgsWithUpper, forcePrompts = {}, {}, {}
327
changedT.new = function(key, value, name) table.insert(changedT,{key, value, name}); if name then changedT[name] = #changedT end end --Numeric list of lists
328
changedT.remove = function(num) changedT[num or #changedT].hidden = true end --Note actually remove, just hide :)
329
local function capitalize(text) return (string.upper(string.sub(text,1,1))..string.sub(text,2,-1)) end
330
local function initializeArgs()
331
  tArgs = copyTable(originalArgs) --"Reset" tArgs
332
  for i=1, #tArgs do --My signature key-value pair system, now with upper
333
    tArgsWithUpper[i] = tArgs[i]
334
    tArgsWithUpper[tArgsWithUpper[i]] = i
335
    tArgs[i] = tArgs[i]:lower()
336
    tArgs[tArgs[i]] = i
337
    if tArgs[i] == "-forceprompt" and i ~= #tArgs then --If the prompt exists then add it to the list of prompts
338
      forcePrompts[tArgs[i+1]:lower()] = true
339
    end
340
  end
341
end
342
initializeArgs()
343
344
local restoreFound, restoreFoundSwitch = false --Initializing so they are in scope
345
function parseParam(name, displayText, formatString, forcePrompt, trigger, variableOverride, variableExists) --Beware confusion, all ye who enter here
346
  --[[ Guide to Variables
347
    originalValue: what the variable was before the function
348
    givenValue: This is the value after the parameter. So -invert fAlSe, givenValue is "fAlSe"
349
  ]]
350
  if variableExists ~= false then variableExists = true end --Almost all params should have the variable exist. Some don't exist unless invoked
351
  if trigger == nil then trigger = true end --Defaults to being able to run
352
  if not trigger then return end --This is what the trigger is for. Will not run if trigger not there
353
  if restoreFoundSwitch or tArgs["-default"] then forcePrompt = false end --Don't want to prompt if these. Default is no variable because resuming
354
  if not restoreFoundSwitch and (tArgs["-promptall"] or forcePrompts[name:lower()]) then forcePrompt = true end --Won't prompt if resuming, can prompt all or checks list of prompts
355
  local toGetText = name:lower() --Because all params are now lowered
356
  local formatType = formatString:match("^%a+"):lower() or error("Format String Unknown: "..formatString) --Type of format string
357
  local args = formatString:match(" (.+)") or "".."" --Everything in formatString after the type
358
  local variable = variableOverride or name --Goes first to the override for name
359
  local func = loadstring("return "..variable) --Note to future self: If you want to remove loadstring, this breaks on tables. You will have to remove tables or figure something else out
360
  setfenv(func,getfenv(1))
361
  local originalValue = assert(func)() --This is the default value, for checking to add to changed table
362
  if originalValue == nil and variableExists then error("From addParam, \""..variable.."\" returned nil",2) end --I may have gotten a wrong variable name
363
  local givenValue, toRet, values --Initializing for use
364
  if tArgs["-"..toGetText] then
365
    givenValue = tArgsWithUpper[tArgs["-"..toGetText]+1] --This is the value after the desired parameter
366
  elseif forcePrompt then
367
    write(displayText.."? ")
368
    givenValue = io.read()
369
  end
370
  if formatType == "force" then --This is the one exception. Should return true if givenValue is nothing
371
    toRet = (tArgs["-"..toGetText] and true) or false --Will return true if param exists, otherwise false
372
  end
373
  if not (givenValue or toRet) or (type(givenValue) == "string" and #givenValue == 0) then return end --Don't do anything if you aren't given anything. Leave it as default, except for "force". Also don't want empty strings
374
  if formatType == "boolean" then --All the format strings will be basically be put through a switch statement
375
    toRet = givenValue:sub(1,1):lower() ~= "n" and givenValue:sub(1,1):lower() ~= "f" --Accepts anything but false or no
376
  elseif formatType == "string" then
377
    toRet = givenValue:match("^[%w%./]+") --Basically anything not a space or control character etc
378
  elseif formatType == "number" or formatType == "float" then
379
    toRet = tonumber(givenValue) --Note this is a local, not the above so we don't change anything
380
    if not toRet then return end --We need a number... Otherwise compare errors
381
    if formatType == "number" then toRet = math.floor(toRet) end --Get proper integers
382
    local startNum, endNum = formatString:match("(%d+)%-(%d+)") --Gets range of numbers
383
    startNum, endNum = tonumber(startNum), tonumber(endNum)
384
    if not ((toRet >= startNum) and (toRet <= endNum)) then return end --Can't use these
385
  elseif formatType == "side" then
386
    local exclusionTab = {} --Ignore the wizardry here. Just getting arguments without format string
387
    for a in args:gmatch("%S+") do exclusionTab[a] = true end --This makes a list of the sides to not include
388
    if not exclusionTab[givenValue] then toRet = sides[givenValue] end --If side is not excluded
389
  elseif formatType == "list" then
390
    toRet = {}
391
    for a in args:gmatch("[^,]") do
392
      table.insert(toRet,a)
393
    end
394
  elseif formatType == "slot" then
395
    if givenValue:sub(1,1):lower() == "n" or givenValue:sub(1,1):lower() == "f" then --Copied from boolean
396
      toRet = false
397
    else
398
      local userNumber, correction = givenValue:match("^%d+$") --This makes sure the value is a number | Locally initialize correction
399
      toRet, correction = newSpecialSlot(variable, tonumber(userNumber or args), userNumber) --If givenValue was "true", it won't be explicit and will use default number
400
      if correction then changedT[changedT[specialSlots[correction]]][2] = tostring(correction) end --This changes the value field of the changedT index taken from the named pointer (which is the value in specialSlots under correction)
401
    end
402
  elseif formatType == "force" then --Do nothing, everything is already done
403
  else error("Improper formatType",2)
404
  end
405
  if toRet == nil then return end --Don't want to set variables to nil... That's bad
406
  tempParam = toRet --This is what loadstring will see :D
407
  local func = loadstring(variable.." = tempParam")
408
  setfenv(func, getfenv(1)) --Note to future self: If you want to remove loadstring, this breaks on tables. You will have to remove tables or figure something else out
409
  func()
410
  tempParam = nil --Cleanup of global
411
  if toRet ~= originalValue and displayText ~= "" then
412
    changedT.new(displayText, tostring(toRet), variable)
413
  end
414
  return toRet
415
end
416
417
local paramLookup = {}
418
local function addParam(...)
419
  local args = {...}
420
  if not paramLookup[args[1]] then
421
    local toRet = copyTable(args)
422
    for i=2, table.maxn(toRet) do --Have to do this because table.remove breaks on nil
423
      toRet[i-1] = toRet[i]
424
    end
425
    table.remove(toRet)
426
    paramLookup[args[1]] = toRet
427
  end
428
  return parseParam(unpack(args, 1, table.maxn(args)))
429
end
430
431
local function paramAlias(original, alias)
432
  local a = paramLookup[original]
433
  if a then
434
    if a[5] == nil then a[5] = original end --This is variableOverride because the originals won't put a variable override
435
    return parseParam(alias, unpack(a, 1, table.maxn(a)))
436
  else
437
    error("In paramAlias: '"..original.."' did not exist",2)
438
  end
439
end
440
441
--Check if it is a turtle
442
if not(turtle or tArgs["help"] or tArgs["-help"] or tArgs["-?"] or tArgs["?"]) then --If all of these are false then
443
  print("This is not a turtle, you might be looking for the \"Companion Rednet Program\" \nCheck My forum thread for that")
444
  print("Press 'q' to quit, or any other key to start help ")
445
  if ({os.pullEvent("char")})[2] ~= "q" then tArgs.help = true else error("",0) end
446
end
447
448
if tArgs["help"] or tArgs["-help"] or tArgs["-?"] or tArgs["?"] then
449
  print("You have selected help, press any key to continue"); print("Use arrow keys to navigate, q to quit"); os.pullEvent("key")
450
  local pos = 1
451
  local key = 0
452
  while pos <= #help and key ~= keys.q do
453
    if pos < 1 then pos = 1 end
454
    screen(1,1)
455
    print(help[pos].title)
456
    for a=1, #help[pos] do print(help[pos][a]) end
457
    repeat
458
      _, key = os.pullEvent("key")
459
    until key == 200 or key == 208 or key == keys.q
460
    if key == 200 then pos = pos - 1 end
461
    if key == 208 then pos = pos + 1 end
462
  end
463
  error("",0)
464
end
465
466
if tArgs["-version"] or tArgs["version"] then
467
  print("QUARRY VERSION: ",VERSION)
468
  error("",0) --Exit not so gracefully
469
end
470
471
--Loading custom parameter lists
472
local function split(str, sep)
473
  assert(#sep == 1, "Split seperator too long. Got '"..sep.."'")
474
  if not str:match(sep) then return {str} end --So everything else isn't pointless
475
  local toRet = {}
476
  toRet[1] = str:match("^([^"..sep.."]-)"..sep)
477
  for i in str:gmatch(sep.."([^"..sep.."]*)") do --Matches not seperator chars
478
    toRet[#toRet+1] = i
479
  end
480
  return toRet
481
end
482
483
if addParam("file","Custom Parameters","string", false, nil, "parameterFile", false) and parameterFile then --This will not load when resuming because there is no "file" parameter when resuming.
484
  if not fs.exists(parameterFile) then
485
    print("WARNING: '"..parameterFile.."' DOES NOT EXIST. FILE NOT LOADED")
486
    sleep(3)
487
    changedT.remove()
488
  else
489
    local file = fs.open(parameterFile, "r")
490
    local text = file.readAll()
491
    file.close()
492
    text = text.."\n" --So that all replacements work properly
493
    text = text:gsub("#[^\n]-\n","") --Replace program codes/comment lines+
494
    local commands = {} --Contains all the parameters
495
    local append = table.insert
496
    for _, a in pairs(split(text,"\n")) do
497
      local words = split(a," ")
498
      if not a:match("-") then --This means only one command per line
499
        append(originalArgs,"-"..words[1])
500
        for i=2, #words do
501
          append(originalArgs, words[i])
502
        end
503
      else --Otherwise the dashes are already ordered where we want!
504
        for i=1, #words do
505
          append(originalArgs, words[i])
506
        end
507
      end
508
    end
509
    initializeArgs() --Manipulate the args again, because we modified them
510
    print("Finished loading file: ",tArgs[tArgs["-file"]+1])
511
    sleep(0.5) --Give em a sec
512
  end
513
end
514
515
516
517
--Saving
518
addParam("doBackup", "Backup Save File", "boolean")
519
addParam("saveFile", "Save File Name", "string")
520
521
restoreFound = fs.exists(saveFile)
522
restoreFoundSwitch = (tArgs["-restore"] or tArgs["-resume"] or tArgs["-atchest"]) and restoreFound and doBackup
523
if restoreFoundSwitch then
524
  local file = fs.open(saveFile,"r")
525
  local test = file.readAll() ~= ""
526
  file.close()
527
  if test then
528
    local temp = shell and copyTable(shell) --For whatever reason, the shell table doesn't survive resuming. shell and ... so that copyTable doesn't error
529
    os.run(getfenv(1),saveFile) --This is where the actual magic happens
530
    shell = temp
531
    numResumed = numResumed + 1
532
    if checkFuel() ~= math.huge then --If turtle uses fuel
533
      if fuelLevel - checkFuel() == 1 then
534
        if facing == 0 then xPos = xPos + 1
535
        elseif facing == 2 then xPos = xPos - 1
536
        elseif facing == 1 then zPos = zPos + 1
537
        elseif facing == 3 then zPos = zPos - 1 end
538
      elseif fuelLevel - checkFuel() ~= 0 then
539
        print("Very Strange Fuel in Restore Section...")
540
        print("Current: ",checkFuel())
541
        print("Saved: ",fuelLevel)
542
        print("Difference: ",fuelLevel - checkFuel())
543
        os.pullEvent("char")
544
      end
545
     end
546
    if gpsEnabled then --If it had saved gps coordinates
547
      print("Found GPS Start Coordinates")
548
      local currLoc = {gps.locate(gpsTimeout)} or {}
549
      local backupPos = {xPos, yPos, zPos} --This is for comparing to later
550
      if #currLoc > 0 and #gpsStartPos > 0 and #gpsSecondPos > 0 then --Cover all the different positions I'm using
551
        print("GPS Position Successfully Read")
552
        if currLoc[1] == gpsStartPos[1] and currLoc[3] == gpsStartPos[3] then --X coord, y coord, z coord in that order
553
          xPos, yPos, zPos = 0,1,1
554
          if facing ~= 0 then turnTo(0) end
555
          print("Is at start")
556
        else
557
          if inverted then --yPos setting
558
          ------------------------------------------------FIX THIS
559
          end
560
          local a, b = copyTable(gpsStartPos), copyTable(gpsSecondPos) --For convenience
561
          local flag = true --So we can account for left quarry
562
          if b[3] - a[3] == -1 then--If went north (-Z)
563
            a[1] = a[1] - 1 --Shift x one to west to create a "zero"
564
            xPos, zPos = -currLoc[3] + a[3], currLoc[1] + -a[1]
565
          elseif b[1] - a[1] == 1 then--If went east (+X)
566
            a[3] = a[3] - 1 --Shift z up one to north to create a "zero"
567
            xPos, zPos = currLoc[1] + -a[1], currLoc[3] + -a[3]
568
          elseif b[3] - a[3] == 1 then--If went south (+Z)
569
            a[1] = a[1] + 1 --Shift x one to east to create a "zero"
570
            xPos, zPos = currLoc[3] + a[3], -currLoc[1] + a[3]
571
          elseif b[1] - a[1] == -1 then--If went west (-X)
572
            a[3] = a[3] + 1 --Shift z down one to south to create a "zero"
573
            xPos, zPos = -currLoc[1] + a[1], -currLoc[3] + a[3]
574
          else
575
            flag = false
576
            print("Improper Coordinates")
577
            print("GPS Locate Failed, Using Standard Methods")        ----Maybe clean this up a bit to use flags instead.
578
          end
579
          if flag and goLeftNotRight then --This accounts for left quarry (barred to left only because there might be errors in a regular, causing neg/0
580
            zPos = math.abs(zPos-1) + 1
581
          end
582
        end
583
        print("X Pos: ",xPos)
584
        print("Y Pos: ",yPos)
585
        print("Z Pos: ",zPos)
586
        print("Facing: ",facing)
587
        for i=1, 3, 2 do --We want 1 and 3, but 2 could be coming back to start.
588
          if backupPos[i] ~= currLoc[i] then
589
            events = {} --We want to remove event queue if not in proper place, so won't turn at end of row or things.
590
          end
591
        end
592
      else
593
        print("GPS Locate Failed, Using Standard Methods")
594
      end
595
    print("Restore File read successfully. Starting in 3"); sleep(3)
596
    end
597
  else
598
    fs.delete(saveFile)
599
    print("Restore file was empty, sorry, aborting")
600
    error("",0)
601
  end
602
else --If turtle is just starting
603
  events = {} --This is the event queue :D
604
  originalFuel = checkFuel() --For use in logging. To see how much fuel is REALLY used
605
end
606
607
--Dimensions
608
if tArgs["-dim"] then
609
  local a,b,c = x,y,z
610
  local num = tArgs["-dim"]
611
  x = tonumber(tArgs[num + 1]) or x; z = tonumber(tArgs[num + 2]) or z; y = tonumber(tArgs[num + 3]) or y
612
  if a ~= x then changedT.new("Length", x) end
613
  if c ~= z then changedT.new("Width", z) end
614
  if b ~= y then changedT.new("Height", y) end
615
elseif not (tArgs["-default"] or restoreFoundSwitch) then
616
  print("What dimensions?")
617
  print("")
618
  --This will protect from negatives, letters, and decimals
619
  term.write("Length? ")
620
  x = math.floor(math.abs(tonumber(io.read()) or x))
621
  term.write("Width? ")
622
  z = math.floor(math.abs(tonumber(io.read()) or z))
623
  term.write("Height? ")
624
  y = math.floor(math.abs(tonumber(io.read()) or y))
625
  changedT.new("Length",x); changedT.new("Width",z); changedT.new("Height",y)
626
end
627
--Params: parameter/variable name, display name, type, force prompt, boolean condition, variable name override
628
--Invert
629
addParam("flatBedrock","Go to bedrock", "boolean") --Not done before GPS because GPS only runs on restart
630
addParam("invert", "Inverted","boolean", true, not flatBedrock, "inverted") --Not flat bedrock, because invert will be set to false
631
addParam("startDown","Start Down","number 1-256", nil, not flatBedrock)
632
addParam("left","Left Quarry","boolean", nil, nil, "goLeftNotRight")
633
--Inventory
634
addParam("chest", "Chest Drop Side", "side front", nil, nil, "dropSide")
635
addParam("enderChest","Ender Chest Slot","slot 16") --Note: All slots can be 16 and they will auto-assign, but I feel it is less confusing if they are always the same
636
addParam("fuelChest","Fuel Chest Slot","slot 15")
637
addParam("basicFuelChest","Basic Fuel Chest","side left")
638
--Rednet
639
addParam("rednet", "Rednet Enabled","boolean",true, supportsRednet, "rednetEnabled")
640
addParam("sendChannel", "Rednet Send Channel", "number 1-65535", false, supportsRednet, "channels.send")
641
addParam("receiveChannel","Rednet Receive Channel", "number 1-65535", false, supportsRednet, "channels.receive")
642
addParam("fingerprint","Sending Fingerprint", "string", false, supportsRednet, "channels.fingerprint")
643
addParam("legacyRednet","Legacy Rednet","boolean", false, supportsRednet)
644
--Quad Rotor --Must be before GPS
645
if addParam("quad", "Quad Rotor Enabled","boolean",nil, rednetEnabled, "quadEnabled") then --This returns true if param found :3
646
  gpsEnabled = true
647
end
648
addParam("quadTimeout","Quad Rotor Timeout","number 1-1000000", nil, quadEnabled) --The amount of time to wait for a quadRotor
649
--GPS
650
addParam("gps", "GPS Location Services", "force", nil, (not restoreFoundSwitch) and supportsRednet and not quadEnabled, "gpsEnabled" ) --Has these triggers so that does not record position if restarted.
651
if gpsEnabled and not restoreFoundSwitch then
652
  gpsStartPos = {gps.locate(gpsTimeout)} --Stores position in array
653
  gpsEnabled = #gpsStartPos > 0 --Checks if location received properly. If not, position is not saved
654
  if quadEnabled and not gpsEnabled then
655
    error("You have no GPS network. You may not use Quad Rotors",0)
656
  end
657
end
658
--Fuel
659
addParam("uniqueExtras","Unique Items", "number 0-15")
660
addParam("doRefuel", "Refuel from Inventory","boolean", nil, checkFuel() ~= math.huge) --math.huge due to my changes
661
addParam("doCheckFuel", "Check Fuel", "boolean", doCheckFuel and fuelChest, checkFuel() ~= math.huge) --Will prompt if doCheckFuel and fuelChest are on. Probably don't want
662
excessFuelAmount = excessFuelAmount or math.huge --Math.huge apparently doesn't save properly (Without saving, this is the config, on save it is actually set to nil if math.huge)
663
addParam("maxFuel", "Max Fuel", "number 1-999999999", maxFuel == checkFuelLimit() and fuelChest, checkFuel() ~= math.huge, "excessFuelAmount") --Will prompt if fuel chest and the limit isn't changed
664
addParam("fuelMultiplier", "Fuel Multiplier", "float 1-9001", nil, checkFuel() ~= math.huge)
665
paramAlias("fuelMultiplier","fuelRequestMultiplier")
666
paramAlias("fuelMultiplier","overFuel")
667
--Logging
668
addParam("logging", "Logging", "boolean")
669
addParam("logFolder", "Log Folder", "string")
670
addParam("logExtension","Log Extension", "string")
671
--Misc
672
addParam("startY", "Start Y","number 1-256")
673
addParam("maxTries","Tries Before Bedrock", "number 1-9001")
674
--Inventory
675
addParam("keepOpen", "Slots to Keep Open", "number 1-15")
676
addParam("careAboutResources", "Care About Resources","boolean")
677
addParam("preciseTotals","Precise Totals","boolean", rednetEnabled and turtle.inspect, turtle.getItemDetail ~= nil)
678
if preciseTotals and not restoreFoundSwitch then
679
  exactTotals = {} --Don't want to initialize if we aren't using this
680
end
681
--Auto Startup
682
addParam("autoResume", "Auto Resume", "boolean", nil, doBackup)
683
paramAlias("autoResume","autoRestart")
684
addParam("startupRename", "Startup Rename","string", nil, autoResume)
685
addParam("startupName", "Startup File", "string", nil, autoResume)
686
--Ore Quarry
687
addParam("oreQuarry", "Ore Quarry", "boolean" )
688
if oreQuarry and not turtle.inspect then
689
  oldOreQuarry = true
690
  oreQuarry = false
691
end
692
addParam("lavaBucket","Lava Bucket Slot", "slot 14", nil, oreQuarry)
693
paramAlias("lavaBucket","lava")
694
paramAlias("lavaBucket","lavaRefuel")
695
addParam("lavaBuffer","Lava Buffer","number 1-19999", nil, lavaBucket)
696
--Old Ore
697
addParam("oldOreQuarry", "Old Ore Quarry", "boolean")
698
addParam("dumpCompareItems", "Dump Compare Items", "boolean", nil, oldOreQuarry) --Do not dump compare items if not oreQuarry
699
addParam("extraDropItems", "", "force", nil, oldOreQuarry) --Prompt for extra dropItems
700
paramAlias("extraDropItems","extraDumpItems") --changed to Dump
701
addParam("compareChest","Compare Chest Slot","slot 13", nil, oldOreQuarry)
702
addParam("frontChest","Front Chest Check","boolean", nil, compareChest or turtle.insepect) --Does not need oreQuarry, but is similar (does need inspect if not compareChest)
703
--New Ore
704
addParam("blacklist","Ore Blacklist", "string", nil, oreQuarry, "oreQuarryBlacklistName")
705
paramAlias("blacklist","blacklistFile")
706
--Mod Related
707
708
--Extra
709
if tArgs["-testparams"] then
710
  screen()
711
  print("KEY: VALUE (VARIABLE)")
712
  for key, val in ipairs(changedT) do
713
    if not val.hidden then
714
      print(val[1],": ",val[2],"  (",val[3] or "",")")
715
    end
716
  end
717
  error("Done",0)
718
end
719
  
720
721
--for flatBedrock
722
if flatBedrock then
723
  inverted = false
724
end
725
726
--Auto Startup functions
727
local function doAutoResumeStuff()
728
  if fs.exists(startupName) then
729
    if fs.exists(startupRename) then fs.delete(startupRename) end
730
    fs.move(startupName, startupRename)
731
  end
732
  local file = fs.open(startupName,"w") --Startup File
733
  file.writeLine( --The below is on the left because spacing
734
[[
735
--This is an auto-generated startup
736
--Made by civilwargeeky's Variable Size Quarry
737
print("Now Resuming Quarry")
738
print("Press any key to quit. You have 5 seconds.")
739
function deleteStuff()
740
  fs.delete("]]..startupName..[[")
741
  if fs.exists("]]..startupRename..[[") then
742
    fs.move("]]..startupRename.."\",\""..startupName..[[")
743
  end
744
end
745
local event
746
if fs.exists("]]..saveFile..[[") then
747
  for i=5,1,-1 do
748
    print(i)
749
    os.startTimer(1)
750
    event = os.pullEvent()
751
    if event == "key" then break end
752
  end
753
  if event == "timer" then
754
    os.run({},"]]..shell.getRunningProgram()..[[","-resume")
755
  else
756
757
    deleteStuff()
758
  end
759
else
760
  print("Never mind, no save file found")
761
  deleteStuff()
762
end
763
  ]])
764
  file.close()
765
end
766
if autoResume and not restoreFoundSwitch then --Don't do for restore because would overwrite renamed thing. Can't edit mid-run because no shell in restarted
767
  doAutoResumeStuff()
768
end
769
--oreQuarry blacklist
770
local blacklist = { "minecraft:air",  "minecraft:bedrock", "minecraft:cobblestone", "minecraft:dirt", "minecraft:ice", "minecraft:ladder", "minecraft:netherrack", "minecraft:sand", "minecraft:sandstone",
771
  "minecraft:snow", "minecraft:snow_layer", "minecraft:stone", "minecraft:gravel", "minecraft:grass", "minecraft:torch" }
772
for a,b in pairs(copyTable(blacklist)) do
773
  blacklist[b], blacklist[a] = true, nil --Switch
774
end
775
if fs.exists(oreQuarryBlacklistName) then --Loading user-defined blacklist
776
  local file = fs.open(oreQuarryBlacklistName, "r")
777
  blacklist = {}
778
  for a in file:readAll():gmatch("[^,\n]+") do
779
    blacklist[a:match("[%w_.]+:[%w_.]+")] = true --Grab only the actual characters, not whitespaces
780
  end
781
  file:close()
782
end
783
784
--Manual Position
785
if tArgs["-manualpos"] then --Gives current coordinates in xPos,zPos,yPos, facing
786
  local a = tArgs["-manualpos"]
787
  xPos, zPos, yPos, facing = tonumber(tArgs[a+1]) or xPos, tonumber(tArgs[a+2]) or zPos, tonumber(tArgs[a+3]) or yPos, tonumber(tArgs[a+4]) or facing
788
  changedT.new("xPos",xPos); changedT.new("zPos",zPos); changedT.new("yPos",yPos); changedT.new("facing",facing)
789
  restoreFoundSwitch = true --So it doesn't do beginning of quarry behavior
790
  for i=0,4 do tArgs[a+i] = "" end --Get rid of this argument from future restores
791
end
792
if addParam("atChest", "Is at Chest", "force") then --This sets position to 0,1,1, facing forward, and queues the turtle to go back to proper row.
793
  local neededLayer = math.floor((yPos+1)/3)*3-1 --Make it a proper layer, +- because mining rows are 2, 5, etc.
794
  if neededLayer > 2 and neededLayer%3 ~= 2 then --If turtle was not on a proper mining layer
795
    print("Last known pos was not in proper layer, restarting quarry")
796
    sleep(4)
797
    neededLayer = 2
798
  end
799
  xPos, zPos, yPos, facing, rowCheck, layersDone = 0,1,1, 0, true, math.ceil(neededLayer/3)
800
  doAutoResumeStuff() --This was probably deleted when they hit a key to launch with -atChest
801
  events = {{"goto",1,1,neededLayer, 0}}
802
end
803
804
805
local function saveProgress(extras) --Session persistence
806
exclusions = { modem = true, shell = true, _ENV = true}
807
if doBackup then
808
local toWrite = ""
809
for a,b in pairs(getfenv(1)) do
810
  if not exclusions[a] then
811
      --print(a ,"   ", b, "   ", type(b)) --Debug
812
    if type(b) == "string" then b = "\""..b.."\"" end
813
    if type(b) == "table" then b = textutils.serialize(b) end
814
    if type(b) ~= "function" then
815
      toWrite = toWrite..a.." = "..tostring(b).."\n"
816
    end
817
  end
818
end
819
toWrite = toWrite.."doCheckFuel = false\n" --It has already used fuel, so calculation unnecessary
820
local file
821
repeat
822
  file = fs.open(saveFile,"w")
823
until file
824
file.write(toWrite)
825
if type(extras) == "table" then
826
  for a, b in pairs(extras) do
827
    file.write(a.." = "..tostring(b).."\n")
828
  end
829
end
830
if checkFuel() ~= math.huge then --Used for location comparing
831
  file.write("fuelLevel = "..tostring(checkFuel()).."\n")
832
end
833
file.close()
834
end
835
end
836
837
local area = x*z
838
local volume = x*y*z
839
local lastHeight = y%3
840
layers = math.ceil(y/3)
841
local yMult = layers --This is basically a smart y/3 for movement
842
local moveVolume = (area * yMult) --Kept for display percent
843
--Calculating Needed Fuel--
844
do --Because many local variables unneeded elsewhere
845
  local changeYFuel = 2*(y + startDown)
846
  local dropOffSupplies = 2*(x + z + y + startDown) --Assumes turtle as far away as possible, and coming back
847
  local frequency = math.ceil(((moveVolume/(64*(15-uniqueExtras) + uniqueExtras)) ) ) --This is complicated: volume / inventory space of turtle, defined as 64*full stacks + 1 * unique stacks.
848
                                                                                     --max of 15 full stacks because once one item is picked up, slot is "full". Ceil to count for initial back and forth
849
  if enderChest then frequency = 0 end --Never goes back to start
850
  neededFuel = moveVolume + changeYFuel + (frequency * dropOffSupplies) + ((x + z) * layers) --x + z *layers because turtle has to come back from far corner every layer
851
  neededFuel = neededFuel + fuelTable[fuelSafety] --For safety
852
end
853
854
if neededFuel > checkFuelLimit() and doCheckFuel then--Checks for if refueling goes over turtle fuel limit
855
  if not (doRefuel or fuelChest) then
856
    screen()
857
    print("Turtle cannot hold enough fuel\n")
858
    print("Options: \n1. Select a smaller size \n2. Enable Mid-Run Refueling (RECOMMENDED) \n3. Turn fuel checking off (only if fuel chest) \n4. Do nothing")
859
    local _, key = os.pullEvent("char")
860
    if key == "1" then
861
      screen(); print("Okay"); error("",0)
862
    elseif key == "3" then
863
      doCheckFuel = false
864
    elseif key == "4" then
865
      --pass
866
    else --Not for number two because this is default
867
      doRefuel = true
868
    end
869
  end
870
  neededFuel = checkFuelLimit()-checkFuel()-1
871
end
872
873
874
--Getting Fuel
875
local hasRefueled --This is for oldOreQuarry prompting
876
if doCheckFuel and checkFuel() < neededFuel then
877
  neededFuel = math.min(math.floor(neededFuel * fuelMultiplier), checkFuelLimit()-checkFuel()-1) --Does the same as above, but not verbose because optional
878
  hasRefueled = true
879
  print("Not enough fuel")
880
  print("Current: ",checkFuel()," Needed: ",neededFuel)
881
  print("Starting SmartFuel...")
882
  sleep(2) --So they can read everything.
883
  term.clear()
884
  local oneFuel, neededFuelItems = 0,0 --Initializing Variables
885
  local currSlot = 0
886
  local function output(text, x, y) --For displaying fuel statistics
887
    local currX, currY = term.getCursorPos()
888
    term.setCursorPos(x,y)
889
    term.clearLine()
890
    term.write(text)
891
    term.setCursorPos(currX,currY)
892
  end
893
  local function roundTo(num, target) --For stacks of fuel and turtle slots when undergoing addition/subtraction
894
    if num >= target then return target elseif num < 0 then return 0 else return num end
895
  end
896
  local function updateScreen()
897
    output("Welcome to SmartFuel! Now Refueling...", 1,1)
898
    output("Fuel Request Multiplier: "..tostring(fuelMultiplier).."x",1,2)
899
    output("Currently taking fuel from slot "..currSlot,1,3)
900
    output("Current single fuel: "..tostring(oneFuel or 0),1,4)
901
    output("Current estimate of needed fuel: ",1,4)
902
    output("Single Items: "..math.ceil(neededFuelItems),4,6)
903
    output("Stacks:       "..math.ceil(neededFuelItems / 64),4,7)
904
    output("Needed Fuel: "..tostring(neededFuel),1,12)
905
    output("Current Fuel: "..tostring(checkFuel()),1,13)
906
  end
907
  while checkFuel() < neededFuel do
908
    currSlot = currSlot + 1
909
    select(currSlot)
910
    if currSlot ~= 1 and not turtle.refuel(0) then --If it's not the first slot, and not fuel, go back to start
911
      currSlot = 1; select(currSlot)
912
    end
913
    updateScreen()
914
    while turtle.getItemCount(currSlot) == 0 do
915
      sleep(1.5)
916
    end
917
    repeat --TODO: Probably unnecessary loop, remove later
918
      local previous = checkFuel()
919
      turtle.refuel(1)
920
      oneFuel = checkFuel() - previous
921
      updateScreen()
922
    until (oneFuel or 0) > 0 --Not an if to prevent errors if fuel taken out prematurely.
923
    neededFuelItems = math.ceil((neededFuel - checkFuel()) / oneFuel)
924
    turtle.refuel(roundTo(neededFuelItems, 64)) --Change because can only think about 64 at once.
925
    if turtle.getItemCount(roundTo(currSlot + 1, inventoryMax)) == 0 then --Resets if no more fuel
926
      currSlot = 0
927
    end
928
    neededFuelItems = math.ceil((neededFuel - checkFuel()) / oneFuel) --This line is not repeated uselessly, it's for the display function
929
  end
930
  select(1)
931
end
932
--Ender Chest Obtaining
933
function promptSpecialSlot(specialSlot, name, limit)
934
  local function isInRange(toCheck, lower, upper) return toCheck <= upper and toCheck >= lower end
935
  while not isInRange(turtle.getItemCount(specialSlots[specialSlot]), 1, limit or 1) do
936
    screen(1,1)
937
    print("You have decided to use a ",name,"!")
938
    print("Please place one ",name," in slot ",specialSlots[specialSlot])
939
    sleep(1)
940
  end
941
  print(name," in slot ",specialSlots[specialSlot], " checks out")
942
end
943
function checkSpecialSlot(specialSlot, name, allowed)
944
 if restoreFoundSwitch and turtle.getItemCount(specialSlots[specialSlot]) == 0 then --If the turtle was stopped while dropping off items.
945
    select(specialSlots[specialSlot])
946
    turtle.dig()
947
    select(1)
948
  end
949
  promptSpecialSlot(specialSlot, name, allowed)
950
  allowedItems[specialSlots[specialSlot]] = 1
951
  sleep(1)
952
end
953
if enderChest then
954
  checkSpecialSlot("enderChest","Ender Chest")
955
end
956
if fuelChest then
957
  checkSpecialSlot("fuelChest","Fuel Chest")
958
end
959
if lavaBucket then
960
  checkSpecialSlot("lavaBucket","Empty Bucket")
961
  select(specialSlots.lavaBucket)
962
  if turtle.refuel(1) then --Just in case they actually put in a lava bucket >:(
963
    print("No! You're supposed to put in an empty bucket") --This doubles as emptying the lava bucket if mid-run
964
    sleep(2)
965
  end
966
  select(1)
967
end
968
if compareChest then
969
  checkSpecialSlot("compareChest","Chest", 64)
970
end
971
972
--Setting which slots are marked as compare slots
973
if oldOreQuarry then
974
  if not restoreFoundSwitch then --We don't want to reset compare blocks every restart
975
    local counter = 0
976
    for i=1, inventoryMax do if turtle.getItemCount(i) > 0 and not specialSlots[i] then counter = counter+1 end end --If the slot has items, but isn't enderChest slot if it is enabled
977
978
    screen(1,1)
979
    print("You have selected an Ore Quarry!")
980
    if counter == 0 or hasRefueled then --If there are no compare slots, or the turtle has refueled, and probably has fuel in inventory
981
      print("Please place your compare blocks in the first slots\n")
982
983
      print("Press Enter when done")
984
      repeat until ({os.pullEvent("key")})[2] == 28 --Should wait for enter key to be pressed
985
    else
986
      print("Registering slots as compare slots")
987
      sleep(1)
988
    end
989
    for i=1, inventoryMax do
990
      if turtle.getItemCount(i) > 0 then
991
        if not specialSlots[i] then
992
          table.insert(compareSlots, i) --Compare slots are ones compared to while mining. Conditions are because we Don't want to compare to enderChest
993
          allowedItems[i] = 1 --Blacklist is for dropping off items. The number is maximum items allowed in slot when dropping off
994
          dumpSlots[i] = true --We also want to ignore all excess of these items, like dirt
995
        end
996
      end
997
    end
998
    if extraDropItems then
999
      screen(1,1)
1000
      print("Put in extra drop items now\n")
1001
      print("Press Enter when done")
1002
      repeat until ({os.pullEvent("key")})[2] == 28 --Should wait for enter key to be pressed
1003
      for i=1,inventoryMax do
1004
        if not dumpSlots[i] and turtle.getItemCount(i) > 0 then --I don't want to modify from above, so I check it hasn't been assigned.
1005
          dumpSlots[i] = true
1006
          allowedItems[i] = 1
1007
        end
1008
      end
1009
    end
1010
    --This is could go very wrong if this isn't here
1011
    if #compareSlots >= inventoryMax-keepOpen then screen(1,1); error("You have more quarry compare items than keep open slots, the turtle will continuously come back to start. Please fix.",0) end
1012
  end
1013
  local counter = 0
1014
  for a, b in pairs(compareSlots) do if  turtle.getItemCount(b) > 0 then counter = counter + 1 end end
1015
  if counter == 0 then
1016
    screen(1,1)
1017
    print("You have an ore quarry without any compare slots. Continue? y/n")
1018
    if ({os.pullEvent("char")})[2] ~= "y" then error("",0) end
1019
  end
1020
elseif not oreQuarry then --This was screwing up dumpCompareItems
1021
  dumpCompareItems = false --If not an ore quarry, this should definitely be false
1022
  if specialSlots.enderChest == 1 then
1023
    dumpSlots[2] = true
1024
  else
1025
    dumpSlots[1] = true
1026
  end
1027
end
1028
1029
--Rednet Handshake
1030
function newMessageID()
1031
  return math.random(1,2000000000)
1032
end
1033
function sendMessage(send, receive, message)
1034
  if legacyRednet then
1035
    if type(message) == "table" then message = textutils.serialize(message) end
1036
    return modem.transmit(send, receive, message)
1037
  end
1038
  return modem.transmit(send , receive, {fingerprint = channels.fingerprint, id = newMessageID(), message = message})
1039
end
1040
if rednetEnabled then
1041
  screen(1,1)
1042
  print("Rednet is Enabled")
1043
  print("The Channel to open is "..channels.send)
1044
  if peripheral.find then
1045
    modem = peripheral.find("modem")
1046
  else
1047
    modem = peripheral.wrap("right")
1048
  end
1049
  modem.open(channels.receive)
1050
  local i = 0
1051
    repeat
1052
      local id = os.startTimer(3)
1053
      i=i+1
1054
      print("Sending Initial Message "..i)
1055
      sendMessage(channels.send, channels.receive, channels.message)
1056
      local message = {} --Have to initialize as table to prevent index nil
1057
      repeat
1058
        local event, idCheck, channel,_,locMessage, distance = os.pullEvent()
1059
        if locMessage then message = locMessage end
1060
        if legacyRednet then --For that one guy that uses 1.4.7
1061
          message = {message = message}
1062
        end
1063
      until (event == "timer" and idCheck == id) or (event == "modem_message" and channel == channels.receive and type(message) == "table")
1064
    until message.message == channels.confirm
1065
  connected = true
1066
  print("Connection Confirmed!")
1067
  sleep(1.5)
1068
end
1069
function biometrics(isAtBedrock, requestQuad)
1070
  if not rednetEnabled then return end --This function won't work if rednet not enabled :P
1071
  local toSend = { label = os.getComputerLabel() or "No Label", id = os.getComputerID(),
1072
    percent = percent, zPos = relzPos, xPos = relxPos, yPos = yPos,
1073
    layersDone = layersDone, x = x, z = z, layers = layers,
1074
    openSlots = getNumOpenSlots(), mined = mined, moved = moved,
1075
    chestFull = chestFull, isAtChest = (xPos == 0 and yPos == 1 and zPos == 1),
1076
    isGoingToNextLayer = (gotoDest == "layerStart"), foundBedrock = foundBedrock,
1077
    fuel = checkFuel(), volume = volume, status = statusString,
1078
    }
1079
  if requestQuad and isInPath then --If we are requesting a quadRotor to send help
1080
    if not gps.locate(gpsTimeout) then
1081
      print("\nOH NOES! Trying to reach quadrotor, but can't get GPS position!")
1082
      sleep(1)
1083
    else
1084
      toSend.firstPos = gpsStartPos
1085
      toSend.secondPos = gpsSecondPos
1086
      toSend.emergencyLocation = {gps.locate(gpsTimeout)}
1087
    end
1088
  end
1089
  sendMessage(channels.send, channels.receive, toSend)
1090
  id = os.startTimer(0.1)
1091
  local event, received
1092
  repeat
1093
    local locEvent, idCheck, confirm, _, locMessage, distance = os.pullEvent()
1094
    event, received = locEvent, locMessage or {message = ""}
1095
    if legacyRednet and type(received) == "string" then
1096
      received = {message = received}
1097
    end
1098
  until (event == "timer" and idCheck == id) or (event == "modem_message" and confirm == channels.receive and type(received) == "table")
1099
  if event == "modem_message" then connected = true else connected = false end
1100
  local message = received.message:lower()
1101
  if message == "stop" or message == "quit" or message == "kill" then
1102
    count(true)
1103
    display()
1104
    error("Rednet said to stop...",0)
1105
  end
1106
  if message == "return" then
1107
    endingProcedure()
1108
    error('Rednet said go back to start...',0)
1109
  end
1110
  if message == "drop" then
1111
    dropOff()
1112
  end
1113
  if message == "pause" then
1114
    print("\nTurtle is paused. Send 'resume' or press any character to resume")
1115
    statusString = "Paused"
1116
    toSend.status = statusString
1117
    os.startTimer(3)
1118
    repeat --The turtle sends out periodic messages, which will clear the receiver's queue and send a message (if it exists)
1119
     --This may be a bit overkill, sending the whole message again, but whatever.
1120
      local event, idCheck, confirm, _, message, distance = os.pullEvent()
1121
      if event == "timer" then os.startTimer(3); sendMessage(channels.send, channels.receive, toSend) end --Only send messages on the timer. This prevents ridiculous spam
1122
    until (event == "modem_message" and confirm == channels.receive and (message.message == "resume" or message.message == "unpause" or message.message == "pause")) or (event == "char")
1123
    statusString = nil
1124
  end
1125
  if message == "refuel" then
1126
    print("\nEngaging in emergency refueling")
1127
    emergencyRefuel(true)
1128
  end
1129
1130
end
1131
--Showing changes to settings
1132
screen(1,1)
1133
print("Your selected settings:")
1134
if #changedT == 0 then
1135
  print("Completely Default")
1136
  else
1137
  for i=1, #changedT do
1138
    if not changedT[i].hidden then
1139
      print(changedT[i][1],": ",changedT[i][2]) --Name and Value
1140
    end
1141
  end
1142
end
1143
print("\nStarting in 3"); sleep(1); print("2"); sleep(1); print("1"); sleep(1.5) --Dramatic pause at end
1144
1145
1146
1147
----------------------------------------------------------------
1148
--Define ALL THE FUNCTIONS
1149
--Event System Functions
1150
function eventSetInsertionPoint(num)
1151
  eventInsertionPoint = num or 1
1152
end
1153
function eventAddAt(pos, ...)
1154
  return table.insert(events,pos, {...}) or true
1155
end
1156
function eventAdd(...) --Just a wrapper
1157
  return eventAddAt(eventInsertionPoint, ...)
1158
end
1159
function eventGet(pos)
1160
  return events[tonumber(pos) or #events]
1161
end
1162
function eventPop(pos)
1163
  return table.remove(events,tonumber(pos) or #events) or false --This will return value popped, tonumber returns nil if fail, so default to end
1164
end
1165
function eventRun(value, ...)
1166
  local argsList = {...}
1167
  if type(value) == "string" then
1168
    if value:sub(-1) ~= ")" then --So supports both "up()" and "up"
1169
      value = value .. "("
1170
      for a, b in pairs(argsList) do --Appending arguments
1171
        local toAppend
1172
        if type(b) == "table" then toAppend = textutils.serialize(b)
1173
        elseif type(b) == "string" then toAppend = "\""..tostring(b).."\"" --They weren't getting strings around them
1174
        else toAppend = tostring(b) end
1175
        value = value .. (toAppend or "true") .. ", "
1176
      end
1177
      if value:sub(-1) ~= "(" then --If no args, do not want to cut off
1178
        value = value:sub(1,-3)..""
1179
      end
1180
      value = value .. ")"
1181
    end
1182
    --print(value) --Debug
1183
    local func = loadstring(value)
1184
    setfenv(func, getfenv(1))
1185
    return func()
1186
  end
1187
end
1188
function eventClear(pos)
1189
  if pos then events[pos] = nil else events = {} end
1190
end
1191
function runAllEvents()
1192
  while #events > 0 do
1193
    local toRun = eventGet()
1194
    --print(toRun[1]) --Debug
1195
    eventRun(unpack(toRun))
1196
    eventPop()
1197
  end
1198
end
1199
1200
--Display Related Functions
1201
function display() --This is just the last screen that displays at the end
1202
  screen(1,1)
1203
  print("Total Blocks Mined: "..mined)
1204
  print("Current Fuel Level: "..checkFuel())
1205
  print("Cobble: "..totals.cobble)
1206
  print("Usable Fuel: "..totals.fuel)
1207
  print("Other: "..totals.other)
1208
  if rednetEnabled then
1209
    print("")
1210
    print("Sent Stop Message")
1211
    if legacyRednet then --This was the traditional stopping signal
1212
      print("Sent Legacy Stop")
1213
      sendMessage(channels.send, channels.receive, "stop")
1214
    end
1215
    local finalTable = {mined = mined, cobble = totals.cobble, fuelblocks = totals.fuel,
1216
        other = totals.other, fuel = checkFuel(), isDone = true }
1217
    if preciseTotals then
1218
      finalTable.preciseTotals = exactTotals --This table doubles as a flag.
1219
    end
1220
    sendMessage(channels.send,channels.receive, finalTable)
1221
    modem.close(channels.receive)
1222
  end
1223
  if doBackup then
1224
    fs.delete(saveFile)
1225
    if autoResume then --Getting rid of the original startup files and replacing
1226
      fs.delete(startupName)
1227
      if fs.exists(startupRename) then
1228
        fs.move(startupRename, startupName)
1229
      end
1230
    end
1231
  end
1232
end
1233
function updateDisplay() --Runs in Mine(), display information to the screen in a certain place
1234
screen(1,1)
1235
print("Blocks Mined")
1236
print(mined)
1237
print("Percent Complete")
1238
print(percent.."%")
1239
print("Fuel")
1240
print(checkFuel())
1241
  -- screen(1,1)
1242
  -- print("Xpos: ")
1243
  -- print(xPos)
1244
  -- print("RelXPos: ")
1245
  -- print(relxPos)
1246
  -- print("Z Pos: ")
1247
  -- print(zPos)
1248
  -- print("Y pos: ")
1249
  -- print(yPos)
1250
if rednetEnabled then
1251
screenLine(1,7)
1252
print("Connected: "..tostring(connected))
1253
end
1254
end
1255
--Utility functions
1256
local function pad(str, length, side)
1257
  toRet = ""
1258
  if side == "right" then
1259
    toRet = str
1260
  end
1261
  for i=1, length-#str do
1262
    toRet = toRet.." "
1263
  end
1264
  if side == "left" then
1265
    toRet = toRet..str
1266
  end
1267
  return toRet
1268
end
1269
function logMiningRun(textExtension, extras) --Logging mining runs
1270
  if not logging then return end
1271
  local number, name = 0
1272
  if not fs.isDir(logFolder) then
1273
    fs.delete(logFolder)
1274
    fs.makeDir(logFolder)
1275
  end
1276
  repeat
1277
    number = number + 1 --Number will be at least 2
1278
    name = logFolder.."/Quarry_Log_"..tostring(number)..(textExtension or "")
1279
  until not fs.exists(name)
1280
  local handle = fs.open(name,"w")
1281
  local function write(...)
1282
    for a, b in ipairs({...}) do
1283
      handle.write(tostring(b))
1284
    end
1285
    handle.write("\n")
1286
  end
1287
  local function boolToText(bool) if bool then return "Yes" else return "No" end end
1288
  write("Welcome to the Quarry Logs!")
1289
  write("Entry Number: ",number)
1290
  write("Quarry Version: ",VERSION)
1291
  write("Dimensions (X Z Y): ",x," ",z," ", y)
1292
  write("Blocks Mined: ", mined)
1293
  write("  Cobble: ", totals.cobble)
1294
  write("  Usable Fuel: ", totals.fuel)
1295
  write("  Other: ",totals.other)
1296
  write("Total Fuel Used: ",  (originalFuel or (neededFuel + checkFuel()))- checkFuel()) --Protect against errors with some precision
1297
  write("Expected Fuel Use: ", neededFuel)
1298
  write("Days to complete mining run: ",os.day()-originalDay)
1299
  write("Day Started: ", originalDay)
1300
  write("Number of times resumed: ", numResumed)
1301
  write("Was an ore quarry? ",boolToText(oreQuarry or oldOreQuarry))
1302
  write("Was inverted? ",boolToText(invert))
1303
  write("Was using rednet? ",boolToText(rednetEnabled))
1304
  write("Chest was on the ",dropSide," side")
1305
  if startDown > 0 then write("Started ",startDown," blocks down") end
1306
  if exactTotals then
1307
    write("\n==DETAILED TOTALS==")
1308
    for a,b in pairs(exactTotals) do
1309
      write(pad(a, 15, "right"),":",pad(tostring(b),({term.getSize()})[1]-15-1, "left"))
1310
    end
1311
  end
1312
  handle.close()
1313
end
1314
--Inventory related functions
1315
function isFull(slots) --Checks if there are more than "slots" used inventory slots.
1316
  slots = slots or inventoryMax
1317
  local numUsed = 0
1318
  sleep(0)
1319
  for i=1, inventoryMax do
1320
    if turtle.getItemCount(i) > 0 then numUsed = numUsed + 1 end
1321
  end
1322
  if numUsed > slots then
1323
    return true
1324
  end
1325
  return false
1326
end
1327
function countUsedSlots() --Returns number of slots with items in them, as well as a table of item counts
1328
  local toRet, toRetTab = 0, {}
1329
  for i=1, inventoryMax do
1330
    local a = turtle.getItemCount(i)
1331
    if a > 0 then toRet = toRet + 1 end
1332
    table.insert(toRetTab, a)
1333
  end
1334
  return toRet, toRetTab
1335
end
1336
function getSlotsTable() --Just get the table from above
1337
  local _, toRet = countUsedSlots()
1338
  return toRet
1339
end
1340
function getChangedSlots(tab1, tab2) --Returns a table of changed slots. Format is {slotNumber, numberChanged}
1341
  local toRet = {}
1342
  for i=1, math.min(#tab1, #tab2) do
1343
    diff = math.abs(tab2[i]-tab1[i])
1344
    if diff > 0 then
1345
      table.insert(toRet, {i, diff})
1346
    end
1347
  end
1348
  return toRet
1349
end
1350
function getFirstChanged(tab1, tab2) --Just a wrapper. Probably not needed
1351
  local a = getChangedSlots(tab1,tab2)
1352
  return (a[1] or {"none"})[1]
1353
end
1354
1355
function getRep(which, list) --Gets a representative slot of a type. Expectation is a sequential table of types
1356
  for a,b in pairs(list) do
1357
    if b == which then return a end
1358
  end
1359
  return false
1360
end
1361
function assignTypes(types, count) --The parameters allow a preexisting table to be used, like a table from the original compareSlots...
1362
  types, count = types or {1}, count or 1 --Table of types and current highest type
1363
  for i=1, inventoryMax do
1364
    if turtle.getItemCount(i) > 0 and not specialSlots[i] then --Not special slots so we don't count ender chests
1365
      select(i)
1366
      for k=1, count do
1367
        if turtle.compareTo(getRep(k, types)) then types[i] = k end
1368
      end
1369
      if not types[i] then
1370
        count = count + 1
1371
        types[i] = count
1372
      end
1373
      if oreQuarry then
1374
        if blacklist[turtle.getItemDetail().name] then
1375
          dumpSlots[i] = true
1376
        else
1377
          dumpSlots[i] = false
1378
        end
1379
      end
1380
    end
1381
  end
1382
  select(1)
1383
  return types, count
1384
end
1385
function getTableOfType(which, list) --Returns a table of all the slots of which type
1386
  local toRet = {}
1387
  for a, b in pairs(list) do
1388
    if b == which then
1389
      table.insert(toRet, a)
1390
    end
1391
  end
1392
  return toRet
1393
end
1394
1395
--This is so the turtle will properly get types, otherwise getRep of a type might not be a dumpSlot, even though it should be.
1396
if not restoreFoundSwitch then --We only want this to happen once
1397
  if oldOreQuarry then --If its not ore quarry, this screws up type assigning
1398
    initialTypes, initialCount = assignTypes()
1399
  else
1400
    initialTypes, initialCount = {1}, 1
1401
  end
1402
end
1403
1404
function count(add) --Done any time inventory dropped and at end, true=add, false=nothing, nil=subtract
1405
  local mod = -1
1406
  if add then mod = 1 end
1407
  if add == false then mod = 0 end
1408
  slot = {}        --1: Filler 2: Fuel 3:Other --[1] is type, [2] is number
1409
  for i=1, inventoryMax do
1410
    slot[i] = {}
1411
    slot[i][2] = turtle.getItemCount(i)
1412
  end
1413
1414
  local function iterate(toSet , rawTypes, set)
1415
    for _, a in pairs(getTableOfType(toSet, rawTypes)) do --Get all slots matching type
1416
      slot[a][1] = set --Set official type to "set"
1417
    end
1418
  end
1419
1420
  --This assigns "dumb" types to all slots based on comparing, then based on knowledge of dump type slots, changes all slots matching a dump type to one. Otherwise, if the slot contains fuel, it is 2, else 3
1421
  local rawTypes, numTypes = assignTypes(copyTable(initialTypes), initialCount) --This gets increasingly numbered types, copyTable because assignTypes will modify it
1422
1423
  for i=1, numTypes do
1424
    if (select(getRep(i, rawTypes)) or true) and turtle.refuel(0) then --Selects the rep slot, checks if it is fuel
1425
      iterate(i, rawTypes, 2) --This type is fuel
1426
    elseif dumpSlots[getRep(i,(oreQuarry and rawTypes) or initialTypes)] then --If the rep of this slot is a dump item. This is initial types so that the rep is in dump slots. rawTypes if oreQuarry to get newly assigned dumps
1427
      iterate(i, rawTypes, 1) --This type is cobble/filler
1428
    else
1429
      iterate(i, rawTypes, 3) --This type is other
1430
    end
1431
  end
1432
1433
  for i=1,inventoryMax do
1434
    if not specialSlots[i] then --Do nothing for specialSlots!
1435
      if exactTotals and slot[i][2] > 0 then
1436
        local data = turtle.getItemDetail(i)
1437
        exactTotals[data.name] = (exactTotals[data.name] or 0) + (data.count * mod)
1438
      end
1439
      if slot[i][1] == 1 then totals.cobble = totals.cobble + (slot[i][2] * mod)
1440
      elseif slot[i][1] == 2 then totals.fuel = totals.fuel + (slot[i][2] * mod)
1441
      elseif slot[i][1] == 3 then totals.other = totals.other + (slot[i][2] * mod) end
1442
    end
1443
  end
1444
1445
  select(1)
1446
end
1447
1448
--Refuel Functions
1449
function emergencyRefuel(forceBasic)
1450
  local continueEvac = true --This turns false if more fuel is acquired
1451
  if fuelChest then --This is pretty much the only place that this will be used
1452
    if not fuelChestPhase then --Since I want to do things with return of enderRefuel, I will just make a special system. All of this is for backup safety.
1453
      fuelChestPhase = 0 --Global variable will be saved
1454
      fuelChestProperFacing = facing
1455
    end
1456
    if fuelChestPhase == 0 then
1457
      turnTo(coterminal(fuelChestProperFacing+2))
1458
      dig(false)
1459
      fuelChestPhase = 1
1460
      saveProgress()
1461
    end
1462
    if fuelChestPhase == 1 then
1463
      select(specialSlots.fuelChest)
1464
      turtle.place()
1465
      fuelChestPhase = 2
1466
      saveProgress()
1467
    end
1468
    if fuelChestPhase == 2 then
1469
      if not enderRefuel() then --Returns false if slots are full
1470
        select(specialSlots.fuelChest)
1471
        turtle.drop() --Somehow stuff got in here...
1472
      end
1473
      fuelChestPhase = 3
1474
      saveProgress()
1475
    end
1476
    if fuelChestPhase == 3 then
1477
      select(specialSlots.fuelChest)
1478
      dig(false)
1479
      select(1)
1480
      fuelChestPhase = 4
1481
      saveProgress()
1482
    end
1483
    if fuelChestPhase == 4 then
1484
      turnTo(fuelChestProperFacing)
1485
      fuelChestProperFacing = nil --Getting rid of saved values
1486
      fuelChestPhase = nil
1487
      continueEvac = false
1488
    end
1489
  elseif quadEnabled then --Ask for a quadRotor
1490
    screen()
1491
    print("Attempting an emergency Quad Rotor refuel")
1492
    print("The turtle will soon send a message, then wait ",quadTimeout," seconds before moving on")
1493
    print("Press any key to break timer")
1494
    biometrics(nil, true)
1495
    local timer, counter, counterID, event, id  = os.startTimer(quadTimeout), 0, os.startTimer(1)
1496
    local startInventory = getSlotsTable()
1497
    repeat
1498
      if id == counterID then counter = counter + 1; counterID = os.startTimer(1) end
1499
      screenLine(1,6)
1500
      print("Seconds elapsed: ",counter)
1501
      event, id = os.pullEvent() --Waits for a key or fuel or the timer
1502
    until (event == "timer" and id == timer) or event == "key" or event == "turtle_inventory" --Key event just makes turtle go back to start
1503
    if event == "turtle_inventory" then --If fuel was actually delivered
1504
      local slot = getFirstChanged(startInventory, getSlotsTable())
1505
      select(slot)
1506
      local initialFuel = checkFuel()
1507
      midRunRefuel(slot)
1508
      if checkFuel() > initialFuel then
1509
        print("Fuel delivered! Evac aborted")
1510
        continueEvac = false
1511
      else
1512
        print("What did you send the turtle? Not fuel >:(")
1513
        print("Continuing evac")
1514
      end
1515
      sleep(1)
1516
    end
1517
  elseif basicFuelChest and (checkFuel() >= (xPos+zPos+yPos+1)) then --If we have a fuel chest waiting at the top and can make it back ok
1518
    --Copied from "dropOff" function
1519
    eventAdd("goto", 1,1,currY,2, "refuel") --Need this step for "-startDown"
1520
    eventAdd('goto(0,1,1,2,"refuel")')
1521
    eventAdd("drop", dropSide,false) --May as well drop off inventory while we're there (assuming they aren't using just one enderchest [for dropping off] for some reason. That would be annoying to code)
1522
    eventAdd("basicFuelChestRefuel")
1523
    eventAdd("turnTo(0)")
1524
    eventAdd("mine",false,false,true,false)
1525
    eventAdd("goto(1,1,1, 0)")
1526
    eventAdd("goto", 1, 1, currY, 0)
1527
    eventAdd("goto", currX,currZ,currY,currFacing)
1528
    runAllEvents()
1529
    continueEvac = false
1530
  elseif doRefuel or forceBasic then --Attempt an emergency refueling
1531
    screen()
1532
    print("Attempting an emergency refuel")
1533
    print("Fuel Level:    ",checkFuel())
1534
    print("Distance Back: ",(xPos+zPos+yPos+1))
1535
    print("Categorizing Items")
1536
    count(false) --Do not add count, but categorize
1537
    local fuelSwitch, initialFuel = false, checkFuel() --Fuel switch so we don't go over limit (in emergency...)
1538
    print("Going through available fuel slots")
1539
    for i=1, inventoryMax do
1540
      if fuelSwitch then break end
1541
      if turtle.getItemCount(i) > 0 and slot[i][1] == 2 then --If there are items and type 2 (fuel)
1542
        select(i)
1543
        fuelSwitch = midRunRefuel(i) --See above "function drop" for usage
1544
      end
1545
    end
1546
    select(1) --Cleanup
1547
    print("Done fueling")
1548
    if checkFuel() > initialFuel then
1549
      continueEvac = false
1550
      print("Evac Aborted")
1551
    else
1552
      print("Evac is a go, returning to base")
1553
      sleep(1.5) --Pause for reading
1554
    end
1555
  end
1556
  return continueEvac
1557
end
1558
1559
function lavaRefuel(suckDir)
1560
  if checkFuel() + lavaBuffer >= checkFuelLimit() then return false end -- we don't want to constantly over-fuel the turtle.
1561
  local suckFunc
1562
  if suckDir == "up" then suckFunc = turtle.placeUp
1563
  elseif suckDir == "down" then suckFunc = turtle.placeDown
1564
  else suckFunc = turtle.place end
1565
  
1566
  select(specialSlots.lavaBucket)
1567
  if suckFunc() then
1568
    midRunRefuel(specialSlots.lavaBucket, 0) --0 forces it to refuel, even though allowed items[slot] is 1
1569
  end
1570
  select(1)
1571
  return true
1572
end
1573
1574
--Mining functions
1575
function dig(doAdd, mineFunc, inspectFunc, suckDir) --Note, turtle will not bother comparing if not given an inspectFunc
1576
  if doAdd == nil then doAdd = true end
1577
  mineFunc = mineFunc or turtle.dig
1578
  local function retTab(tab) if type(tab) == "table" then return tab end end --Please ignore the stupid one-line trickery. I felt special writing that. (Unless it breaks, then its cool)
1579
    --Mine if not in blacklist. inspectFunc returns success and (table or string) so retTab filters out the string and the extra table prevents errors.
1580
  local mineFlag = false
1581
  if oreQuarry and inspectFunc then
1582
    local worked, data = inspectFunc()
1583
    if data then
1584
      mineFlag = not blacklist[data.name]
1585
      if data.name == chestID then
1586
        emptyChest(suckDir)
1587
      end
1588
      if lavaBucket and data.name == lavaID and data.metadata == lavaMeta then
1589
        lavaRefuel(suckDir)
1590
      end
1591
    end
1592
  end
1593
  if not oreQuarry or not inspectFunc or mineFlag then --Mines if not oreQuarry, or if the inspect passed
1594
   if mineFunc() then
1595
     if doAdd then
1596
       mined = mined + 1
1597
     end
1598
     return true
1599
   else
1600
     return false
1601
   end
1602
  end
1603
  return true --This only runs if oreQuarry but item not in blacklist. true means succeeded in duty, not necessarily dug block
1604
end
1605
1606
function digUp(doAdd, ignoreInspect)--Regular functions :) I switch definitions for optimization (I think)
1607
  return dig(doAdd, turtle.digUp, (not ignoreInspect and turtle.inspectUp) or nil, "up")
1608
end
1609
function digDown(doAdd, ignoreInspect)
1610
  return dig(doAdd, turtle.digDown, (not ignoreInspect and turtle.inspectDown) or nil, "down")
1611
end
1612
if inverted then --If inverted, switch the options
1613
  digUp, digDown = digDown, digUp
1614
end
1615
1616
function smartDig(doDigUp, doDigDown) --This function is used only in mine when oldOreQuarry
1617
  if inverted then doDigUp, doDigDown = doDigDown, doDigUp end --Switching for invert
1618
  local blockAbove, blockBelow = doDigUp and turtle.detectUp(), doDigDown and turtle.detectDown() --These control whether or not the turtle digs
1619
  local index = 1
1620
  for i=1, #compareSlots do
1621
    if not (blockAbove or blockBelow) then break end --We don't want to go selecting if there is nothing to dig
1622
    index = i --To access out of scope
1623
    select(compareSlots[i])
1624
    if blockAbove and turtle.compareUp() then blockAbove = false end
1625
    if blockBelow and turtle.compareDown() then blockBelow = false end
1626
  end
1627
  if compareChest then
1628
    local flag = false
1629
    select(specialSlots.compareChest)
1630
    if turtle.compareUp() then emptyChest("up") end --Impressively, this actually works with session persistence. I'm gooood (apparently :P )
1631
    if turtle.compareDown() then emptyChest("down") end --Looking over the code, I see no reason why that works... Oh well.
1632
  end
1633
  table.insert(compareSlots, 1, table.remove(compareSlots, index)) --This is so the last selected slot is the first slot checked, saving a select call
1634
  if blockAbove then dig(true, turtle.digUp) end
1635
  if blockBelow then dig(true, turtle.digDown) end
1636
end
1637
1638
function relxCalc()
1639
  if layersDone % 2 == 1 then
1640
    relzPos = zPos
1641
  else
1642
    relzPos = (z-zPos) + 1
1643
  end
1644
  if relzPos % 2 == 1 then
1645
    relxPos = xPos
1646
  else
1647
    relxPos = (x-xPos)+1
1648
  end
1649
  if layersDone % 2 == 0 and z % 2 == 1 then
1650
    relxPos = (x-relxPos)+1
1651
  end
1652
end
1653
function horizontalMove(movement, posAdd, doAdd)
1654
  if doAdd == nil then doAdd = true end
1655
  if movement() then
1656
    if doAdd then
1657
      moved = moved + 1
1658
    end
1659
    if facing == 0 then
1660
      xPos = xPos + 1
1661
    elseif facing == 1 then
1662
      zPos = zPos + 1
1663
    elseif facing == 2 then
1664
      xPos = xPos - 1
1665
    elseif facing == 3 then
1666
      zPos = zPos - 1
1667
    else
1668
      error("Function forward, facing should be 0 - 3, got "..tostring(facing),2)
1669
    end
1670
    relxCalc()
1671
    return true
1672
  end
1673
  return false
1674
end
1675
function forward(doAdd)
1676
  return horizontalMove(turtle.forward, 1, doAdd)
1677
end
1678
function back(doAdd)
1679
  return horizontalMove(turtle.back, -1, doAdd)
1680
end
1681
function verticalMove(moveFunc, yDiff, digFunc, attackFunc)
1682
  local count = 0
1683
  while not moveFunc() do
1684
    if not digFunc(true, true) then --True True is doAdd, and ignoreInspect
1685
      attackFunc()
1686
      sleep(0.5)
1687
      count = count + 1
1688
      if count > maxTries and yPos > (startY-7) then bedrock() end
1689
    end
1690
  end
1691
  yPos = yDiff + yPos
1692
  saveProgress()
1693
  biometrics()
1694
  return true
1695
end
1696
function up() --Uses other function if inverted
1697
  verticalMove(inverted and turtle.down or turtle.up, -1, digUp, attackUp) --Other functions deal with invert already
1698
end
1699
function down()
1700
  verticalMove(inverted and turtle.up or turtle.down, 1, digDown, attackDown)
1701
end
1702
1703
1704
function right(num)
1705
  num = num or 1
1706
  for i=1, num do
1707
    facing = coterminal(facing+1)
1708
    saveProgress()
1709
    if not goLeftNotRight then turtle.turnRight() --Normally
1710
    else turtle.turnLeft() end --Left Quarry
1711
  end
1712
end
1713
function left(num)
1714
  num = num or 1
1715
  for i=1, num do
1716
  facing = coterminal(facing-1)
1717
  saveProgress()
1718
  if not goLeftNotRight then turtle.turnLeft() --Normally
1719
  else turtle.turnRight() end --Left Quarry
1720
end
1721
end
1722
1723
function attack(doAdd, func)
1724
  doAdd = doAdd or true
1725
  func = func or turtle.attack
1726
  if func() then
1727
    if doAdd then
1728
      attacked = attacked + 1
1729
    end
1730
    return true
1731
  end
1732
  return false
1733
end
1734
function attackUp(doAdd)
1735
  if inverted then
1736
    return attack(doAdd, turtle.attackDown)
1737
  else
1738
    return attack(doAdd, turtle.attackUp)
1739
  end
1740
end
1741
function attackDown(doAdd)
1742
  if inverted then
1743
    return attack(doAdd, turtle.attackUp)
1744
  else
1745
    return attack(doAdd, turtle.attackDown)
1746
  end
1747
end
1748
1749
function detect(func)
1750
  func = func or turtle.detect
1751
  return func()
1752
end
1753
function detectUp(ignoreInvert)
1754
  if inverted and not ignoreInvert then return detect(turtle.detectDown)
1755
  else return detect(turtle.detectUp) end
1756
end
1757
function detectDown(ignoreInvert)
1758
  if inverted and not ignoreInvert then return detect(turtle.detectUp)
1759
  else return detect(turtle.detectDown) end
1760
end
1761
1762
1763
1764
function mine(doDigDown, doDigUp, outOfPath,doCheckInv) -- Basic Move Forward
1765
  if doCheckInv == nil then doCheckInv = true end
1766
  if doDigDown == nil then doDigDown = true end
1767
  if doDigUp == nil then doDigUp = true end
1768
  if outOfPath == nil then outOfPath = false end
1769
  isInPath = (not outOfPath) --For rednet
1770
  if not outOfPath and (checkFuel() <= xPos + zPos + yPos + 5) then --If the turtle can just barely get back to the start, we need to get it there. We don't want this to activate coming back though...
1771
    local continueEvac = false --It will be set true unless at start
1772
    if xPos ~= 0 then
1773
      continueEvac = emergencyRefuel() --This is a huge list of things to do in an emergency
1774
    end
1775
    if continueEvac then
1776
      eventClear() --Clear any annoying events for evac
1777
      local currPos = yPos
1778
      endingProcedure() --End the program
1779
      print("Turtle ran low on fuel so was brought back to start for you :)\n\nTo resume where you left off, use '-startDown "..tostring(currPos-1).."' when you start")
1780
      error("",0)
1781
    end
1782
  end
1783
  if frontChest and not outOfPath then
1784
    if turtle.inspect then
1785
      local check, data = turtle.inspect()
1786
      if check and data.name == chestID then
1787
        emptyChest("front")
1788
      end
1789
    else
1790
      local flag = false
1791
      select(specialSlots.compareChest)
1792
      if turtle.compare() then flag = true end
1793
      select(1)
1794
      if flag then
1795
        emptyChest("front")
1796
      end
1797
    end
1798
  end
1799
  
1800
  local count = 0
1801
  if not outOfPath then dig() end  --This speeds up the quarry by a decent amount if there are more mineable blocks than air
1802
  while not forward(not outOfPath) do
1803
    sleep(0) --Calls coroutine.yield to prevent errors
1804
    count = count + 1
1805
    if not dig() then
1806
      attack()
1807
    end
1808
    if count > 10 then
1809
      attack()
1810
      sleep(0.2)
1811
    end
1812
    if count > maxTries then
1813
      if checkFuel() == 0 then --Don't worry about inf fuel because I modified this function
1814
        saveProgress({doCheckFuel = true, doRefuel = true}) --This is emergency because this should never really happen.
1815
        os.reboot()
1816
      elseif yPos > (startY-7) and turtle.detect() then --If it is near bedrock
1817
        bedrock()
1818
      else --Otherwise just sleep for a bit to avoid sheeps
1819
        sleep(1)
1820
      end
1821
    end
1822
  end
1823
  checkSanity() --Not kidding... This is necessary
1824
  saveProgress(tab)
1825
1826
  if not oldOreQuarry then
1827
    if doDigUp then--The digging up and down part
1828
      sleep(0) --Calls coroutine.yield
1829
      if not digUp(true) and detectUp() then --This is relative: will dig down first on invert
1830
        if not attackUp() then
1831
          if yPos > (startY-7) then bedrock() end --Checking for bedrock, but respecting user wishes
1832
        end
1833
      end
1834
    end
1835
    if doDigDown then
1836
     digDown(true) --This needs to be absolute as well
1837
    end
1838
  else --If oldQuarry
1839
    smartDig(doDigUp,doDigDown)
1840
  end
1841
  percent = math.ceil(moved/moveVolume*100)
1842
  updateDisplay()
1843
  if doCheckInv and careAboutResources then
1844
    if isFull(inventoryMax-keepOpen) then
1845
      if not ((oreQuarry or oldOreQuarry) and dumpCompareItems) then
1846
        dropOff()
1847
      else
1848
        local currInv = getSlotsTable()
1849
        drop(nil, false, true) --This also takes care of counting.
1850
        if #getChangedSlots(currInv, getSlotsTable()) <= 2 then --This is so if the inventory is full of useful stuff, it still has to drop it
1851
          dropOff()
1852
        end
1853
      end
1854
    end
1855
  end
1856
  biometrics()
1857
end
1858
--Insanity Checking
1859
function checkSanity()
1860
  if not isInPath then --I don't really care if its not in the path.
1861
    return true
1862
  end
1863
  if not (facing == 0 or facing == 2) and #events == 0 then --If mining and not facing proper direction and not in a turn
1864
    turnTo(0)
1865
    rowCheck = true
1866
  end
1867
  if xPos < 0 or xPos > x or zPos < 0 or zPos > z or yPos < 0 then
1868
    saveProgress()
1869
    print("I have gone outside boundaries, attempting to fix (maybe)")
1870
    if xPos > x then goto(x, zPos, yPos, 2) end --I could do this with some fancy math, but this is much easier
1871
    if xPos < 0 then goto(1, zPos, yPos, 0) end
1872
    if zPos > z then goto(xPos, z, yPos, 3) end
1873
    if zPos < 0 then goto(xPos, 1, yPos, 1) end
1874
    relxCalc() --Get relxPos properly
1875
    eventClear()
1876
1877
    --[[
1878
    print("Oops. Detected that quarry was outside of predefined boundaries.")
1879
    print("Please go to my forum thread and report this with a short description of what happened")
1880
    print("If you could also run \"pastebin put Civil_Quarry_Restore\" and give me that code it would be great")
1881
    error("",0)]]
1882
  end
1883
end
1884
1885
local function fromBoolean(input) --Like a calculator
1886
if input then return 1 end
1887
return 0
1888
end
1889
local function multBoolean(first,second) --Boolean multiplication
1890
return (fromBoolean(first) * fromBoolean(second)) == 1
1891
end
1892
function coterminal(num, limit) --I knew this would come in handy :D
1893
limit = limit or 4 --This is for facing
1894
return math.abs((limit*fromBoolean(num < 0))-(math.abs(num)%limit))
1895
end
1896
if tArgs["-manualpos"] then
1897
  facing = coterminal(facing) --Done to improve support for "-manualPos"
1898
  if facing == 0 then rowCheck = true elseif facing == 2 then rowCheck = false end --Ditto
1899
  relxCalc() --Ditto
1900
end
1901
1902
--Direction: Front = 0, Right = 1, Back = 2, Left = 3
1903
function turnTo(num)
1904
  num = num or facing
1905
  num = coterminal(num) --Prevent errors
1906
  local turnRight = true
1907
  if facing-num == 1 or facing-num == -3 then turnRight = false end --0 - 1 = -3, 1 - 0 = 1, 2 - 1 = 1
1908
  while facing ~= num do          --The above is used to smartly turn
1909
    if turnRight then
1910
      right()
1911
    else
1912
      left()
1913
    end
1914
  end
1915
end
1916
function goto(x,z,y, toFace, destination)
1917
  --Will first go to desired z pos, then x pos, y pos varies
1918
  x = x or 1; y = y or 1; z = z or 1; toFace = toFace or facing
1919
  gotoDest = destination or "" --This is used by biometrics.
1920
  statusString = "Going to ".. (destination or "somewhere")
1921
  --Possible destinations: layerStart, quarryStart
1922
  if yPos > y then --Will go up first if below position
1923
    while yPos~=y do up() end
1924
  end
1925
  if zPos > z then
1926
    turnTo(3)
1927
  elseif zPos < z then
1928
    turnTo(1)
1929
  end
1930
  while zPos ~= z do mine(false,false,true,false) end
1931
  if xPos > x then
1932
    turnTo(2)
1933
  elseif xPos < x then
1934
    turnTo(0)
1935
  end
1936
  while xPos ~= x do mine(false,false,true,false) end
1937
  if yPos < y then --Will go down after if above position
1938
    while yPos~=y do down() end
1939
  end
1940
  turnTo(toFace)
1941
  saveProgress()
1942
  gotoDest = ""
1943
  statusString = nil
1944
end
1945
function getNumOpenSlots()
1946
  local toRet = 0
1947
  for i=1, inventoryMax do
1948
    if turtle.getItemCount(i) == 0 then
1949
      toRet = toRet + 1
1950
    end
1951
  end
1952
  return toRet
1953
end
1954
function emptyChest(suckDirection)
1955
  eventAdd("emptyChest",suckDirection)
1956
  eventSetInsertionPoint(2) --Because dropOff adds events we want to run first
1957
  local suckFunc
1958
  if suckDirection == "up" then
1959
    suckFunc = turtle.suckUp
1960
  elseif suckDirection == "down" then
1961
    suckFunc = turtle.suckDown
1962
  else
1963
    suckFunc = turtle.suck
1964
  end
1965
  repeat
1966
    if inventoryMax - countUsedSlots() <= 0 then --If there are no slots open, need to empty
1967
      dropOff()
1968
    end
1969
  until not suckFunc()
1970
  eventClear()
1971
  eventSetInsertionPoint()
1972
end
1973
1974
--Ideas: Bring in inventory change-checking functions, count blocks that have been put in, so it will wait until all blocks have been put in.
1975
local function waitDrop(slot, allowed, whereDrop) --This will just drop, but wait if it can't
1976
  allowed = allowed or 0
1977
  while turtle.getItemCount(slot) > allowed do --No more half items stuck in slot!
1978
    local tries = 1
1979
    while not whereDrop(turtle.getItemCount(slot)-allowed) do --Drop off only the amount needed
1980
      screen(1,1)
1981
      print("Chest Full, Try "..tries)
1982
      chestFull = true
1983
      biometrics()--To send that the chest is full
1984
      tries = tries + 1
1985
      sleep(2)
1986
    end
1987
    chestFull = false
1988
  end
1989
end
1990
1991
function midRunRefuel(i, allowed)
1992
  allowed = allowed or allowedItems[i]
1993
  local numToRefuel = turtle.getItemCount(i)-allowed
1994
  if checkFuel() >= checkFuelLimit() then return true end --If it doesn't need fuel, then signal to not take more
1995
  local firstCheck = checkFuel()
1996
  if numToRefuel > 0 then turtle.refuel(1)  --This is so we can see how many fuel we need.
1997
    else return false end --Bandaid solution: If won't refuel, don't try.
1998
  local singleFuel
1999
  if checkFuel() - firstCheck > 0 then singleFuel = checkFuel() - firstCheck else singleFuel = math.huge end --If fuel is 0, we want it to be huge so the below will result in 0 being taken
2000
  --Refuel      The lesser of   max allowable or         remaining fuel space         /    either inf or a single fuel (which can be 0)
2001
  turtle.refuel(math.min(numToRefuel-1, math.ceil((checkFuelLimit()-checkFuel()) / singleFuel))) --The refueling part of the the doRefuel option
2002
  if checkFuel() >= checkFuelLimit() then return true end --Do not need any more fuel
2003
  return false --Turtle can still be fueled
2004
end
2005
2006
function enderRefuel() --Assumes a) An enderchest is in front of it b) It needs fuel
2007
  local slot
2008
  for a,b in ipairs(getSlotsTable()) do
2009
    if b == 0 then slot = a; break end
2010
  end
2011
  if not slot then return false end --No room for fueling
2012
  select(slot)
2013
  repeat
2014
    print("Required Fuel: ",checkFuelLimit())
2015
    print("Current Fuel: ",checkFuel())
2016
    local tries = 0
2017
    while not turtle.suck() do
2018
      sleep(1)
2019
      statusString = "No Fuel in Ender Chest"
2020
      biometrics() --Let user know that fuel chest is empty
2021
      print(statusString,". Try: ",tries)
2022
      tries = tries + 1
2023
    end
2024
    statusString = nil
2025
  until midRunRefuel(slot, 0) --Returns true when should not refuel any more
2026
  if not turtle.drop() then turtle.dropDown() end --If cannot put fuel back, just drop it, full fuel chest = user has too much fuel already
2027
  return true -- :D
2028
end
2029
2030
2031
function drop(side, final, compareDump)
2032
  side = sides[side] or "front"
2033
  turnTo(2) --Ensure it is facing the proper direction when starting dropping
2034
  local dropFunc, detectFunc, dropFacing = turtle.drop, turtle.detect, facing+2
2035
  if side == "top" then dropFunc, detectFunc = turtle.dropUp, turtle.detectUp end
2036
  if side == "bottom" then dropFunc, detectFunc = turtle.dropDown, turtle.detectDown end
2037
  if side == "right" then turnTo(1); dropFacing = 0 end
2038
  if side == "left" then turnTo(3); dropFacing = 0 end
2039
  local properFacing = facing --Capture the proper direction to be facing
2040
2041
  count(true) --Count number of items before drop. True means add. This is before chest detect, because could be final
2042
2043
  while not compareDump and not detectFunc() do
2044
    if final then return end --If final, we don't need a chest to be placed, but there can be
2045
    chestFull = true
2046
    biometrics() --Let the user know there is a problem with chest
2047
    screen(1,1) --Clear screen
2048
    print("Waiting for chest placement on ",side," side (when facing quarry)")
2049
    sleep(2)
2050
  end
2051
  chestFull = false
2052
2053
  local fuelSwitch = false --If doRefuel, this can switch so it won't overfuel
2054
  for i=1,inventoryMax do
2055
    --if final then allowedItems[i] = 0 end --0 items allowed in all slots if final ----It is already set to 1, so just remove comment if want change
2056
    if turtle.getItemCount(i) > 0 then --Saves time, stops bugs
2057
      if slot[i][1] == 1 and dumpCompareItems then turnTo(dropFacing) --Turn around to drop junk, not store it. dumpComapareItems is global config
2058
      else turnTo(properFacing) --Turn back to proper position... or do nothing if already there
2059
      end
2060
      select(i)
2061
      if slot[i][1] == 2 then --Intelligently refuels to fuel limit
2062
        if doRefuel and not fuelSwitch then --Not in the conditional because we don't want to waitDrop excess fuel. Not a break so we can drop junk
2063
          fuelSwitch = midRunRefuel(i)
2064
        else
2065
          waitDrop(i, allowedItems[i], dropFunc)
2066
        end
2067
        if fuelSwitch then
2068
          waitDrop(i, allowedItems[i], dropFunc)
2069
        end
2070
      elseif not compareDump or (compareDump and slot[i][1] == 1) then --This stops all wanted items from being dropped off in a compareDump
2071
        waitDrop(i, allowedItems[i], dropFunc)
2072
      end
2073
    end
2074
  end
2075
2076
  if compareDump then
2077
    for i=2, inventoryMax do
2078
      if not specialSlots[i] then --We don't want to move buckets and things into earlier slots
2079
        select(i)
2080
        for j=1, i-1 do
2081
          if turtle.getItemCount(i) == 0 then break end
2082
          turtle.transferTo(j)
2083
        end
2084
      end
2085
    end
2086
    select(1)
2087
  end
2088
  if oldOreQuarry or compareDump then count(nil) end--Subtract the items still there if oreQuarry
2089
  resetDumpSlots() --So that slots gone aren't counted as dump slots next
2090
2091
  select(1) --For fanciness sake
2092
2093
end
2094
2095
--Note: This is recommended to be used with "excessFuelAmount" option
2096
function basicFuelChestRefuel()
2097
  side = basicFuelChest --This variable is a side
2098
  local dropFunc, suckFunc, detectFunc = turtle.drop, turtle.suck, turtle.detect
2099
  if side == "top" then dropFunc, suckFunc, detectFunc = turtle.dropUp, turtle.suckUp, turtle.detectUp end
2100
  if side == "bottom" then dropFunc, suckFunc, detectFunc = turtle.dropDown, turtle.suckDown, turtle.detectDown end
2101
  if side == "right" then turnTo(1)end
2102
  if side == "left" then turnTo(3)end
2103
  
2104
  while not detectFunc() do
2105
    chestFull = true
2106
    biometrics() --Let the user know there is a problem with chest
2107
    screen(1,1) --Clear screen
2108
    print("Waiting for chest placement on ",side," side (when facing quarry)")
2109
    sleep(2)
2110
  end
2111
  chestFull = false
2112
  
2113
  local fuelSwitch = false
2114
  select(1) --Get the first slot
2115
  while not fuelSwitch do --While not satisfied with fuel
2116
    screen(1,1)
2117
    print("Current Fuel: " .. tostring(checkFuel())) --In case of empty, print before
2118
    print("Needed Fuel:  " .. tostring(checkFuelLimit()))
2119
    if not suckFunc() then --Kind of copied the above
2120
      chestFull = true
2121
      biometrics() --Let the user know there is a problem with chest
2122
      print("Fuel chest is out of fuel! Please resolve this")
2123
      sleep(2)
2124
    end
2125
    chestFull = false
2126
    
2127
    fuelSwitch = midRunRefuel(1) --Then refuel from the first slot
2128
  end
2129
  
2130
  dropFunc() --Drop remaining fuel back in the chest (or keep it if chest is full, that's cool)
2131
end
2132
2133
function dropOff() --Not local because called in mine()
2134
  local currX,currZ,currY,currFacing = xPos, zPos, yPos, facing
2135
  if careAboutResources then
2136
    if not enderChest then --Regularly
2137
      eventAdd("goto", 1,1,currY,2, "drop off") --Need this step for "-startDown"
2138
      eventAdd('goto(0,1,1,2,"drop off")')
2139
      eventAdd("drop", dropSide,false)
2140
      eventAdd("turnTo(0)")
2141
      eventAdd("mine",false,false,true,false)
2142
      eventAdd("goto(1,1,1, 0)")
2143
      eventAdd("goto", 1, 1, currY, 0)
2144
      eventAdd("goto", currX,currZ,currY,currFacing)
2145
    else --If using an enderChest
2146
      if turtle.getItemCount(specialSlots.enderChest) ~= 1 then eventAdd("promptSpecialSlot('enderChest','Ender Chest')") end
2147
      eventAdd("turnTo",currFacing-2)
2148
      eventAdd("dig",false)
2149
      eventAdd("select",specialSlots.enderChest)
2150
      eventAdd("turtle.place")
2151
      eventAdd("drop","front",false)
2152
      eventAdd("turnTo",currFacing-2)
2153
      eventAdd("select", specialSlots.enderChest)
2154
      eventAdd("dig",false)
2155
      eventAdd("turnTo",currFacing)
2156
      eventAdd("select(1)")
2157
    end
2158
    runAllEvents()
2159
    numDropOffs = numDropOffs + 1 --Analytics tracking
2160
  end
2161
  return true
2162
end
2163
function endingProcedure() --Used both at the end and in "biometrics"
2164
  eventAdd("goto",1,1,yPos,2,"quarryStart") --Allows for startDown variable
2165
  eventAdd("goto",0,1,1,2, "quarryStart") --Go back to base
2166
  runAllEvents()
2167
  --Output to a chest or sit there
2168
  if enderChest then
2169
    if dropSide == "right" then eventAdd("turnTo(1)") end --Turn to proper drop side
2170
    if dropSide == "left" then eventAdd("turnTo(3)") end
2171
    eventAdd("dig(false)") --This gets rid of a block in front of the turtle.
2172
    eventAdd("select",specialSlots.enderChest)
2173
    eventAdd("turtle.place")
2174
    eventAdd("select(1)")
2175
  end
2176
  eventAdd("drop",dropSide, true)
2177
  eventAdd("turnTo(0)")
2178
2179
  --Display was moved above to be used in bedrock function
2180
  eventAdd("display")
2181
  --Log current mining run
2182
  eventAdd("logMiningRun",logExtension)
2183
  toQuit = true --I'll use this flag to clean up (legacy)
2184
  runAllEvents()
2185
end
2186
function bedrock()
2187
  foundBedrock = true --Let everyone know
2188
  if rednetEnabled then biometrics() end
2189
  if checkFuel() == 0 then error("No Fuel",0) end
2190
  local origin = {x = xPos, y = yPos, z = zPos}
2191
  print("Bedrock Detected")
2192
  if turtle.detectUp() and not turtle.digUp() then
2193
    print("Block Above")
2194
    turnTo(facing+2)
2195
    repeat
2196
      if not forward(false) then --Tries to go back out the way it came
2197
        if not attck() then --Just making sure not mob-blocked
2198
          if not dig() then --Now we know its bedrock
2199
            turnTo(facing+1) --Try going a different direction
2200
          end
2201
        end
2202
      end
2203
    until not turtle.detectUp() or turtle.digUp() --These should be absolute and we don't care about about counting resources here.
2204
  end
2205
  up() --Go up two to avoid any bedrock.
2206
  up()
2207
  eventClear() --Get rid of any excess events that may be run. Don't want that.
2208
  endingProcedure()
2209
  print("\nFound bedrock at these coordinates: ")
2210
  print(origin.x," Was position in row\n",origin.z," Was row in layer\n",origin.y," Blocks down from start")
2211
  error("",0)
2212
end
2213
2214
function endOfRowTurn(startZ, wasFacing, mineFunctionTable)
2215
local halfFacing = ((layersDone % 2 == 1) and 1) or 3
2216
local toFace = coterminal(wasFacing + 2) --Opposite side
2217
if zPos == startZ then
2218
  if facing ~= halfFacing then turnTo(halfFacing) end
2219
  mine(unpack(mineFunctionTable or {}))
2220
end
2221
if facing ~= toFace then
2222
  turnTo(toFace)
2223
end
2224
end
2225
2226
2227
-------------------------------------------------------------------------------------
2228
--Pre-Mining Stuff dealing with session persistence
2229
runAllEvents()
2230
if toQuit then error("",0) end --This means that it was stopped coming for its last drop
2231
2232
local doDigDown, doDigUp = (lastHeight ~= 1), (lastHeight == 0) --Used in lastHeight
2233
if not restoreFoundSwitch then --Regularly
2234
  --Check if it is a mining turtle
2235
  if not isMiningTurtle then
2236
    local a, b = turtle.dig()
2237
    if a then
2238
      mined = mined + 1
2239
      isMiningTurtle = true
2240
    elseif b == "Nothing to dig with" or b == "No tool to dig with" then
2241
      print("This is not a mining turtle. To make a mining turtle, craft me together with a diamond pickaxe")
2242
      error("",0)
2243
    end
2244
  end
2245
  
2246
  if checkFuel() == 0 then --Some people forget to start their turtles with fuel
2247
    screen(1,1)
2248
    print("I have no fuel and doCheckFuel is off!")
2249
    print("Starting emergency fueling procedures!\n")
2250
    emergencyRefuel()
2251
    if checkFuel() == 0 then
2252
      print("I have no fuel and can't get more!")
2253
      print("Try using -doRefuel or -fuelChest")
2254
      print("I have no choice but to quit.")
2255
      error("",0)
2256
    end
2257
  end
2258
  
2259
  mine(false,false,true) --Get into quarry by going forward one
2260
  if gpsEnabled and not restoreFoundSwitch then --The initial locate is done in the arguments. This is so I can figure out what quadrant the turtle is in.
2261
    gpsSecondPos = {gps.locate(gpsTimeout)} --Note: Does not run this if it has already been restarted.
2262
  end
2263
  for i = 1, startDown do
2264
    eventAdd("down") --Add a bunch of down events to get to where it needs to be.
2265
  end
2266
  runAllEvents()
2267
  if flatBedrock then
2268
    while (detectDown() and digDown(false, true)) or not detectDown() do --None of these functions are non-invert protected because inverse always false here
2269
      down()
2270
      startDown = startDown + 1
2271
    end
2272
    startDown = startDown - y + 1
2273
    for i=1, y-2 do
2274
      up() --It has hit bedrock, now go back up for proper 3 wide mining
2275
    end
2276
  elseif not(y == 1 or y == 2) then
2277
    down() --Go down to align properly. If y is one or two, it doesn't need to do this.
2278
  end
2279
else --restore found
2280
  if not(layersDone == layers and not doDigDown) then digDown() end
2281
  if not(layersDone == layers and not doDigUp) then digUp() end  --Get blocks missed before stopped
2282
end
2283
--Mining Loops--------------------------------------------------------------------------
2284
select(1)
2285
while layersDone <= layers do -------------Height---------
2286
local lastLayer = layersDone == layers --If this is the last layer
2287
local secondToLastLayer = (layersDone + 1) == layers --This is a check for going down at the end of a layer.
2288
moved = moved + 1 --To account for the first position in row as "moved"
2289
if not(layersDone == layers and not doDigDown) then digDown() end --This is because it doesn't mine first block in layer
2290
if not restoreFoundSwitch and layersDone % 2 == 1 then rowCheck = true end
2291
relxCalc()
2292
while relzPos <= z do -------------Width----------
2293
while relxPos < x do ------------Length---------
2294
mine(not lastLayer or (doDigDown and lastLayer), not lastLayer or (doDigUp and lastLayer)) --This will be the idiom that I use for the mine function
2295
end ---------------Length End-------
2296
if relzPos ~= z then --If not on last row of section
2297
  local func
2298
  if rowCheck == true then --Switching to next row
2299
  func = "right"; rowCheck = false; else func = false; rowCheck = true end --Which way to turn
2300
    eventAdd("endOfRowTurn", zPos, facing , {not lastLayer or (doDigDown and lastLayer), not lastLayer or (doDigUp and lastLayer)}) --The table is passed to the mine function
2301
    runAllEvents()
2302
else break
2303
end
2304
end ---------------Width End--------
2305
if layersDone % 2 == 0 then --Will only go back to start on non-even layers
2306
  eventAdd("goto",1,1,yPos,0, "layerStart") --Goto start of layer
2307
else
2308
  eventAdd("turnTo",coterminal(facing-2))
2309
end
2310
if not lastLayer then --If there is another layer
2311
  for i=1, 2+fromBoolean(not(lastHeight~=0 and secondToLastLayer)) do eventAdd("down()") end --The fromBoolean stuff means that if lastheight is 1 and last and layer, will only go down two
2312
end
2313
eventAdd("relxCalc")
2314
layersDone = layersDone + 1
2315
restoreFoundSwitch = false --This is done so that rowCheck works properly upon restore
2316
runAllEvents()
2317
end ---------------Height End-------
2318
2319
endingProcedure() --This takes care of getting to start, dropping in chest, and displaying ending screen