ComputerCraft Wiki - User contributions [en]

Mouse click (event)

2016-12-13T16:40:00Z

Latias1290: pressing extra mouse buttons are registered as left mouse button

{{lowercase}}
{{Event
|name=mouse_click
|desc=Fired when the terminal of an advanced system is pressed with a mouse. Unavailable to normal systems, as these lack mouse support.
|return1=The mouse button that was clicked. Left Mouse Button is returned as the number 1, Right Mouse Button is returned as the number 2 and Middle Mouse Button is returned as the number 3. If you have more than three buttons on your mouse, pressing them will return 1.
|return2=The X-coordinate of the click (in screen-characters).
|return3=The Y-coordinate of the click (in screen-characters).
|examples=
{{Example
|desc=Print the button and the co-ordinates of every mouse click we receive.
|code=
while true do
local event, button, x, y = '''[[os.pullEvent]]( "mouse_click" )'''

[[print]]( "The mouse button ", button, " was pressed at ", x, " and ", y )
end
|output=The button that was pressed, followed by the X and Y position of the event.
}}
}}

Loops

2015-07-01T12:31:50Z

Latias1290: I'm pretty sure that that means the same. Which is obviously incorrect then.

[[Category:Tutorials]]
{{Tutorial
|name=Loops
|desc=This is a tutorial page for loops and their application.
|objective=To understand the purposes, and uses of, loops and iterators
|prereqs=[[Variables|A basic understanding of Variables]] and [[Function_(type)|a basic understanding of Functions]].
}}

== Introducing Loops ==

At some point while coding, you will most likely want to run some code multiple times, without writing out a lot of code. While it is true that functions can shorten your code, there may be situations where even those don't simplify it enough. That's where loops come in.

Here is a name-gathering script without loops:
local [[Function (type)|function]] GetName()
[[write]]("Enter a name: ")
return [[read]]()
end

local Name1 = GetName()
local Name2 = GetName()
local Name3 = GetName()
local Name4 = GetName()
local Name5 = GetName()

[[write]]("You have entered "..Name1.." "..Name2.." "..Name3.." "..Name4.." "..Name5)

As you can see, there is quite a lot of repetition, even when we're using a function.

== The For loop ==

The for loop is the most basic loop. It is in the following format:
for ''Variable'' = ''Start'', ''End'', ''Interval'' do
--Insert code here
end
''Variable'' is a number that will track where we are in the loop. It is usually called "i", or something more appropriate to the script. ''Start'' is a number to indicate the start point for the loop. In a simple loop this will typically be 1, but you may have need to start with other values. ''End'' is the number the loop will count to. ''Interval'' is an optional argument, and will specify how much to increment (or decrement!) ''Variable'' by with each iteration.

The best way to discover how the for loop works is to try it yourself. Try changing the numbers the following code to see how it reacts.
for i=1,10 do
[[print]]( "i is "..[[tostring]](i) )
end
Notice how it always counts up until ''Variable'' is the same or greater than ''End''. ''Start'', ''End'', and ''Interval'' can also be variables, so it can loop a different number of times:
[[write]]("How many times should I loop? ")
local Num = tonumber( read() )
for i=1,Num do
[[print]]("Looped "..[[tostring]](i).." time(s).")
end
Note that the loop only inspects ''Start'', ''End'', and ''Interval'' once - when the loop starts - so if their values change while the loop is running, it'll ignore this and loop according to as they were when it it begun.

To simplify the first script using a for loop, it would look something like this:
local string = ""
for i=1,5 do
[[write]]("Enter a name: ")
string=string.." "..read()
end
[[write]]("You have entered "..string)
A for loop's code will not be executed at all if you hand it values such that the loop appears to've already ended. For example:
for i=1,0 do
print(i)
end
The above code will print nothing, as ''Start'' starts out as above ''End''.

== The While loop ==

The While loop will continue looping until a certain condition is no longer met.
local Answer, Correct = "", "2"
while Answer ~= Correct do
[[write]]("What is the sum of 1 and 1 (1+1)? ")
Answer = [[read]]()

if Answer == Correct then print("Correct!") else print("Incorrect!") end
end

This type of loop is useful for if you don't want to specify a definite end for the loop. Although infinite loops are ill-advised, you may want to use one at some point. To terminate a program stuck in a loop, hold Ctrl + T while in the computer's interface.
while [[boolean_(type)|true]] do --Always loop
--Code here
end

== The Repeat loop ==
The reverse of a while loop - instead of repeating so long as a condition is true, it repeats ''until'' a condition is true. Since the check is done at the ''bottom'' of the code block, the code within it will always be executed at least once.

local i = 1
repeat
[[print]](i)
i = i + 1
until i == 5

User talk:Latias1290

2013-09-28T04:07:26Z

Latias1290:

Do you mind fixing the shading on [[File:Grid_Advanced_Turtle.png]]? I'm not really a graphics person and all I did was copy the colors from models\turtle2.png onto [[File:Grid_turtle.png]].
--[[User:Bunny365|Bunny365]] 15:39, 1 September 2013 (GMT)
:Im not really graphical either :/ [[User:Latias1290|Latias1290]] 04:07, 28 September 2013 (GMT)

== Login with Roaming Profiles ==

You have edited the login with roaming profiles pages considerably and redone it even after AfterLifeLochie reverted the changes. Remember that the wiki is a place to put tutorials to help people out, not publish your programs and self-recommend them -- that goes on the forums.
I love how you added a new login with roaming profiles page, but it seriously looks more like a forum post than a tutorial. You buried the previous program and claimed it as not recommended. Instead you pretty much put your version of the program and essentially copyrighted it, and then recommended it yourself. On top of that, you marked the security issues that DID APPLY to your program as inapplicable to your version. This is for tutorials, not publishing programs to compete with previous ones.

