https://github.com/craftspider/rbxm-rs

A Rust implementation for reading/writing roblox models
https://github.com/craftspider/rbxm-rs

Last synced: about 1 month ago
JSON representation

A Rust implementation for reading/writing roblox models

• Host: GitHub
• URL: https://github.com/craftspider/rbxm-rs
• Owner: CraftSpider
• License: apache-2.0
• Created: 2021-03-27T20:41:43.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2022-12-19T13:23:38.000Z (almost 2 years ago)
• Last Synced: 2024-09-15T18:22:47.975Z (2 months ago)
• Language: Rust
• Size: 477 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        
# rbxm-rs

[![crates.io](https://img.shields.io/crates/v/rbxm.svg)](https://crates.io/crates/rbxm)

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

[![MIT/Apache-2 licensed](https://img.shields.io/crates/l/rbxm.svg)](./LICENSE-APACHE)

A reader for Roblox model files, implemented in Rust.

## Features

- Strongly-typed handling of many Roblox instance kinds

- Feature flags to add support for less stable formats, E.G. CSGPHS Meshes.

- `#[no_std]` support, as long as alloc is present

## Example

```rust

use rbxm::{from_file, SerdeError, ModelError};

fn main() {

    // Read a model from a file

    let model = match from_file("./Model.rbxm") {

        Ok(model) => model,

        Err(SerdeError::IoError(err)) => panic!("IO Error: {}", err),

        Err(err) => panic!("Error parsing model: {}", err),

    };

    // Get a part from a path, this looks for a root node named ModelSection with a child named Part, and returns

    // that child.

    let part = match model.get_path("ModelSection/Part") {

        Ok(part) => part,

        Err(ModelError::NotFound) => panic!("Couldn't find instance at \"ModelSection/Part\""),

        Err(ModelError::AmbiguousPath) => panic!("Found more than one instance matching \"ModelSection/Part\""),

        Err(err) => panic!("Model Error: {}", err),

    };

    println!("Part Class: {}", part.borrow().kind.class_name())

}

```

## TODO

- Complete instance info documentation

- XML file support

- More helper methods on data

- Instance new methods + `#[non_exhaustive]` for better future compat

- Improve parsing modularity, add a low-level API for it maybe

## License

Licensed under either of

- Apache License, Version 2.0 (LICENSE-APACHE or http://apache.org/licenses/LICENSE-2.0)

- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

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