Photon decode
=============

Set of utilities for decoding messages generated by *photon framework.

*Photon is a development framework for multiplayer games. More on https://www.photonengine.com/.

[![Documentation](https://docs.rs/photon_decode/badge.svg)](https://docs.rs/photon_decode/*/photon_decode/)


## Usage

To use `photon_decode`, first add this to your `Cargo.toml`:

```toml
[dependencies]
photon_decode = "0.1"
```


```rust
use photon_decode::{Photon, Message};

let mut photon = Photon::new();
let photon_packet = vec![
    0x00, 0x01, 			// PeerID
    0x01,                   // CrcEnabled
    0x00,                   // CommandCount
    0x00, 0x00, 0x00, 0x01, // Timestamp
    0x00, 0x00, 0x00, 0x01, // Challenge
];

for message in photon.decode(&photon_packet).iter() {
    match message {
        Message::Event(_) => {
            // use event
        },
        Message::Request(_) => {
            // use request
        },
        Message::Response(_) => {
            // use response
        }
    }
}

```

# Projects using photon decode

https://github.com/mazurwiktor/albion-online-stats - Albion online stats is an extension to MMORPG game - Albion Online. It tracks network traffic and displays various statistics, such as damage and DPS meter calculated from in-game actions. 

# 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.