I didn't revert the edition because I think your version is a good improvement, but I added a list of it's flaws (from a wireless networking analyst point of view) to keep users aware and removed the bragging parts ("I recommend the new one, this is just for reference...").

I can't remove the "by Latias1290" part in the client because it's your intellectual property, but I suggest that you don't brand your tutorial. I mean, it's a tutorial. Also, you should add comments and explain your program rather than just putting the program -- as that doesn't really explain much to people who read the tutorial, instead they have to figure it out themselves.

[[User:Bwhodle|Bwhodle]] 18:43, 6 September 2013 (GMT)

Turtle GPS self-tracker expansion (tutorial)

2013-08-28T06:10:25Z

Latias1290:

This tutorial will teach you how to make a [[Turtle]] more efficient in keeping track of its location when using the [[Gps_(API)|GPS API]]. This is essentially an API that uses the native Turtle movement API while using its own movement as a sensor to keep track of its location, so it only requires a GPS signal once, until it is turned off. This API requires every Turtle you want to use the API with to have it installed. I recommend using an [[Advanced_Computer|Advanced Computer]] to write it on, move it to a [[Disk]] with a [[Disk_Drive|disk drive]] and moving it to the Turtle. Alternatively, if you are on Singleplayer or a Multiplayer admin and have access to the mod file, you can move it into the turtle/rom folder to have it automatically installed on every new turtle that is placed.

Important: When starting, the program assumes that it is facing west, so first you must face West and then place the turtle. Here are some ways to check where you are facing:
You can see the sun/moon rising right in front of you. You are facing East.
You can see the sun/moon falling right in front of you. You are facing West.
Clouds go west. Check where they go.
Press F3 and locate the number behind "f". This one is below "x", "y" and "z". If this number is 0, you are facing North. If this number is 1, you are facing West. If this number is 2, you are facing South. If this number is 3, you are facing East.

== Code ==
''Note: This will only work on a Turtle. That said, even if it worked on a [[Computer|computer]], it wouldnt have any practical use because a computer cant move.'' 
Before you start, you must add this to the program that you want to use it with at the top line:
os.loadApi("tst")
This will allow the program to use the API. This tutorial assumes that you use the file name "tst" for the API, but if you like to you can change it. You must then also change every reference to "tst" in your program, including the line above.
Write this in the computer/turtle:

-- Turtle Self-tracking System created by Latias1290.

local xPos, yPos, zPos = nil
face = 1
cal = false

function setLocation() -- get gps using other computers
xPos, yPos, zPos = gps.locate()
cal = true
end

function manSetLocation(number x, number y, number z) -- manually set location
xPos = x
yPos = y
zPos = z
cal = true
end

function getLocation() -- return the location
if xPos != nil then
return xPos, yPos, zPos
elseif xPos == nil then
return nil
end
end

function turnLeft() -- turn left
if face == 0 then
face = 1
elseif face == 1 then
face = 2
elseif face == 2 then
face = 3
elseif face == 3 then
face = 0
end
end

function turnRight() -- turn right
if face == 0 then
face = 3
elseif face == 1 then
face = 0
elseif face == 2 then
face = 1
elseif face == 3 then
face = 2
end
end

function forward() -- go forward
turtle.forward()
if cal == true then
if face == 0 then
zPos = zPos - 1
elseif face == 1 then
xPos = xPos - 1
elseif face == 2 then
zPos = zPos + 1
elseif face == 3 then
xPos = xPos + 1
end
else
print("Not Calibrated.")
end
end

function back() -- go back
turtle.back()
if cal == true then
if face == 0 then
zPos = zPos + 1
elseif face == 1 then
xPos = xPos + 1
elseif face == 2 then
zPos = zPos - 1
elseif face == 2 then
xPos = xPos - 1
end
else
print("Not Calibrated.")
end
end

function up() -- go up
turtle.up()
if cal == true then
yPos = yPos + 1
else
print("Not Calibrated.")
end
end

function down() -- go down
turtle.down()
if cal == true then
yPos = yPos - 1
else
print("Not Calibrated.")
end

function jump() -- perform a jump. useless? yup!
turtle.up()
turtle.down()
end

== How to Use ==
This might seem daunting at the first moment. But dont worry, I will walk you through it. Note that to use it properly, you must always put "tst." in front of it, or how you named it followed by a dot. So if I wanted to have my turtle go 1 block forward, I typed "tst.forward()". Note that if you do not do either tst.getLocation OR tst.setLocation(coords), the API will print "Not Calibrated." every time you use a command. This will not prevent you from using it, however.

=== setLocation ===
To use this, you will need at least 4 computers equipped with a Wireless Modem, and having it host a GPS. More info about that [[Gps_(API)|here]] and [[Gps_(program)|here]].

=== manSetLocation ===
For this one you will need to know the location of your turtle. Any location will work, but the API loses its point if you use another coordinate set.
A good way to obtain the coordinates is to open up the debug screen(press F3), stand on the turtle, write down the x, y and z fields, substract 1 from the Y coordinate and use these.

=== getLocation ===
This one is pretty simple. It returns the coordinates. Note that you will have to overwrite all of them.
For example, if we had the variables x, y and z, and we wanted to have the value set to our location, we did this:
x, y, z = tst.getLocation()
Simple right? Note that this will return nil if you are not calibrated, which means if you do it before you do setLocation or manSetLocation, x, y and z will be null!

=== forward, back, up, down, turnLeft and turnRight ===
This one is pretty easy as well. It makes your turtle move 1 block in the direction you used(its obvious which function goes where) and update its location according to where it went.

=== jump ===
This one works a bit different. It makes the turtle go up, then go down. "But thats useless!" you might say, and indeed it is!

[[Category:Unofficial APIs]] [[Category:Tutorials]]

Login with Roaming Profiles

2013-08-28T05:53:35Z

Latias1290:

This tutorial covers how to make a password server and a password client. The server will host a Lua table of usernames and passwords and the client will remotely connect each start up, ask the user for their username and password and compare it to that on the password server.

