seldom_pixel 0.8.0

Bevy plugin for limited color palette pixel art games
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125

// In this program, animated filters are demonstrated

use bevy::prelude::*;
use seldom_pixel::prelude::*;

fn main() {
    App::new()
        .add_plugins((
            DefaultPlugins.set(WindowPlugin {
                primary_window: Some(Window {
                    resolution: Vec2::splat(512.).into(),
                    ..default()
                }),
                ..default()
            }),
            PxPlugin::<Layer>::new(UVec2::new(51, 35), "palette/palette_1.palette.png"),
        ))
        .insert_resource(ClearColor(Color::BLACK))
        .add_systems(Startup, init)
        .run();
}

fn init(assets: Res<AssetServer>, mut commands: Commands) {
    commands.spawn(Camera2d);

    let mage = assets.load("sprite/mage.px_sprite.png");

    // Spawn a bunch of sprites on different layers
    for layer in 0..8 {
        commands.spawn((
            PxSprite(mage.clone()),
            PxPosition(IVec2::new(layer % 4 * 13, layer / 4 * 18)),
            PxAnchor::BottomLeft,
            Layer(layer),
        ));
    }

    // Load the filter
    let fade_to_black = assets.load("filter/fade_to_black.px_filter.png");

    // Despawn at the end
    commands.spawn((
        PxFilter(fade_to_black.clone()),
        PxFilterLayers::single_clip(Layer(0)),
        PxAnimation::default(),
    ));

    // Add the `PxAnimationFinished` component at the end
    commands.spawn((
        PxFilter(fade_to_black.clone()),
        PxFilterLayers::single_clip(Layer(1)),
        PxAnimation {
            on_finish: PxAnimationFinishBehavior::Mark,
            ..default()
        },
    ));

    // Loop
    commands.spawn((
        PxFilter(fade_to_black.clone()),
        PxFilterLayers::single_clip(Layer(2)),
        PxAnimation {
            on_finish: PxAnimationFinishBehavior::Loop,
            ..default()
        },
    ));

    // Backward
    commands.spawn((
        PxFilter(fade_to_black.clone()),
        PxFilterLayers::single_clip(Layer(3)),
        PxAnimation {
            direction: PxAnimationDirection::Backward,
            on_finish: PxAnimationFinishBehavior::Loop,
            ..default()
        },
    ));

    // Faster
    commands.spawn((
        PxFilter(fade_to_black.clone()),
        PxFilterLayers::single_clip(Layer(5)),
        PxAnimation {
            duration: PxAnimationDuration::millis_per_animation(500),
            on_finish: PxAnimationFinishBehavior::Loop,
            ..default()
        },
    ));

    // Slower
    commands.spawn((
        PxFilter(fade_to_black.clone()),
        PxFilterLayers::single_clip(Layer(4)),
        PxAnimation {
            duration: PxAnimationDuration::millis_per_animation(2000),
            on_finish: PxAnimationFinishBehavior::Loop,
            ..default()
        },
    ));

    // Duration per frame
    commands.spawn((
        PxFilter(fade_to_black.clone()),
        PxFilterLayers::single_clip(Layer(6)),
        PxAnimation {
            duration: PxAnimationDuration::millis_per_frame(1000),
            on_finish: PxAnimationFinishBehavior::Loop,
            ..default()
        },
    ));

    // Dither between frames
    commands.spawn((
        PxFilter(fade_to_black),
        PxFilterLayers::single_clip(Layer(7)),
        PxAnimation {
            on_finish: PxAnimationFinishBehavior::Loop,
            frame_transition: PxAnimationFrameTransition::Dither,
            ..default()
        },
    ));
}

#[px_layer]
struct Layer(i32);