Skip to content

Commit 7b3e6fb

Browse files
authored
Update READMEs of crates to remove outdated info (rojo-rbx#333)
1 parent 963db61 commit 7b3e6fb

File tree

3 files changed

+20
-4
lines changed

3 files changed

+20
-4
lines changed

rbx_binary/README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,13 @@ More details about this crate are available on [the rbx-dom GitHub](https://gith
77
Implementation of Roblox's binary model formats, rbxm and rbxl, for the rbx-dom ecosystem.
88

99
## Coverage
10-
rbx_binary aims to support all property types from rbx_dom_weak, but it currently lags behind rbx_xml due to implementation complexity.
10+
11+
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.
12+
13+
These are mostly harmless, but they may include:
14+
- Properties being serialized under the wrong name
15+
- Properties having the incorrect default
16+
17+
Additionally, data types newer than the current release of rbx_binary cannot be (de)serialized.
18+
19+
In all of these cases, an update is needed for this crate.

rbx_types/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,6 @@ rbx_types contains value types, which are generally evergreen and are added infr
1111
- `Vector3`, Roblox's 3D vector type
1212
- `NumberSequence`, a series of numbers on a timeline
1313
- `BinaryString`, an opaque buffer of binary data
14-
- In the future, more specialized types like `Tags`, a list of `CollectionService` tags
14+
- More specialized data types representing specific `BinaryString` blobs
1515

1616
rbx_types will _not_ contain instance types. New instances are added to the platform all the time and have more complicated semantics.

rbx_xml/README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,13 @@ More details about this crate are available on [the rbx-dom GitHub](https://gith
77
Implementation of Roblox's XML model formats, rbxmx and rbxlx for the rbx-dom ecosystem.
88

99
## Coverage
10-
rbx_xml aims to support all property types from rbx_dom_weak.
1110

12-
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.
11+
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.
12+
13+
These are mostly harmless, but they may include:
14+
- Properties being serialized under the wrong name
15+
- Properties having the incorrect default
16+
17+
Additionally, data types newer than the current release of rbx_xml cannot be (de)serialized.
18+
19+
In all of these cases, an update is needed for this crate.

0 commit comments

Comments
 (0)