__TOC__

== Setting Up ==
First of all, you must know how to craft a [[Wireless_Modem|wireless modem]] and a [[Computer|computer]]. You need to craft at least 2 wireless modems and 2 computers if you want to have a practical use for this system. Then, attach 1 modem to each computer you want to add to the system.

Second, since typing on normal computers is relatively slow and annoying, I recommend to write the programs in [[Advanced_Computers|advanced computers]](because in advanced computers you can click to move the cursor around, and there are colors to distinguis between different statements), copying them into a [[Floppy|disk]] and moving them into each computer you want to include(with their respective programs of course). Alternatively, if you are the server owner(this tutorial assumes you are in Multiplayer because this system does not have any practical use in Singleplayer), you can go into the world folder and write copy/paste the source code into the folders of each computer you want to use. The folders you should use are the named the IDs of the computers(so if you have 3 computers, with the IDs 5, 7 and 9, you should copy them into the folders 5, 7 and 9).

It does not matter wether you are using Normal or Advanced computers for this tutorial. I recommend to use Normal ones for the server.

When writing the programs, I HIGHLY recommend using a [[Disk_Drive|disk drive]] like stated above, so you dont have to write in prograns for every computer you add.
Remember to read the text behind the --. These are comments, and you can safely leave them in the code.

== Server ==
print("Initializing...")
local validSender = false
valid = false
tserved, vserved, dserved = 0

print("Loading startup settings...")
count = true -- If you dont want the server to count request statics, set the value of this variable to "false" without qoutes.
modemSide = "left" -- change to the side of the computer your modem is on
whitelist = true -- If you dont want to use a whitelist, change the value to "false" without quotes. This is not recommended on Multiplayer, but it does not make any difference on a Singleplayer World.

print("Loading user database...")
users = {"username1", "username2" } -- Change this to the names for the users you want to have. Make sure the usernames are in the same order as in the password table. Changing the order is fine, but you must maintain the same order in both the users and passwords tables. Incorrect orders WILL cause 2 or more users not being able to log in!
passwords = {"password1", "password2" } -- Change this to the passwords for the users defined in the variable above. Again, make sure the passwords for users are in the same order as the usernames.
senders = { 1, 2, 3, 4 } -- change this to the ID's of the all computers you want to accept requests from if you use a whitelist. If you do not use a whitelist, DO NOT REMOVE THIS LINE! Doing so will cause the program to crash everytime it is run, even though the variable is not used.

print("Loading core functions...")
function clear()
term.clear()
term.setCursorPos(1, 1)
print("CCLS Server 1.0 for CC 1.53")
print("There is no user interaction here. Please contact your system administrator for assistance regarding the system.")
if count == true then
print(tserved.." total requests received this session.")
print(vserved.." requests completed this session.")
print(dserved.." requests denied this session.")
elseif count == false then
print("Request statics have been disabled.")
else
rednet.close(modemSide)
term.clear()
term.setCursorPos(1, 1)
print("Error: Counter setting is not boolean and the server can not continue.")
print("The server program will exit automatically in 10 minutes. Or you can hold down Ctrl+T for 1 second.")
print("After that, please set the variable \"count\" in the source code to either \"true\" or \"false\" WITHOUT QUOTATION MARKS. Doing this with quotation marks will cause the same error.")
sleep(600)
shell.exit()
end

print("Starting up...")
rednet.open(modemSide) -- Opens the modem to wait for incoming login requests

clear()

while true do
validSender = false
senderId, message, distance = rednet.receive()
for i,v in ipairs(senders) do
tserved = tserved + 1
if v == senderId then
validSender = true
break
else
rednet.send(senderId, "301", true) -- Send response code 301 - which means Not Whitelisted.
dserved = dserved + 1
clear()
end
end
if validSender then
for i,v in ipairs(users) do
if message == v then
password = passwords[i]
rednet.send(senderId, password, true)
vserved = vserved + 1
clear()
break
else
rednet.send(senderId, "300", true) -- Send response code 300 - which means Bad Auth.
dserved = dserved + 1
clear()
end
end
end
end

== Client ==
os.pullEvent = os.pullEventRaw
local failed = true
busr = "nsliq" -- If you ever happen to be unable to log in for some reason, you can use this username as a backup.
bpass = "zuFUkVEjQKjkLQhTdpFMheNF" -- If you ever happen to be unable to log in for some reason, you can use this password as a backup.

password_server = 0 -- change to the ID of your password server computer
rednet.open("left") -- change to the side your rednet modem is on
while true do
term.clear()
term.setCursorPos(1,1)
print("Welcome to CCLS 1.0 by Latias1290.")
print("Please select an option.")
print("[1] Login")
print("[2] Shutdown")
write("> ")
input = read()
if input == "2" then
os.shutdown()
elseif input == "1" then
print("Please login.")
write("Username: ")
username = read()
write("Password: ")
password = read("*")
if username == busr then
if password == bpass then
print("Access granted")
break
end
end
rednet.send(password_server, username, true)
senderId, message, distance = rednet.receive(5)
if message == "300" then
print("Invalid Username or Password.")
sleep(3)
elseif password == message then
failed = false
term.clear()
term.setCursorPos(1,1)
print("Welcome ", username)
break;
else
print("Invalid Username or Password.")
sleep(3)
end
else
print("Invalid Command.")
sleep(2)
end
end

== Old Server ==
''Note: This is here for reference for people who need the older version. I recommend using the programs above.''

