From 7b3e6fb84ceb3b02c5042d17a373f7cd42bec83b Mon Sep 17 00:00:00 2001 From: Micah Date: Sun, 30 Jul 2023 12:48:34 -0700 Subject: [PATCH] Update READMEs of crates to remove outdated info (#333) --- rbx_binary/README.md | 11 ++++++++++- rbx_types/README.md | 2 +- rbx_xml/README.md | 11 +++++++++-- 3 files changed, 20 insertions(+), 4 deletions(-) diff --git a/rbx_binary/README.md b/rbx_binary/README.md index 5d6da700d..7e380553f 100644 --- a/rbx_binary/README.md +++ b/rbx_binary/README.md @@ -7,4 +7,13 @@ More details about this crate are available on [the rbx-dom GitHub](https://gith Implementation of Roblox's binary model formats, rbxm and rbxl, for the rbx-dom ecosystem. ## Coverage -rbx_binary aims to support all property types from rbx_dom_weak, but it currently lags behind rbx_xml due to implementation complexity. \ No newline at end of file + +rbx_binary supports all property types from [`rbx_types`](https://crates.io/crates/rbx_types). It currently embeds a reflection database which contains a list of classes, properties, their types, and other information. In the event that this database is outdated, some issues may come up. + +These are mostly harmless, but they may include: + - Properties being serialized under the wrong name + - Properties having the incorrect default + +Additionally, data types newer than the current release of rbx_binary cannot be (de)serialized. + +In all of these cases, an update is needed for this crate. \ No newline at end of file diff --git a/rbx_types/README.md b/rbx_types/README.md index d9c0bae06..f8680242f 100644 --- a/rbx_types/README.md +++ b/rbx_types/README.md @@ -11,6 +11,6 @@ rbx_types contains value types, which are generally evergreen and are added infr - `Vector3`, Roblox's 3D vector type - `NumberSequence`, a series of numbers on a timeline - `BinaryString`, an opaque buffer of binary data -- In the future, more specialized types like `Tags`, a list of `CollectionService` tags +- More specialized data types representing specific `BinaryString` blobs rbx_types will _not_ contain instance types. New instances are added to the platform all the time and have more complicated semantics. diff --git a/rbx_xml/README.md b/rbx_xml/README.md index a481c2180..44c13f4ec 100644 --- a/rbx_xml/README.md +++ b/rbx_xml/README.md @@ -7,6 +7,13 @@ More details about this crate are available on [the rbx-dom GitHub](https://gith Implementation of Roblox's XML model formats, rbxmx and rbxlx for the rbx-dom ecosystem. ## Coverage -rbx_xml aims to support all property types from rbx_dom_weak. -Some properties serialize with different names in XML than the names exposed via Roblox's API dump or via the Lua API. In those cases, rbx_xml keeps a mapping that needs to be kept up to date. These cases are pretty uncommon, so that table is small. \ No newline at end of file +rbx_xml supports all property types from [`rbx_types`](https://crates.io/crates/rbx_types). It currently embeds a reflection database which contains a list of classes, properties, their types, and other information. In the event that this database is outdated, some issues may come up. + +These are mostly harmless, but they may include: + - Properties being serialized under the wrong name + - Properties having the incorrect default + +Additionally, data types newer than the current release of rbx_xml cannot be (de)serialized. + +In all of these cases, an update is needed for this crate. \ No newline at end of file