*-------------------------*
**** Lua Turtle ReadMe ****
*------------------V-1.11-*


*** Requirements: ***
Lua Turtle requires Microsoft's DirectX(R) 9.0c runtime as well as 100% compatible graphics hardware and drivers (check http://www.microsoft.com/windows/directx/ for details).
If you receive an error message about a missing DLL file, this can most likely be fixed by installing the latest version of DirectX.
The Lua Turtle window is by default 800x600 pixels big, although a minimum resolution of 1024x768 is strongly recommended.


*** Usage: ***
	LUATurtle.exe scriptfile.lua

You may start Lua Turtle either from the console or by dragging a scriptfile onto LUATurtle.exe. Lua Turtle supports the full featureset of the Lua 5.1 language specification, including all standard libraries and BitLib.
A full reference of the commands available for controlling the turtle can be found further down.


*** How it works ***
Lua Turtle is a very simple implementation of a LOGO-like turtle plotter. You control the turtle by giving commands like Go() or TurnLeft(). Wherever the turtle goes, it leaves a line behind, marking the route it went.

At the beginning, the turtle is placed in the middle of the screen at (0,0) facing the right border of the window:

*--------------------------------------*
|                                      |
|                                      |
|                                      |
|                                      |
|                                      |
|                  X->                 |
|                                      |
|                                      |
|                                      |
|                                      |
*--------------------------------------*

The upper left corner of the window has the coordinates (-400, 300).
Take a look at the enclosed examples for further details.


*** Reference ***
Commands available for the turtle.* library:

* turtle.Go(dist)
    Move the turtle forward in the direction it is currently facing
    IN: dist (number)                    - number of units that the turtle should move forward
    RETURN: posX (number), posY (number) - coordinates of the turtle's new position

* turtle.TurnLeft(angle)
    Turn the turtle counter-clockwise
    IN: angle (number)      - angle in degrees that the turtle should turn
    RETURN: tangle (number) - angle that the turtle is facing after the turn

* turtle.TurnRight(angle)
	Turn the turtle clockwise
    IN: angle (number)      - angle in degrees that the turtle should turn
    RETURN: tangle (number) - angle that the turtle is facing after the turn

* turtle.Reset()
	Reset the turtle to its initial position and angle. Does not draw a line, regardless of pen state.
	IN: None.
	RETURN: None.

* turtle.Show()
	Show the current position of the turtle on the screen.
	IN: None.
	RETURN: None.

* turtle.Goto(x, y)
	Move the turtle to the specified position
	IN: x (number), y (number) - coordinates the turtle should be moved to
	RETURN: None.

* turtle.SetAngle(angle)
	Change the angle that the turtle is facing to a given value
	IN: angle (number) - new angle in degrees
	RETURN: None.

* turtle.PenDown()
    Change the pen state to down (lines are drawn everytime the turtle is moving)
	IN: None.
	RETURN: None.

* turtle.PenUp()
	Change the pen state to up (no lines are drawn when the turtle is moving)
	IN: None.
	RETURN: None.

* turtle.PenToggle()
	Toggle the pen state (switch to up if it was formerly down and vice versa)
	IN: None.
	RETURN: pstate (boolean) - New pen state (true=down, false=up)

* turtle.SetColor([color | r,g,b])
    Change the color of the lines the turtle is drawing. Default is white.
	IN: color (string)                     - can be either blue, red, green, orange, yellow, pink, purple, grey or black
	    r (number), g (number), b (number) - numbers between 0 and 255 specifying the new color
	RETURN: None.


Feel free to contact me:
URL:  http://www.ghulbus-inc.de/
Mail: der_ghulbus@ghulbus-inc.de

Any feedback greatly appreciated!