os.pullEvent = os.pullEventRaw
term.clear()
term.setCursorPos(1,1)
print("This is a password server. There is no user interaction here.")
print("Please find a computer and login there.")
local firstCycle = true
local validSender = false
local modemSide = "left" -- change to the side of the computer your modem is on
local valid = false
users = {"username1", "username2" } --make sure users and passwords line up
passwords = {"password1", "password2" }
senders = { 1, 2, 3, 4 } -- computer ID's of the computers you want to accept requests from
function bootUp()
rednet.open(modemSide)
end
while true do
validSender = false
if firstCycle then
bootUp()
firstCycle = false
end
senderId, message, distance = rednet.receive()
for i,v in ipairs(senders) do
if v == senderId then
validSender = true
break
end
end
if validSender then
for i,v in ipairs(users) do
if message == v then
valid = true
password = passwords[i]
break
else
valid = false
end
end
if valid then
rednet.send(senderId, password, true)
else
rednet.send(senderId, "Not Valid", true)
end
end
end

== Old Client ==

os.pullEvent = os.pullEventRaw
local locker = true
local failed = true
local attempted_login = true
local password_server = 0 -- change to the ID of your password server computer
rednet.open("left") -- change to the side your rednet modem is on
while locker do
attempted_login = false
term.clear()
term.setCursorPos(1,1)
print("Welcome to a USERS PC : Roaming Profile Enabled")
print("What would you like to do?")
print("[1] Login (*)")
print("[2] Shutdown")
write("> ")
local input = read()
if input == "2" then
os.shutdown()
elseif input == "1" then
attempted_login = true
print("Please login...")
write("Username: ")
local username = read()
write("Password: ")
local password = read("*")
rednet.send(password_server, username, true)
senderId, message, distance = rednet.receive(5)
if password == message then
failed = false
locker = false
term.clear()
term.setCursorPos(1,1)
print("Welcome ", username)
else
print("Invalid Username or Password.")
sleep(3)
end
else
print("Command not recognised...")
sleep(2)
end
end

== Thoughts and Notes ==
''Note: You do not have to read these if you use the new system.'' 
Although this may work very well as a login system, it is insecure by the flaw that a malicious sniffer can unnoticeably obtain a copy of the password while it is being sent as described on the [[Rednet_(API)|Rednet API]] page, and use the password to login.

If you change the client code, to "startup" and put it in the root directory, it works very well as a login system.
You may also want to put in the line
os.pullEvent = os.pullEventRaw -- disables Ctrl+T
as if it doesn't work first time it can be difficult to get out of the program.

If you have either Railcraft or Additional Pipes, find the 'World Anchor' or 'Teleport Tether' block. If your server can afford the resources, place the block within a 3x3 grid of your password server. It will ensure that even if you leave the chunk, the password server still is operational. Otherwise you may find that you cannot login because you've left the chunk and the password server is no longer dealing with requests.

This is a minor security flaw but it is only if someone has access to a computer that is 'whitelisted' to access the password server. The security flaw is that if they use the password Not Valid on that computer they are allowed access;

if valid then
--send client password
else
--send client Not Valid
end

to fix remove the else statement

[[Category:Programs]]

Turtle GPS self-tracker expansion (tutorial)

2013-08-28T05:51:57Z

Latias1290:

Turtle GPS self-tracker expansion (tutorial)

2013-08-28T05:51:48Z

Latias1290:

User talk:AfterLifeLochie

2013-08-28T05:51:28Z

Latias1290: /* Why did you revert my edits? */

Another test. Ignore this.

== Why did you revert my changes on the function and example templates? ==

The 24px ones were really small and blurry. --[[Special:Contributions/67.189.72.22|67.189.72.22]] 13:17, 3 December 2012 (MSK)
* The templates are optimized for screen-readers at present, and are only meant to be a complimentary object. In addition, the files themselves are actually blurry and aren't rendered in high-enough definition. If and when I get FTP access, I can setup a better system than the current one, but the most important point; ''please don't edit live production templates without using a sandbox''. The effects of a template bungle could be a potential eye-sore. ''[[User:AfterLifeLochie|AfterLifeLochie]] 13:22, 3 December 2012 (MSK)''

== APT Minecraft Tekkit window. ==

Lochie, I was viewing your new forum thread on ComputerCraft APT and realised you were running Tekkit. I am glad that not all of the Mod Admins are so hardcoming on the Technic Team. Yours, [[User:Jonjon1234|Jonjon1234]] 15:51, 14 December 2012 (MSK)

== Program Listing? ==

Question for you: As a rookie to CC, I find it really hard to track down APIs or Programs in the forums for such. Sites like Turtlescripts have spawned trying to be a better browseable index of programs.

Would it make sense to have a Program Catalog on the site? I was thinking relatively lightweight, a table with the name, author, summary, current supported version, and a link to the Programs forum thread for it. Possibly have different sections for the major groupings, such as API, OS, Turtles, etc. I can do a mock-up version of what I'm describing if I'm describing poorly. Having posted a couple programs (and more to come), I'd have no issue creating a forum thread, then adding it to a Wiki page. I'd prefer the visibility. [[User:Rihlsul|Rihlsul]] 07:04, 27 March 2013 (MSK)

== Why did you revert my edits? ==

I just noticed my new version on [[Login_with_Roaming_Profiles|this page]] was removed, can you please tell me why? [[User:Latias1290|Latias1290]] 05:45, 28 August 2013 (GMT)

* Do not paste copyrighted or 'copyrighted' code, text or images on the ComputerCraft Wiki. By pasting code, text and content you release it to the public domain and I cannot assert you own said code due to the comments and 'copyright lines'. ''[[User:AfterLifeLochie|AfterLifeLochie]] 05:50, 28 August 2013 (GMT)''
::I thought it was fine because "Dirk Kok" is my real name, but Ill leave it out. [[User:Latias1290|Latias1290]] 05:51, 28 August 2013 (GMT)

User talk:AfterLifeLochie

2013-08-28T05:45:19Z

Latias1290: /* Why did you revert my edits? */ new section

Turtle GPS self-tracker expansion (tutorial)

2013-08-28T05:42:59Z

Latias1290: Created page with "This tutorial will teach you how to make a Turtle more efficient in keeping track of its location when using the GPS API. This is essentially an API that use..."

