Lib.rs

Cargo Features

[dependencies]
rantz_proto = { version = "1.2.4", default-features = false, features = ["progress_tracking", "hot_reload", "all_asset_loaders", "ron", "toml", "yaml", "json", "msgpack", "xml", "csv"] }

default = hot_reload, ron

All file formats are disabled by default: you will typically want to enable only the formats you need. Picking one per project is recommended.

progress_tracking

Support for iyes_progress

Enables iyes_progress ^0.12

Affects systems::track_progress…

hot_reload default

Support for hot reloading

Enables file_watcher and multi_threaded of bevy ^0.14

Affects prototype_trait::Prototype.rebuild, systems::track_asset…

all_asset_loaders = csv, json, msgpack, ron, toml, xml, yaml

Support for all file format features
Useful for testing

ron default all_asset_loaders?

Support for the RON file format
This is a good choice for most projects, as it is a simple, human-readable and plays nice with enums.

Enables ron of bevy_common_assets ^0.11

toml all_asset_loaders?

Support for the TOML file format
This is a straightforward choice for configuration files.

Enables toml of bevy_common_assets ^0.11

yaml all_asset_loaders?

Support for the YAML file format
This is a relatively common choice for configuration files,
and substantially more complex than TOML

Enables yaml of bevy_common_assets ^0.11

json all_asset_loaders?

Support for the JSON file format
JSON is nearly universal, but can be a bit verbose and nitpicky.
The key advantage is that it is well-supported by web technologies,
and has robust validation tooling.

Enables json of bevy_common_assets ^0.11

msgpack all_asset_loaders?

Support for the MessagePack file format
This is a binary format that is more compact than JSON, but not human-readable.

Enables msgpack of bevy_common_assets ^0.11

xml all_asset_loaders?

Support for the XML file format
XML is meaningfully more complex and less compact than JSON,
but comes with schemas and validation tools.

Enables xml of bevy_common_assets ^0.11

csv all_asset_loaders?

Support for the CSV file format.
This is a great fit for tabular data, but notoriously flaky in edge cases due to the lack of a standard.
Good interop with spreadsheet software though!

Enables csv of bevy_common_assets ^0.11