docs(README): updated docs

This commit is contained in:
kaosat.dev 2023-07-27 22:22:53 +02:00
parent a2b4025e95
commit e4171e5969
2 changed files with 7 additions and 4 deletions

View File

@ -56,10 +56,12 @@ The workflow goes as follows (once you got your Bevy code setup)
- Create a mesh/ collection (for reuse) in Blender
- Go to object properties => add a **STRING** property, and add your component data
- unit structs, enums, and more complex strucs / components are all supported, if the fields are basic data types
- for structs with no params (unit structs): use an empty value
- Go to object properties => add a property, and add your component data
- unit structs, enums, and more complex strucs / components are all supported, (if the fields are basic data types at least,
have not tried more complex ones yet, but should also work)
- for structs with no params (unit structs): use a **STRING** property & an empty value
- for structs with params: use a RON representation of your fields (see below)
- for tupple strucs you can use any of the built in Blender custom property types: Strings, Booleans, floats, Vectors, etc
![unit struct components in Blender](./docs/components_blender.png)
@ -78,7 +80,8 @@ The workflow goes as follows (once you got your Bevy code setup)
(the Rust struct for this component for reference is [here](./src/core/camera/camera_tracking.rs#21) )
Other examples of parameters, Enums (no quotes), strucs with fields etc
There is an other examples of using various Component types: Enums, Tupple structs, strucs with fields etc [here](./src/test_components.rs),
even colors, Vecs (arrays), Vec2, Vec3 etc are all supported
![complex components in Blender](./docs/components_blender_parameters2.png)

Binary file not shown.

Before

Width:  |  Height:  |  Size: 10 KiB

After

Width:  |  Height:  |  Size: 368 KiB