https://github.com/pistondevelopers/piston-tutorials

Tutorials for Piston
https://github.com/pistondevelopers/piston-tutorials

Last synced: 12 months ago
JSON representation

Tutorials for Piston

• Host: GitHub
• URL: https://github.com/pistondevelopers/piston-tutorials
• Owner: PistonDevelopers
• Created: 2014-07-07T01:55:52.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2024-05-22T00:27:50.000Z (about 2 years ago)
• Last Synced: 2025-06-24T21:51:39.845Z (12 months ago)
• Language: Rust
• Homepage:
• Size: 539 KB
• Stars: 548
• Watchers: 56
• Forks: 89
• Open Issues: 26
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Piston-Tutorials [![Build Status](https://travis-ci.org/PistonDevelopers/Piston-Tutorials.svg)](https://travis-ci.org/PistonDevelopers/Piston-Tutorials)

This is a repository for examples of Piston projects that have are

accompanied by written tutorials explaining core concepts for that

tutorial.

## Current Tutorials

#### [Getting Started Spinning Square](./getting-started)

A "tutorial" with instructions on compiling and running a very

simple Piston.

#### [Sudoku](./sudoku) (work in progress)

Write a Sudoku game with Piston.

#### [Roguelike](./roguelike) (work in progess)

Write a Roguelike game with Piston.

## Planned Tutorials

* graphics

* piston

## Troubleshooting

* [I get `ld: library not found for -lSDL2` error on OSX](https://github.com/PistonDevelopers/rust-empty/issues/175)

* I get "GL context creation failed" when running an example.

  It's likely your hardware or driver doesn't support PistonWindow's default OpenGl spec. Just change it to something

  you can support at the beginning of the example. See hello_world.rs for an example.

## Making changes to the tutorials

Because most of the tutorials will contain heavy amounts of 

code, TyOverby developed a markdown pre-processor that takes 

`readme.dev.md` files and includes code from the surrounding 

project.  This way you don't need to make a change in the code

for the tutorial and then also make the same change in the 

readme.md file; the preprocessor will do that for you!

In order to run the pre-processor, simply invoke `cargo run` 

from the root directory (not the sub-tutorial directory) and 

it will rebuild all the markdown files that it knows about.

[How to contribute](https://github.com/PistonDevelopers/piston/blob/master/CONTRIBUTING.md)