# clay-gui

[![Crates.io][crates_badge]][crates]
[![Docs.rs][docs_badge]][docs]
[![Travis CI][travis_badge]][travis]
[![License][license_badge]][license]

[crates_badge]: https://img.shields.io/crates/v/clay-viewer.svg
[docs_badge]: https://docs.rs/clay-viewer/badge.svg
[travis_badge]: https://api.travis-ci.org/clay-rs/clay-viewer.svg?branch=master
[license_badge]: https://img.shields.io/crates/l/clay-viewer.svg

[crates]: https://crates.io/crates/clay-viewer
[docs]: https://docs.rs/clay-viewer
[travis]: https://travis-ci.org/clay-rs/clay-viewer
[license]: #license

Graphical viewer for [Clay project](https://clay-rs.github.io/).

## Usage

### Controls

+ `W` or `↑` - move forward
+ `S` or `↓` - move backward
+ `A` or `←` - move left
+ `D` or `→` - move right

+ `Space` - move up
+ `C` - move down

+ `E` - tilt clockwise (only in zero-gravity mode)
+ `Q` - tilt counter-clockwise (only in zero-gravity mode)

+ `P` - make screenshot (`Shift + P` to save lossless image)
+ `L` - lock motion (`Shift + L` to unlock) - to prevent statistics reset

+ `Tab` - toggle capture mode
+ `Esc` - exit

You can use mouse to look around (+ LMB in non-capture mode) and mouse wheel to tune FOV.

## License

Licensed under either of

 * Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
 * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

at your option.

### Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any
additional terms or conditions.