timjentzsch / bevy_mod_krita Goto Github PK

View Code? Open in Web Editor NEW

8.0 2.0 0.0 107 KB

Load Krita documents directly in Bevy.

License: Apache License 2.0

Rust 100.00%

bevy bevy-plugin krita

bevy_mod_krita's Introduction

bevy_mod_krita

Load Krita's .kra documents directly in Bevy for rapid prototyping or game jams.

Please keep in mind that .kra files are not optimized for size, so you should probably not use them for production bundles.

Bevy Compatibility

`bevy` version	`bevy_mod_krita` version
`0.12`	`0.3.0`
`0.11`	`0.2.0`
`0.10`	`0.1.0`

Installation

cargo add bevy_mod_krita

Usage

Simply add the KritaPlugin to your app, enable hot reloading (optional) and load .kra files!

use bevy::prelude::*;
use bevy_mod_krita::KritaPlugin;

fn main() {
    App::new()
        .add_plugins(DefaultPlugins)
        // Add the Krita plugin to enable loading of `.kra` files
        .add_plugins(KritaPlugin)
        .add_systems(Startup, setup)
        .run();
}

fn setup(mut commands: Commands, asset_server: Res<AssetServer>) {
    commands.spawn(Camera2dBundle::default());
    commands.spawn(SpriteBundle {
        // Load a Krita document as a texture
        texture: asset_server.load("krita/demo.kra"),
        ..default()
    });
}

License

This project is licensed under the terms of the MIT or Apache 2.0 license at your choice.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

bevy_mod_krita's People

Contributors

Stargazers

Watchers

bevy_mod_krita's Issues

Add Bevy compatibility table

Add a table showing the bevy_mod_krita version(s) compatible with a given bevy version.
Should be added for #16 and then updated for #14.

Add example for using a Krita image as texture

There should be an example showcasing how the Krita file can be used to texture 3D objects as well.

This would also make for a cool showcase of the plugin if we have a video where a texture on a rotating cube is edited in Krita via hot reloading.

Improve README

The README is very bare-bones right now and doesn't contain any real information.

We should specify with which Bevy version this crate works, basic instructions on how to use it as well as the licenses we use.

Update to Bevy 0.10

Update to the newest Bevy version.

Update to Bevy 0.11

While [email protected] is already released (#14), we should also make a release with 0.11 support, for completeness.

Update bevy to 0.12

Allow the plugin to be used with the new [email protected] version.

Add more documentation

Document the entire crate and enable clippy warnings on undocumented items.

Improve error handling in AssetLoader

The KritaDocumentLoader currently just passes any error up without any processing.

We should probably wrap the errors and provide additional information on where the error occurred.

Document usage with asset preprocessing

Bevy 0.12 introduced asset pre-processing.
This plays together very nicely with bevy_mod_krita:
Previously, if you used this plugin, you had to bundle the large .kra files with your Bevy app. This made it only useful for prototyping or perhaps game jams.
With pre-processing, you should be able to process the .kra file to a leaner image file instead, reducing the bundle size.
This could make bevy_mod_krita useful for a lot more applications.

Add CI

Add GitHub actions workflows to make sure that no errors sneak into the code.

Properly set `supported_compressed_formats` for loaded `Image`

In the KritaDocumentLoader, an Image struct is created which requires you to define the supported compressed formats.

I'm not yet sure what exactly this does, so we'll have to investigate if the correct format is specified.