https://github.com/skx/turtle
A simple turtle-implementation, using FORTH as a scripting-language
https://github.com/skx/turtle
forth forth-like go golang scripting-engine scripting-language
Last synced: 10 months ago
JSON representation
A simple turtle-implementation, using FORTH as a scripting-language
- Host: GitHub
- URL: https://github.com/skx/turtle
- Owner: skx
- Created: 2020-09-21T14:49:18.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-09-24T03:31:05.000Z (over 5 years ago)
- Last Synced: 2024-05-21T10:59:02.433Z (over 1 year ago)
- Topics: forth, forth-like, go, golang, scripting-engine, scripting-language
- Language: Go
- Homepage:
- Size: 589 KB
- Stars: 4
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# turtle
This repository contains a trivial implementation of a turtle-graphics
thing.
We've embedded a simple [FORTH Interpreter](https://github.com/skx/foth) and
we use that to allow the user to run scripts to control the standard turtle.
## Usage
Run the application with the path to a script:
./turtle ./foo.in
The generated output will be saved in `turtle.png`, and an animation will be saved alongside it as `turtle.gif`:
Rendered output of [_examples/squares.4th](_examples/squares.4th):
Animated output of [_examples/squares.4th](_examples/squares.4th), showing how it was created:
You can find example scripts beneath [_examples/](_examples/)
## Words
The following words are defined in [words.go](words.go) (and connected to the interpreter in `main.go`):
* `direction`
* Pop one word from the stack, set the direction to that value.
* `forward`
* Pop one word from the stack, move that much forward.
* `move`
* Pop two words off the stack, move to the specified coordinates.
* Note `move` is like a teleport, there is no drawing involved.
* `pen`
* Pope one word from the stack, if 0 lift the pen, else lower it.
* Drawing only occurs when the pen is down.
* `save`
* Saves the current state of the paper, and the animation of how we got there.
* `turn`
* Pop one word from the stack, increase the movement direction by that many degrees.
# Github Setup
This repository is configured to run tests upon every commit, and when pull-requests are created/updated. The testing is carried out via [.github/run-tests.sh](.github/run-tests.sh) which is used by the [github-action-tester](https://github.com/skx/github-action-tester) action.