This tutorial will teach you how to make a [[Turtle]] more efficient in keeping track of its location when using the [[Gps_(API)|GPS API]]. This is essentially an API that uses the native Turtle movement API while using its own movement as a sensor to keep track of its location, so it only requires a GPS signal once, until it is turned off. This API requires every Turtle you want to use the API with to have it installed. I recommend using an [[Advanced_Computer|Advanced Computer]] to write it on, move it to a [[Disk]] with a [[Disk_Drive|disk drive]] and moving it to the Turtle. Alternatively, if you are on Singleplayer or a Multiplayer admin and have access to the mod file, you can move it into the turtle/rom folder to have it automatically installed on every new turtle that is placed.

Important: When starting, the program assumes that it is facing west, so first you must face West and then place the turtle. Here are some ways to check where you are facing:
You can see the sun/moon rising right in front of you. You are facing East.
You can see the sun/moon falling right in front of you. You are facing West.
Clouds go west. Check where they go.
Press F3 and locate the number behind "f". This one is below "x", "y" and "z". If this number is 0, you are facing North. If this number is 1, you are facing West. If this number is 2, you are facing South. If this number is 3, you are facing East.

== Code ==
''Note: This will only work on a Turtle. That said, even if it worked on a [[Computer|computer]], it wouldnt have any practical use because a computer cant move.'' 
Before you start, you must add this to the program that you want to use it with at the top line:
os.loadApi("tst")
This will allow the program to use the API. This tutorial assumes that you use the file name "tst" for the API, but if you like to you can change it. You must then also change every reference to "tst" in your program, including the line above.
Write this in the computer/turtle:

-- Turtle Self-tracking System created by Latias1290.
-- Copyright (c) Dirk Kok 2013.

local xPos, yPos, zPos = nil
face = 1
cal = false

function setLocation() -- get gps using other computers
xPos, yPos, zPos = gps.locate()
cal = true
end

function manSetLocation(number x, number y, number z) -- manually set location
xPos = x
yPos = y
zPos = z
cal = true
end

function getLocation() -- return the location
if xPos != nil then
return xPos, yPos, zPos
elseif xPos == nil then
return nil
end
end

function turnLeft() -- turn left
if face == 0 then
face = 1
elseif face == 1 then
face = 2
elseif face == 2 then
face = 3
elseif face == 3 then
face = 0
end
end

function turnRight() -- turn right
if face == 0 then
face = 3
elseif face == 1 then
face = 0
elseif face == 2 then
face = 1
elseif face == 3 then
face = 2
end
end

function forward() -- go forward
turtle.forward()
if cal == true then
if face == 0 then
zPos = zPos - 1
elseif face == 1 then
xPos = xPos - 1
elseif face == 2 then
zPos = zPos + 1
elseif face == 3 then
xPos = xPos + 1
end
else
print("Not Calibrated.")
end
end

function back() -- go back
turtle.back()
if cal == true then
if face == 0 then
zPos = zPos + 1
elseif face == 1 then
xPos = xPos + 1
elseif face == 2 then
zPos = zPos - 1
elseif face == 2 then
xPos = xPos - 1
end
else
print("Not Calibrated.")
end
end

function up() -- go up
turtle.up()
if cal == true then
yPos = yPos + 1
else
print("Not Calibrated.")
end
end

function down() -- go down
turtle.down()
if cal == true then
yPos = yPos - 1
else
print("Not Calibrated.")
end

function jump() -- perform a jump. useless? yup!
turtle.up()
turtle.down()
end

== How to Use ==
This might seem daunting at the first moment. But dont worry, I will walk you through it. Note that to use it properly, you must always put "tst." in front of it, or how you named it followed by a dot. So if I wanted to have my turtle go 1 block forward, I typed "tst.forward()". Note that if you do not do either tst.getLocation OR tst.setLocation(coords), the API will print "Not Calibrated." every time you use a command. This will not prevent you from using it, however.

=== setLocation ===
To use this, you will need at least 4 computers equipped with a Wireless Modem, and having it host a GPS. More info about that [[Gps_(API)|here]] and [[Gps_(program)|here]].

=== manSetLocation ===
For this one you will need to know the location of your turtle. Any location will work, but the API loses its point if you use another coordinate set.
A good way to obtain the coordinates is to open up the debug screen(press F3), stand on the turtle, write down the x, y and z fields, substract 1 from the Y coordinate and use these.

=== getLocation ===
This one is pretty simple. It returns the coordinates. Note that you will have to overwrite all of them.
For example, if we had the variables x, y and z, and we wanted to have the value set to our location, we did this:
x, y, z = tst.getLocation()
Simple right? Note that this will return nil if you are not calibrated, which means if you do it before you do setLocation or manSetLocation, x, y and z will be null!

=== forward, back, up, down, turnLeft and turnRight ===
This one is pretty easy as well. It makes your turtle move 1 block in the direction you used(its obvious which function goes where) and update its location according to where it went.

=== jump ===
This one works a bit different. It makes the turtle go up, then go down. "But thats useless!" you might say, and indeed it is!

Turtle

2013-08-28T04:10:16Z

Latias1290: /* its correct */

'''Turtles''' are essentially robots, and were added in the 1.3 update. They run an OS, like the [[Computer|Computers]], named [[TurtleOS]]. They have the ability to place, break and detect blocks, move around and drop items in their inventory. The programs they run are stored on its internal memory or [[Floppy Disk|floppy disks]].

The 1.4 update was focused on turtles, and expanded the turtle's ability to use tools. Turtles are capable of using pickaxes, hoes, axes, shovels and swords. The update added "Crafty Turtles", which have the ability to craft using their inventory - and part of this upgrade saw the number of inventory slots in the Turtle raised to 16 - over the previous 9 slot inventory. The 1.4 update also included a new fuel system for the turtles.

