https://github.com/dirkchristianbecker/bevy_registry_exporter

https://github.com/dirkchristianbecker/bevy_registry_exporter

Last synced: about 19 hours ago
JSON representation

• Host: GitHub
• URL: https://github.com/dirkchristianbecker/bevy_registry_exporter
• Owner: DirkChristianBecker
• License: mit
• Created: 2024-09-16T15:02:56.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2024-09-17T17:01:03.000Z (about 2 months ago)
• Last Synced: 2024-09-17T21:19:02.069Z (about 2 months ago)
• Language: Rust
• Size: 5.86 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# bevy_registry_exporter

This crate exports the bevy registry as a json file, when added to a bevy app. It will export the registry, only if the program was build in debug mode. In release mode this plugin will not register any types or methods to run. However, if not prevented by the hosting application, the plugin itself will be add to the bevy app. 

## Export settings

The exporter can be controlled by adding an instance of the type 'ExportRegistrySettings'. This way we can control, which components and resources should be part of the export and which should not be. 

On top of that an export directory can be defined. By default the file with the exported registry will be called 'registry.json' and will be placed inside the assets directory of the application. However, the path of the registry can be freely defined (as shown in the 'with_settings' - Example).

When no export settings are defined the assets directory will be created, if it does not exist yet. When using a non-default directory the user is in charge of maintaining the target directory (which means the application will crash if not done properly).