1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
//! # Quick Start
//!
//! Initialize with `new` and use `turn` to progress a game step. An example is in [game.rs](https://github.com/jspspike/snake/blob/master/examples/game.rs).
//!
//! Game without display
//! ```
//! use snake::{Snake, Direction};
//! let mut game = Snake::new(0, 10);
//!
//! game.turn(Direction::Down);
//! ```
//!
//! You can use the `display` feature flag to have a window displaying the game. This requires
//! [csfml](https://www.sfml-dev.org/download/csfml) to be installed.
//!
//! Game with display
//! ```ignore
//! use snake::{Direction, RenderWindow, Snake, Style};
//! let window = RenderWindow::new((1000, 1000), "Snake", Style::CLOSE, &Default::default());
//! let mut game = Snake::new_display(0, 15, Some(window));
//! ```
//!
//! ### Installing CSFML
//! Arch:
//! ```sh
//! sudo pacman -Syu csfml
//! ```
//! Ubuntu:
//! ```sh
//! sudo apt-get install libcsfml
//! ```

mod coord;
#[cfg(feature = "display")]
mod display;
mod snake;

pub use crate::coord::Direction;
pub use crate::snake::Snake;

#[cfg(feature = "display")]
pub use crate::snake::{RenderWindow, Style};