20 stable releases

2.6.0 Oct 3, 2023
2.4.0 Jun 5, 2022
2.3.0 Oct 11, 2021
2.2.0 Jul 19, 2021
0.3.1 Feb 26, 2019

#33 in Games

Download history 294/week @ 2023-08-15 350/week @ 2023-08-22 307/week @ 2023-08-29 229/week @ 2023-09-05 358/week @ 2023-09-12 418/week @ 2023-09-19 180/week @ 2023-09-26 412/week @ 2023-10-03 240/week @ 2023-10-10 302/week @ 2023-10-17 378/week @ 2023-10-24 273/week @ 2023-10-31 227/week @ 2023-11-07 120/week @ 2023-11-14 204/week @ 2023-11-21 177/week @ 2023-11-28

756 downloads per month
Used in 9 crates

MIT license



rbx_dom_weak on crates.io rbx_dom_weak docs

More details about this crate are available on the rbx-dom GitHub.

Weakly-typed implementation of Roblox's DOM, used for representing instances in external tools.


Because rbx_dom_weak is weakly-typed, it doesn't need to be updated when new instances are added to Roblox. It does, however, have to be updated when new datatypes like Vector3int16 are added.


rbx_dom_weak is a common representation of the Roblox DOM for Rust. It's designed to play nicely with the borrow checker and allows accessing instances by ID in constant time.

Constructing a new tree of instances is accomplished by first creating an InstanceBuilder object that describes a tree of instances and then wrapping it with an WeakDom:

use rbx_dom_weak::{InstanceBuilder, WeakDom};

let dm = InstanceBuilder::new("DataModel");

let mut dom = WeakDom::new(dm);

println!("ID of DOM root is {:?}", dom.root_ref());

Once we have a tree, we can use WeakDom::insert and WeakDom::get_by_ref to add instances to the tree and retrieve them.

use rbx_dom_weak::{InstanceBuilder, WeakDom};

let mut dom = WeakDom::new(InstanceBuilder::new("DataModel"));

// We can define properties using any type that can be converted to an
// rbx_dom_weak::types::Variant.
let http_service = InstanceBuilder::new("HttpService")
    .with_property("HttpEnabled", true);

let http_service_id = dom.insert(dom.root_ref(), http_service);

println!("HttpService has ID {:?}", http_service_id);

To change properties on an instance that's already present in the tree, use WeakDom::get_by_ref_mut. Note that it isn't possible to add or remove children through this method, use WeakDom::insert and WeakDom::destroy instead.


~73K SLoC