noeddl / turtle

Create Animated Drawings in Rust

turtle

Tweet your drawings to us on Twitter at @RustTurtle and follow us to see what is being created!

Create animated drawings with the Rust programming language. This crate is a tool for teaching programming by drawing pictures. Learning this way is fun and interesting for people of all ages!

The idea: You control a turtle with a pen tied to its tail. As it moves across the screen, it draws the path that it follows. You can use this to draw any picture you want just by moving the turtle across the screen.

Documentation

• Website
• API Documentation

Example

As a simple example, you can draw a circle with only the following code:

use turtle::Turtle;

fn main() {
    let mut turtle = Turtle::new();

    for _ in 0..360 {
        // Move forward three steps
        turtle.forward(3.0);
        // Rotate to the right (clockwise) by 1 degree
        turtle.right(1.0);
    }
}

This will produce the following:

See the examples/ directory for more examples of how to use this crate.

Need help?

The following are some resources you can use to find help when you run into a problem. The links are listed in the order you should try each one, but feel free to come to the Turtle Zulip anytime if you are lost.

• Help with the Rust Language - Google, Stack Overflow, Rust Users Forum, Turtle Zulip
• Help with Turtle - Stack Overflow, Turtle Zulip, Google, Rust Users Forum
• Found a bug? - Open an issue (feel free to ask about your bug in the Turtle Zulip if you are not sure)

Contributing

See CONTRIBUTING.md for information about contributing to this project including how to build and test the project, submit new examples, report bugs, and more.

Inspiration & Goals

This crate is inspired by the Logo educational programming language. Many languages contain implementations of Logo's "turtle graphics". For example, the Python programming language comes with a built-in turtle module. This crate is largely inspired by the Python implementation, but uses Rust conventions and best practices to provide the best possible platform for learning Rust.

The goal of this crate is to be as easy to approach as possible and also provide the opportunity to explore Rust's most advanced features. We welcome contributions from anyone and everyone, including those that are new to the Rust programming language.