The 1.55 update added advanced turtles. Advanced Turtles are made of gold and are able to display color and have mouse input on their display. Their exterior looks are also gold. They're just like [[Advanced Computer|Advanced Computers]].

Turtles are submersible and lavaproof. As such, they are extremely useful for mining near bedrock, where heavy lava flows can prevent access to diamonds and other rare finds.

If you would like to know more about how to program them, have a look at the [[Turtle (API)|Turtle API]].

Keep in mind, that turtles will not keep their programs unless they are labelled. To do so, you simply need to type in "label set labelName". This will label your turtle with the specified label, in this case "labelName".

==Floppy Disks and Peripherals==
Turtles do not have a built-in [[Disk Drive]]. As such, they need a [[Disk Drive]] placed beside them to access [[Floppy Disk|Floppy Disks]]. However, if the Turtle is of the Wireless family, the [[Disk Drive]] (and other peripherals) must be placed on a side other than the side the [[Wireless Modem|wireless modem]] is on. Any other peripherals, such as [[Monitor|Monitors]] and [[Printer|Printers]] can be interacted using the peripheral API.

==Power source==
Turtles require fuel to operate - this means Turtles must be powered from any item that works in a regular furnace, like coal and lava. The turtle gains 0.6 "movement" per half second the fuel would have burnt in a furnace. The Turtle can move 1 block for each fuel count it has, for example, coal yields 96 block movements. For more information, go to the [[Turtle.refuel]] page.

=== Optional Non-fuel mode ===
In this mode, Turtles use their internal Redstone Engine, and as such, they do not need to be re-charged, or receive any other form of external power. This is because Redstone continuously emits low levels of energy, and the Turtle's engine is very efficient. This mode can be turned on by editing the turtle config file (config/mod_CCTurtle.cfg) and setting <var>turtleNeedsFuel</var> to <var>0</var>.

==Farming==
Turtles equipped with a [[diamond hoe]] can till dirt so it can later be used for Farming. An example of a use for this would be using it to till, plant, and harvest your wheat farm and dropping any product in a chest for you.

==Mining==
Turtles crafted with a [[diamond pickaxe]], [[diamond axe]], or [[diamond shovel]], can break blocks, chop wood, mine stone and ores, and even break dirt and gravel (depending on the tool you used on it). The tools equipped on the Turtle have no durability, and so can be used indefinitely without the need for any additional materials. When a Turtle breaks the block, the Turtle receives the item directly into it's inventory. Different tools yield different drops - for example, an axe can break anything, but it won't drop ores.

