Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arthurealike/turtle.lua
Turtle graphics library for LÖVE.
https://github.com/arthurealike/turtle.lua
drawing lua lua-library pure-lua simple turtle turtle-library
Last synced: 3 months ago
JSON representation
Turtle graphics library for LÖVE.
- Host: GitHub
- URL: https://github.com/arthurealike/turtle.lua
- Owner: arthurealike
- License: mit
- Created: 2020-07-23T18:12:46.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2020-10-09T11:29:34.000Z (over 3 years ago)
- Last Synced: 2024-01-24T08:08:12.719Z (5 months ago)
- Topics: drawing, lua, lua-library, pure-lua, simple, turtle, turtle-library
- Language: Lua
- Homepage:
- Size: 11.8 MB
- Stars: 86
- Watchers: 5
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-love2d - turtle.lua - Turtle graphics library for LÖVE. (Drawing)
README
# turtle.lua [](https://github.com/arthurealike/turtle.lua/blob/master/README.md)
#### Minimalist drawing library is inspired by **[turtle graphics](https://docs.python.org/3/library/turtle.html#module-turtle)** , written in **lua** for **löve2d**.
# Prerequisite
* **Get [LÖVE](https://love2d.org/)**
# How to use
*Create a **turtle** instance. Give it your commands and call its **draw()** function in **love.draw()**, That's it!*
**[View methods in detail](https://github.com/arthurealike/turtle.lua/blob/master/methods.md)**
### To draw a triangle:
```lua
local triangle = Turtle()
function love.load()
-- turtle.lua supports chain methods as you can see below
triangle:forward(60):left(120):forward(60):left(120):forward(60)
end
function love.draw()
triangle:draw()
end
```
### Result:
# Examples
We added some examples to introduce you turtle library.
See what we've done in [Examples](https://github.com/arthurealike/turtle.lua/blob/master/examples/examples.md)
### What is turtle?
As docs.python introduces:
> Turtle graphics is a popular way for introducing programming to kids. It was part of the original Logo programming language developed by Wally Feurzeig, Seymour Papert and Cynthia Solomon in 1967.
> Imagine a robotic turtle starting at (0, 0) in the x-y plane. After an import turtle, give it the command turtle.forward(15), and it moves (on-screen!) 15 pixels in the direction it is facing, drawing a line as it moves. Give it the command turtle.right(25), and it rotates in-place 25 degrees clockwise.
> By combining together these and similar commands, intricate shapes and pictures can easily be drawn.
# Turtle Methods
## 1. Turtle motion
* Move and draw
```lua
forward() | fd()
backward() | bk() | back()
right() | rt()
left() | lt()
tl()
rt()
circle()
setheading() | seth()
home()
go_to() | go() | setpos() | setposition()
setx()
sety()
undo(c)
speed()
```
* Turtle's state
```lua
position()
heading()
xcor()
ycor()
distance()
name()
nodecount()
print()
```
## 2. Pen control
* Drawing state
```lua
pendown() | pd() | down()
penup() | pu() | up()
pensize() | width()
isdown()
```
* Color control
```lua
color(...)
fillcolor(...)
turtlecolor()
```
* Filling
```lua
begin_fill()
end_fill()
```
* Drawing control
```lua
reset()
clear()
```
## 3. Turtle state
* Visibility
```lua
showturtle() | st()
hideturtle() | ht()
isvisible()
```
* Color
```lua
turtlecolor() | tc()
```
## 4. Event
```lua
ondrawfinish()
```
## 5. Animation
```lua
play()
pause()
toggle()
```
## 6. Debug
```lua
debugon()
debugoff()
drawDebug()
```
# Quick example
```lua
local line = Turtle()
local circle = Turtle(100,100,1)
local triangle = Turtle(100,150,1, {1, 1, 1})
function love.load()
local red = {1, 0, 0}
line:clear():right(35):forward(100)
circle:setcolor(1,1,1):penup()
for i=1, 360 do
circle:pendown():right(1):forward(2)
end
triangle:setcolor(red):left(60):forward(50):right(120):forward(50):left(60):backward(50)
end
function love.draw()
line:draw()
circle:draw()
rectangle:draw()
end
```
License
=======
> Copyright (c) 2020 Erkam Badın
>
> Permission is hereby granted, free of charge, to any person obtaining a copy
> of this software and associated documentation files (the "Software"), to deal
> in the Software without restriction, including without limitation the rights
> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
> copies of the Software, and to permit persons to whom the Software is
> furnished to do so, subject to the following conditions:
>
>
> Except as contained in this notice, the name(s) of the above copyright holders
> shall not be used in advertising or otherwise to promote the sale, use or
> other dealings in this Software without prior written authorization.
>
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
> SOFTWARE.