diff --git a/README.md b/README.md new file mode 100644 index 0000000..cf08a3d --- /dev/null +++ b/README.md @@ -0,0 +1,38 @@ +Roblox Bhop/Surf Bot File Format +================================ + +## Example + +```rust +use strafesnet_roblox_bot_file::File; + +let file=std::fs::File::open("bot_file")?; +let input=std::io::BufReader::new(file); +let bot_file=File::new(input)?; + +for &(time,block_id) in &bot_file.header.offline_blocks_timeline{ + let block=bot_file.read_block(block_id)?; + // offline blocks include the following event types: + // World, Gravity, Run, Camera, Setting +} +for &(time,block_id) in &bot_file.header.realtime_blocks_timeline{ + let block=bot_file.read_block(block_id)?; + // realtime blocks include the following event types: + // Input, Output, Sound +} +``` + +#### License + +<sup> +Licensed under either of <a href="LICENSE-APACHE">Apache License, Version +2.0</a> or <a href="LICENSE-MIT">MIT license</a> at your option. +</sup> + +<br> + +<sub> +Unless you explicitly state otherwise, any contribution intentionally submitted +for inclusion in this crate by you, as defined in the Apache-2.0 license, shall +be dual licensed as above, without any additional terms or conditions. +</sub>