==Crafting==
Turtles with a [http://www.minecraftwiki.net/wiki/Crafting_Table Crafting Table] can craft items if they have the correct materials to do so, and all other slots outside the crafting-zone are empty.

==Melee==
Turtles equipped with a [[diamond sword]] can attack players and mobs. When a Turtle kills a mob it will leave the experience orbs on the ground, but add the loot to its inventory. Turtles can also attack with any tool, where the [[diamond axe]] is the second best after the [[diamond sword]].

==Inventory Interaction==
Turtles can interact with blocks that have inventories. This includes chests, furnaces, [[Printer|printers]] and even blocks with inventories in other mods. (This means a turtle cannot interact with a player's inventory, unless you use a third party peripheral). Turtles can interact with such inventories by using [[Turtle.suck|turtle.suck, turtle.suckDown, turtle.suckUp]] (To retrieve the first item in the inventory. The turtle finds the first item by scanning the first row from left to right, then the second row from left to right, etc.) Turtles can also place items inside inventories, by using [[Turtle.drop|turtle.drop, turtle.dropUp, turtle.dropDown]], which places items on the first item slot available (Using the same system as the one described for retrieving items).

In special inventories, with just a few slots on the top or bottom, for example furnaces, you can specify which slot to place an item in by positioning the turtle in the corresponding location to the front face of the inventory. For example in a furnace, you would use a turtle at the bottom of the furnace for it to place fuel in the furnace, a turtle at the top to place objects to smelt, and a turtle to the right to retrieve the smelted objects (Note that you can do this with just 1 turtle moving around)

==Recipes==

{|
|+'''Crafting ingredients'''
|-
|Turtle
|{{Crafting grid
|A1=iron_ingot |B1=iron_ingot |C1=iron_ingot
|A2=iron_ingot |B2=Computer |C2=iron_ingot
|A3=iron_ingot |B3=chest |C3=iron_ingot
|Output=turtle |Output-link=turtle
}}
|Advanced Turtle
|{{Crafting grid
|A1=Gold_Ingot |B1=Gold_Ingot |C1=Gold_Ingot
|A2=Gold_Ingot |B2=Computer |C2=Gold_Ingot
|A3=Gold_Ingot |B3=chest |C3=Gold_Ingot
|Output=Advanced_Turtle |Output-link=turtle
}}
|}
Turtles can be equipped with different peripherals and tools. A turtle can only have one tool and one peripheral, however the crafting table can act as a tool, or peripheral.
 The following tools can be equipped to a turtles: [[diamond pickaxe]], [[diamond axe]], [[diamond shovel]], [[diamond hoe]] and [[diamond sword]]
 The following peripherals can be equipped to a turtles: [[Wireless Modem|wireless modem]] and [[Workbench|crafting tables]].
 Diamond tools must be unused (i.e. not have a durability bar showing) to combine with a turtle.
 '''Turtle recipe and examples for equipping a turtle with tools and peripherals (Note that any variants of the turtle can also be crafted with the Advanced Turtle).'''
{| class="wikitable"
! !! None !! Crafty !! Wireless
|-
! scope="row"| None
|{{Crafting grid
|B2=turtle
|Output=turtle |Output-link=turtle
}}
|{{Crafting grid
|B2=turtle |A2=workbench
|Output=Crafty_Turtle |Output-link=turtle
}}
|{{Crafting grid
|B2=turtle |A2=Modem
|Output=wireless_turtle |Output-link=turtle
}}
|-
! scope="row"| Mining
|{{Crafting grid
|B2=turtle |C2=diamond_pickaxe
|Output=mining_turtle |Output-link=turtle
}}
|{{Crafting grid
|A2=workbench |B2=turtle |C2=diamond_pickaxe
|Output=Crafty_Mining_Turtle |Output-link=turtle
}}
|{{Crafting grid
|A2=Modem |B2=turtle |C2=diamond_pickaxe
|Output=wireless_mining_turtle |Output-link=turtle
}}
|-
! scope="row"| Farming
|{{Crafting grid
|B2=turtle |C2=diamond_hoe
|Output=Farming_Turtle |Output-link=turtle
}}
|{{Crafting grid
|A2=workbench |B2=turtle |C2=diamond_hoe
|Output=Crafty_Farming_Turtle |Output-link=turtle
}}
|{{Crafting grid
|A2=Modem |B2=turtle |C2=diamond_hoe
|Output=Wireless_Farming_Turtle |Output-link=turtle
}}
|-
! scope="row"| Melee
|{{Crafting grid
|B2=turtle |C2=diamond_sword
|Output=Melee_Turtle |Output-link=turtle
}}
|{{Crafting grid
|A2=workbench |B2=turtle |C2=diamond_sword
|Output=Crafty_Melee_Turtle |Output-link=turtle
}}
|{{Crafting grid
|A2=Modem |B2=turtle |C2=diamond_sword
|Output=Wireless_Melee_Turtle |Output-link=turtle
}}
|-
! scope="row"| Felling
|{{Crafting grid
|B2=turtle |C2=diamond_axe
|Output=Felling_Turtle |Output-link=turtle
}}
|{{Crafting grid
|A2=workbench |B2=turtle |C2=diamond_axe
|Output=Crafty_Felling_Turtle |Output-link=turtle
}}
|{{Crafting grid
|A2=Modem |B2=turtle |C2=diamond_axe
|Output=Wireless_Felling_Turtle |Output-link=turtle
}}
|-
! scope="row"| Digging
|{{Crafting grid
|B2=turtle |C2=diamond_shovel
|Output=Digging_Turtle |Output-link=turtle
}}
|{{Crafting grid
|A2=workbench |B2=turtle |C2=diamond_shovel
|Output=Crafty_Digging_Turtle |Output-link=turtle
}}
|{{Crafting grid
|A2=Modem |B2=turtle |C2=diamond_shovel
|Output=Wireless_Digging_Turtle |Output-link=turtle
}}
|-
! scope="row"| Crafty
|See Above
|N/A
|{{Crafting grid
|A2=Modem |B2=turtle |C2=workbench
|Output=Wireless_Crafty_Turtle |Output-link=turtle
}}
|}

{{BlocksItemsList}}
[[Category:Blocks]]

Login with Roaming Profiles

2013-08-28T03:53:04Z

Latias1290:

This tutorial covers how to make a password server and a password client. The server will host a Lua table of usernames and passwords and the client will remotely connect each start up, ask the user for their username and password and compare it to that on the password server.

__TOC__

== Setting Up ==
First of all, you must know how to craft a [[Wireless_Modem|wireless modem]] and a [[Computer|computer]]. You need to craft at least 2 wireless modems and 2 computers if you want to have a practical use for this system. Then, attach 1 modem to each computer you want to add to the system.

Second, since typing on normal computers is relatively slow and annoying, I recommend to write the programs in [[Advanced_Computers|advanced computers]](because in advanced computers you can click to move the cursor around, and there are colors to distinguis between different statements), copying them into a [[Floppy|disk]] and moving them into each computer you want to include(with their respective programs of course). Alternatively, if you are the server owner(this tutorial assumes you are in Multiplayer because this system does not have any practical use in Singleplayer), you can go into the world folder and write copy/paste the source code into the folders of each computer you want to use. The folders you should use are the named the IDs of the computers(so if you have 3 computers, with the IDs 5, 7 and 9, you should copy them into the folders 5, 7 and 9).

It does not matter wether you are using Normal or Advanced computers for this tutorial. I recommend to use Normal ones for the server.

When writing the programs, I HIGHLY recommend using a [[Disk_Drive|disk drive]] like stated above, so you dont have to write in prograns for every computer you add.
Remember to read the text behind the --. These are comments, and you can safely leave them in the code.

== Server ==
print("Initializing...")
local validSender = false
valid = false
tserved, vserved, dserved = 0

print("Loading startup settings...")
count = true -- If you dont want the server to count request statics, set the value of this variable to "false" without qoutes.
modemSide = "left" -- change to the side of the computer your modem is on
whitelist = true -- If you dont want to use a whitelist, change the value to "false" without quotes. This is not recommended on Multiplayer, but it does not make any difference on a Singleplayer World.

print("Loading user database...")
users = {"username1", "username2" } -- Change this to the names for the users you want to have. Make sure the usernames are in the same order as in the password table. Changing the order is fine, but you must maintain the same order in both the users and passwords tables. Incorrect orders WILL cause 2 or more users not being able to log in!
passwords = {"password1", "password2" } -- Change this to the passwords for the users defined in the variable above. Again, make sure the passwords for users are in the same order as the usernames.
senders = { 1, 2, 3, 4 } -- change this to the ID's of the all computers you want to accept requests from if you use a whitelist. If you do not use a whitelist, DO NOT REMOVE THIS LINE! Doing so will cause the program to crash everytime it is run, even though the variable is not used.

print("Loading core functions...")
function clear()
term.clear()
term.setCursorPos(1, 1)
print("CCLS Server 1.0 for CC 1.53 (Copyright (c) Dirk Kok 2013)")
print("There is no user interaction here. Please contact your system administrator for assistance regarding the system.")
if count == true then
print(tserved.." total requests received this session.")
print(vserved.." requests completed this session.")
print(dserved.." requests denied this session.")
elseif count == false then
print("Request statics have been disabled.")
else
rednet.close(modemSide)
term.clear()
term.setCursorPos(1, 1)
print("Error: Counter setting is not boolean and the server can not continue.")
print("The server program will exit automatically in 10 minutes. Or you can hold down Ctrl+T for 1 second.")
print("After that, please set the variable \"count\" in the source code to either \"true\" or \"false\" WITHOUT QUOTATION MARKS. Doing this with quotation marks will cause the same error.")
sleep(600)
shell.exit()
end

print("Starting up...")
rednet.open(modemSide) -- Opens the modem to wait for incoming login requests

clear()

while true do
validSender = false
senderId, message, distance = rednet.receive()
for i,v in ipairs(senders) do
tserved = tserved + 1
if v == senderId then
validSender = true
break
else
rednet.send(senderId, "301", true) -- Send response code 301 - which means Not Whitelisted.
dserved = dserved + 1
clear()
end
end
if validSender then
for i,v in ipairs(users) do
if message == v then
password = passwords[i]
rednet.send(senderId, password, true)
vserved = vserved + 1
clear()
break
else
rednet.send(senderId, "300", true) -- Send response code 300 - which means Bad Auth.
dserved = dserved + 1
clear()
end
end
end
end

== Client ==
os.pullEvent = os.pullEventRaw
local failed = true
busr = "nsliq" -- If you ever happen to be unable to log in for some reason, you can use this username as a backup.
bpass = "zuFUkVEjQKjkLQhTdpFMheNF" -- If you ever happen to be unable to log in for some reason, you can use this password as a backup.

password_server = 0 -- change to the ID of your password server computer
rednet.open("left") -- change to the side your rednet modem is on
while true do
term.clear()
term.setCursorPos(1,1)
print("Welcome to CCLS 1.0.")
print("Please select an option.")
print("[1] Login")
print("[2] Shutdown")
write("> ")
input = read()
if input == "2" then
os.shutdown()
elseif input == "1" then
print("Please login.")
write("Username: ")
username = read()
write("Password: ")
password = read("*")
if username == busr then
if password == bpass then
print("Access granted")
break
end
end
rednet.send(password_server, username, true)
senderId, message, distance = rednet.receive(5)
if message == "300" then
print("Invalid Username or Password.")
sleep(3)
elseif password == message then
failed = false
term.clear()
term.setCursorPos(1,1)
print("Welcome ", username)
break;
else
print("Invalid Username or Password.")
sleep(3)
end
else
print("Invalid Command.")
sleep(2)
end
end

== Old Server ==
''Note: This is here for reference for people who need the older version. I recommend using the programs above.''

os.pullEvent = os.pullEventRaw
term.clear()
term.setCursorPos(1,1)
print("This is a password server. There is no user interaction here.")
print("Please find a computer and login there.")
local firstCycle = true
local validSender = false
local modemSide = "left" -- change to the side of the computer your modem is on
local valid = false
users = {"username1", "username2" } --make sure users and passwords line up
passwords = {"password1", "password2" }
senders = { 1, 2, 3, 4 } -- computer ID's of the computers you want to accept requests from
function bootUp()
rednet.open(modemSide)
end
while true do
validSender = false
if firstCycle then
bootUp()
firstCycle = false
end
senderId, message, distance = rednet.receive()
for i,v in ipairs(senders) do
if v == senderId then
validSender = true
break
end
end
if validSender then
for i,v in ipairs(users) do
if message == v then
valid = true
password = passwords[i]
break
else
valid = false
end
end
if valid then
rednet.send(senderId, password, true)
else
rednet.send(senderId, "Not Valid", true)
end
end
end

== Old Client ==

os.pullEvent = os.pullEventRaw
local locker = true
local failed = true
local attempted_login = true
local password_server = 0 -- change to the ID of your password server computer
rednet.open("left") -- change to the side your rednet modem is on
while locker do
attempted_login = false
term.clear()
term.setCursorPos(1,1)
print("Welcome to a USERS PC : Roaming Profile Enabled")
print("What would you like to do?")
print("[1] Login (*)")
print("[2] Shutdown")
write("> ")
local input = read()
if input == "2" then
os.shutdown()
elseif input == "1" then
attempted_login = true
print("Please login...")
write("Username: ")
local username = read()
write("Password: ")
local password = read("*")
rednet.send(password_server, username, true)
senderId, message, distance = rednet.receive(5)
if password == message then
failed = false
locker = false
term.clear()
term.setCursorPos(1,1)
print("Welcome ", username)
else
print("Invalid Username or Password.")
sleep(3)
end
else
print("Command not recognised...")
sleep(2)
end
end

== Thoughts and Notes ==
''Note: You do not have to read these if you use the new system.'' 
Although this may work very well as a login system, it is insecure by the flaw that a malicious sniffer can unnoticeably obtain a copy of the password while it is being sent as described on the [[Rednet_(API)|Rednet API]] page, and use the password to login.

If you change the client code, to "startup" and put it in the root directory, it works very well as a login system.
You may also want to put in the line
os.pullEvent = os.pullEventRaw -- disables Ctrl+T
as if it doesn't work first time it can be difficult to get out of the program.

If you have either Railcraft or Additional Pipes, find the 'World Anchor' or 'Teleport Tether' block. If your server can afford the resources, place the block within a 3x3 grid of your password server. It will ensure that even if you leave the chunk, the password server still is operational. Otherwise you may find that you cannot login because you've left the chunk and the password server is no longer dealing with requests.

This is a minor security flaw but it is only if someone has access to a computer that is 'whitelisted' to access the password server. The security flaw is that if they use the password Not Valid on that computer they are allowed access;

if valid then
--send client password
else
--send client Not Valid
end

to fix remove the else statement

[[Category:Programs]]