Skip to content

Crumble

Demo

Quick Start

crumble.py
from terminaltexteffects.effects.effect_crumble import Crumble

effect = Crumble("YourTextHere")
with effect.terminal_output() as terminal:
    for frame in effect:
        terminal.print(frame)

Characters crumble into dust before being vacuumed up and reformed.

Classes:

Name Description
Crumble

Characters crumble into dust before being vacuumed up and reformed.
CrumbleConfig

Configuration for the Crumble effect.
CrumbleIterator

Iterates over the Crumble effect. Does not normally need to be called directly.

Crumble

Bases: BaseEffect[CrumbleConfig]

Characters crumble into dust before being vacuumed up and reformed.

Attributes:

Name Type Description
effect_config CrumbleConfig

Configuration for the effect.
terminal_config TerminalConfig

Configuration for the terminal.
Source code in terminaltexteffects/effects/effect_crumble.py 
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
class Crumble(BaseEffect[CrumbleConfig]):
    """Characters crumble into dust before being vacuumed up and reformed.

    Attributes:
        effect_config (CrumbleConfig): Configuration for the effect.
        terminal_config (TerminalConfig): Configuration for the terminal.

    """

    @property
    def _config_cls(self) -> type[CrumbleConfig]:
        return CrumbleConfig

    @property
    def _iterator_cls(self) -> type[CrumbleIterator]:
        return CrumbleIterator

CrumbleConfig dataclass

Bases: ArgsDataClass

Configuration for the Crumble effect.

Attributes:

Name Type Description
final_gradient_stops tuple[Color, ...]

Tuple of colors for the final color gradient. If only one color is provided, the characters will be displayed in that color.
final_gradient_steps tuple[int, ...] | int

Tuple of the number of gradient steps to use. More steps will create a smoother and longer gradient animation. Valid values are n > 0.
final_gradient_direction Direction

Direction of the final gradient.
Source code in terminaltexteffects/effects/effect_crumble.py 
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
@argclass(
    name="crumble",
    help="Characters lose color and crumble into dust, vacuumed up, and reformed.",
    description="crumble | Characters lose color and crumble into dust, vacuumed up, and reformed.",
    epilog=(
        "Example: terminaltexteffects crumble --final-gradient-stops 5CE1FF FF8C00 --final-gradient-steps 12 "
        "--final-gradient-direction diagonal"
    ),
)
@dataclass
class CrumbleConfig(ArgsDataClass):
    """Configuration for the Crumble effect.

    Attributes:
        final_gradient_stops (tuple[Color, ...]): Tuple of colors for the final color gradient. If only one color is
            provided, the characters will be displayed in that color.
        final_gradient_steps (tuple[int, ...] | int): Tuple of the number of gradient steps to use. More steps will
            create a smoother and longer gradient animation. Valid values are n > 0.
        final_gradient_direction (Gradient.Direction): Direction of the final gradient.

    """

    final_gradient_stops: tuple[Color, ...] = ArgField(
        cmd_name=["--final-gradient-stops"],
        type_parser=argvalidators.ColorArg.type_parser,
        nargs="+",
        default=(Color("#5CE1FF"), Color("#FF8C00")),
        metavar=argvalidators.ColorArg.METAVAR,
        help="Space separated, unquoted, list of colors for the character gradient (applied across the canvas). If "
        "only one color is provided, the characters will be displayed in that color.",
    )  # type: ignore[assignment]
    (
        "tuple[Color, ...] : Tuple of colors for the final color gradient. If only one color is provided, the "
        "characters will be displayed in that color."
    )

    final_gradient_steps: tuple[int, ...] | int = ArgField(
        cmd_name="--final-gradient-steps",
        type_parser=argvalidators.PositiveInt.type_parser,
        nargs="+",
        default=12,
        metavar=argvalidators.PositiveInt.METAVAR,
        help="Space separated, unquoted, list of the number of gradient steps to use. More steps will create a "
        "smoother and longer gradient animation.",
    )  # type: ignore[assignment]
    (
        "tuple[int, ...] | int : Int or Tuple of ints for the number of gradient steps to use. More steps will "
        "create a smoother and longer gradient animation."
    )

    final_gradient_direction: Gradient.Direction = ArgField(
        cmd_name="--final-gradient-direction",
        type_parser=argvalidators.GradientDirection.type_parser,
        default=Gradient.Direction.DIAGONAL,
        metavar=argvalidators.GradientDirection.METAVAR,
        help="Direction of the final gradient.",
    )  # type: ignore[assignment]
    "Gradient.Direction : Direction of the final gradient."

    @classmethod
    def get_effect_class(cls) -> type[Crumble]:
        """Get the effect class associated with this configuration."""
        return Crumble

final_gradient_direction = ArgField(cmd_name='--final-gradient-direction', type_parser=argvalidators.GradientDirection.type_parser, default=Gradient.Direction.DIAGONAL, metavar=argvalidators.GradientDirection.METAVAR, help='Direction of the final gradient.') class-attribute instance-attribute

Gradient.Direction : Direction of the final gradient.

final_gradient_steps = ArgField(cmd_name='--final-gradient-steps', type_parser=argvalidators.PositiveInt.type_parser, nargs='+', default=12, metavar=argvalidators.PositiveInt.METAVAR, help='Space separated, unquoted, list of the number of gradient steps to use. More steps will create a smoother and longer gradient animation.') class-attribute instance-attribute

tuple[int, ...] | int : Int or Tuple of ints for the number of gradient steps to use. More steps will create a smoother and longer gradient animation.

final_gradient_stops = ArgField(cmd_name=['--final-gradient-stops'], type_parser=argvalidators.ColorArg.type_parser, nargs='+', default=(Color('#5CE1FF'), Color('#FF8C00')), metavar=argvalidators.ColorArg.METAVAR, help='Space separated, unquoted, list of colors for the character gradient (applied across the canvas). If only one color is provided, the characters will be displayed in that color.') class-attribute instance-attribute

tuple[Color, ...] : Tuple of colors for the final color gradient. If only one color is provided, the characters will be displayed in that color.

get_effect_class() classmethod

Get the effect class associated with this configuration.

Source code in terminaltexteffects/effects/effect_crumble.py 
87
88
89
90
@classmethod
def get_effect_class(cls) -> type[Crumble]:
    """Get the effect class associated with this configuration."""
    return Crumble

CrumbleIterator

Bases: BaseEffectIterator[CrumbleConfig]

Iterator for the Crumble effect.

Source code in terminaltexteffects/effects/effect_crumble.py 
 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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
class CrumbleIterator(BaseEffectIterator[CrumbleConfig]):
    """Iterator for the Crumble effect."""

    def __init__(self, effect: Crumble) -> None:
        """Initialize the iterator with the provided effect.

        Args:
            effect (Crumble): The effect to iterate over.

        """
        super().__init__(effect)

        self.pending_chars: list[EffectCharacter] = []
        self.character_final_color_map: dict[EffectCharacter, Color] = {}
        self.build()

    def build(self) -> None:
        """Build the initial state of the effect."""
        final_gradient = Gradient(*self.config.final_gradient_stops, steps=self.config.final_gradient_steps)
        final_gradient_mapping = final_gradient.build_coordinate_color_mapping(
            self.terminal.canvas.text_bottom,
            self.terminal.canvas.text_top,
            self.terminal.canvas.text_left,
            self.terminal.canvas.text_right,
            self.config.final_gradient_direction,
        )
        for character in self.terminal.get_characters():
            self.character_final_color_map[character] = final_gradient_mapping[character.input_coord]
            strengthen_flash_gradient = Gradient(self.character_final_color_map[character], Color("ffffff"), steps=6)
            strengthen_gradient = Gradient(Color("ffffff"), self.character_final_color_map[character], steps=9)
            weak_color = character.animation.adjust_color_brightness(self.character_final_color_map[character], 0.65)
            dust_color = character.animation.adjust_color_brightness(self.character_final_color_map[character], 0.55)
            weaken_gradient = Gradient(weak_color, dust_color, steps=9)
            self.terminal.set_character_visibility(character, is_visible=True)
            # set up initial and falling stage
            initial_scn = character.animation.new_scene()
            initial_scn.add_frame(character.input_symbol, 1, colors=ColorPair(fg=weak_color))
            character.animation.activate_scene(initial_scn)
            fall_path = character.motion.new_path(
                speed=0.2,
                ease=easing.out_bounce,
            )
            fall_path.new_waypoint(Coord(character.input_coord.column, self.terminal.canvas.bottom))
            weaken_scn = character.animation.new_scene(scene_id="weaken")
            weaken_scn.apply_gradient_to_symbols(character.input_symbol, 6, fg_gradient=weaken_gradient)

            top_path = character.motion.new_path(path_id="top", speed=0.5, ease=easing.out_quint)
            top_path.new_waypoint(
                Coord(character.input_coord.column, self.terminal.canvas.top),
                bezier_control=Coord(self.terminal.canvas.center_column, self.terminal.canvas.center_row),
            )
            # set up reset stage
            input_path = character.motion.new_path(path_id="input", speed=0.3)
            input_path.new_waypoint(character.input_coord)
            strengthen_flash_scn = character.animation.new_scene()
            strengthen_flash_scn.apply_gradient_to_symbols(
                character.input_symbol,
                4,
                fg_gradient=strengthen_flash_gradient,
            )
            strengthen_scn = character.animation.new_scene()
            strengthen_scn.apply_gradient_to_symbols(character.input_symbol, 6, fg_gradient=strengthen_gradient)
            dust_scn = character.animation.new_scene(sync=Scene.SyncMetric.DISTANCE)
            for _ in range(5):
                dust_scn.add_frame(random.choice(["*", ".", ","]), 1, colors=ColorPair(fg=dust_color))

            character.event_handler.register_event(
                EventHandler.Event.SCENE_COMPLETE,
                weaken_scn,
                EventHandler.Action.ACTIVATE_PATH,
                fall_path,
            )
            character.event_handler.register_event(
                EventHandler.Event.SCENE_COMPLETE,
                weaken_scn,
                EventHandler.Action.SET_LAYER,
                1,
            )
            character.event_handler.register_event(
                EventHandler.Event.SCENE_COMPLETE,
                weaken_scn,
                EventHandler.Action.ACTIVATE_SCENE,
                dust_scn,
            )

            character.event_handler.register_event(
                EventHandler.Event.PATH_COMPLETE,
                input_path,
                EventHandler.Action.ACTIVATE_SCENE,
                strengthen_flash_scn,
            )
            character.event_handler.register_event(
                EventHandler.Event.SCENE_COMPLETE,
                strengthen_flash_scn,
                EventHandler.Action.ACTIVATE_SCENE,
                strengthen_scn,
            )
            self.pending_chars.append(character)
        random.shuffle(self.pending_chars)
        self.fall_delay = 20
        self.max_fall_delay = 20
        self.min_fall_delay = 15
        self.reset = False
        self.fall_group_maxsize = 1
        self.stage = "falling"
        self.unvacuumed_chars = list(self.terminal._input_characters)
        random.shuffle(self.unvacuumed_chars)

    def __next__(self) -> str:
        """Return the next frame in the animation."""
        if self.stage != "complete":
            if self.stage == "falling":
                if self.pending_chars:
                    if self.fall_delay == 0:
                        # Determine the size of the next group of falling characters
                        fall_group_size = random.randint(1, self.fall_group_maxsize)
                        # Add the next group of falling characters to the animating characters list
                        for _ in range(fall_group_size):
                            if self.pending_chars:
                                next_char = self.pending_chars.pop(0)
                                next_char.animation.activate_scene(next_char.animation.query_scene("weaken"))
                                self.active_characters.add(next_char)
                        # Reset the fall delay and adjust the fall group size and delay range
                        self.fall_delay = random.randint(self.min_fall_delay, self.max_fall_delay)
                        if random.randint(1, 10) > 4:  # 60% chance to modify the fall delay and group size
                            self.fall_group_maxsize += 1
                            self.min_fall_delay = max(0, self.min_fall_delay - 1)
                            self.max_fall_delay = max(0, self.max_fall_delay - 1)
                    else:
                        self.fall_delay -= 1
                if not self.pending_chars and not self.active_characters:
                    self.stage = "vacuuming"
            elif self.stage == "vacuuming":
                if self.unvacuumed_chars:
                    for _ in range(random.randint(3, 10)):
                        if self.unvacuumed_chars:
                            next_char = self.unvacuumed_chars.pop(0)
                            next_char.motion.activate_path(next_char.motion.query_path("top"))
                            self.active_characters.add(next_char)
                if not self.active_characters:
                    self.stage = "resetting"

            elif self.stage == "resetting":
                if not self.reset:
                    for character in self.terminal.get_characters():
                        character.motion.activate_path(character.motion.query_path("input"))
                        self.active_characters.add(character)
                    self.reset = True
                if not self.active_characters:
                    self.stage = "complete"

            self.update()
            return self.frame
        raise StopIteration

__init__(effect)

Initialize the iterator with the provided effect.

Parameters:

Name Type Description Default
effect Crumble

The effect to iterate over.

 required
Source code in terminaltexteffects/effects/effect_crumble.py 
 96
 97
 98
 99
100
101
102
103
104
105
106
107
def __init__(self, effect: Crumble) -> None:
    """Initialize the iterator with the provided effect.

    Args:
        effect (Crumble): The effect to iterate over.

    """
    super().__init__(effect)

    self.pending_chars: list[EffectCharacter] = []
    self.character_final_color_map: dict[EffectCharacter, Color] = {}
    self.build()

__next__()

Return the next frame in the animation.

Source code in terminaltexteffects/effects/effect_crumble.py 
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
def __next__(self) -> str:
    """Return the next frame in the animation."""
    if self.stage != "complete":
        if self.stage == "falling":
            if self.pending_chars:
                if self.fall_delay == 0:
                    # Determine the size of the next group of falling characters
                    fall_group_size = random.randint(1, self.fall_group_maxsize)
                    # Add the next group of falling characters to the animating characters list
                    for _ in range(fall_group_size):
                        if self.pending_chars:
                            next_char = self.pending_chars.pop(0)
                            next_char.animation.activate_scene(next_char.animation.query_scene("weaken"))
                            self.active_characters.add(next_char)
                    # Reset the fall delay and adjust the fall group size and delay range
                    self.fall_delay = random.randint(self.min_fall_delay, self.max_fall_delay)
                    if random.randint(1, 10) > 4:  # 60% chance to modify the fall delay and group size
                        self.fall_group_maxsize += 1
                        self.min_fall_delay = max(0, self.min_fall_delay - 1)
                        self.max_fall_delay = max(0, self.max_fall_delay - 1)
                else:
                    self.fall_delay -= 1
            if not self.pending_chars and not self.active_characters:
                self.stage = "vacuuming"
        elif self.stage == "vacuuming":
            if self.unvacuumed_chars:
                for _ in range(random.randint(3, 10)):
                    if self.unvacuumed_chars:
                        next_char = self.unvacuumed_chars.pop(0)
                        next_char.motion.activate_path(next_char.motion.query_path("top"))
                        self.active_characters.add(next_char)
            if not self.active_characters:
                self.stage = "resetting"

        elif self.stage == "resetting":
            if not self.reset:
                for character in self.terminal.get_characters():
                    character.motion.activate_path(character.motion.query_path("input"))
                    self.active_characters.add(character)
                self.reset = True
            if not self.active_characters:
                self.stage = "complete"

        self.update()
        return self.frame
    raise StopIteration

build()

Build the initial state of the effect.

Source code in terminaltexteffects/effects/effect_crumble.py 
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
def build(self) -> None:
    """Build the initial state of the effect."""
    final_gradient = Gradient(*self.config.final_gradient_stops, steps=self.config.final_gradient_steps)
    final_gradient_mapping = final_gradient.build_coordinate_color_mapping(
        self.terminal.canvas.text_bottom,
        self.terminal.canvas.text_top,
        self.terminal.canvas.text_left,
        self.terminal.canvas.text_right,
        self.config.final_gradient_direction,
    )
    for character in self.terminal.get_characters():
        self.character_final_color_map[character] = final_gradient_mapping[character.input_coord]
        strengthen_flash_gradient = Gradient(self.character_final_color_map[character], Color("ffffff"), steps=6)
        strengthen_gradient = Gradient(Color("ffffff"), self.character_final_color_map[character], steps=9)
        weak_color = character.animation.adjust_color_brightness(self.character_final_color_map[character], 0.65)
        dust_color = character.animation.adjust_color_brightness(self.character_final_color_map[character], 0.55)
        weaken_gradient = Gradient(weak_color, dust_color, steps=9)
        self.terminal.set_character_visibility(character, is_visible=True)
        # set up initial and falling stage
        initial_scn = character.animation.new_scene()
        initial_scn.add_frame(character.input_symbol, 1, colors=ColorPair(fg=weak_color))
        character.animation.activate_scene(initial_scn)
        fall_path = character.motion.new_path(
            speed=0.2,
            ease=easing.out_bounce,
        )
        fall_path.new_waypoint(Coord(character.input_coord.column, self.terminal.canvas.bottom))
        weaken_scn = character.animation.new_scene(scene_id="weaken")
        weaken_scn.apply_gradient_to_symbols(character.input_symbol, 6, fg_gradient=weaken_gradient)

        top_path = character.motion.new_path(path_id="top", speed=0.5, ease=easing.out_quint)
        top_path.new_waypoint(
            Coord(character.input_coord.column, self.terminal.canvas.top),
            bezier_control=Coord(self.terminal.canvas.center_column, self.terminal.canvas.center_row),
        )
        # set up reset stage
        input_path = character.motion.new_path(path_id="input", speed=0.3)
        input_path.new_waypoint(character.input_coord)
        strengthen_flash_scn = character.animation.new_scene()
        strengthen_flash_scn.apply_gradient_to_symbols(
            character.input_symbol,
            4,
            fg_gradient=strengthen_flash_gradient,
        )
        strengthen_scn = character.animation.new_scene()
        strengthen_scn.apply_gradient_to_symbols(character.input_symbol, 6, fg_gradient=strengthen_gradient)
        dust_scn = character.animation.new_scene(sync=Scene.SyncMetric.DISTANCE)
        for _ in range(5):
            dust_scn.add_frame(random.choice(["*", ".", ","]), 1, colors=ColorPair(fg=dust_color))

        character.event_handler.register_event(
            EventHandler.Event.SCENE_COMPLETE,
            weaken_scn,
            EventHandler.Action.ACTIVATE_PATH,
            fall_path,
        )
        character.event_handler.register_event(
            EventHandler.Event.SCENE_COMPLETE,
            weaken_scn,
            EventHandler.Action.SET_LAYER,
            1,
        )
        character.event_handler.register_event(
            EventHandler.Event.SCENE_COMPLETE,
            weaken_scn,
            EventHandler.Action.ACTIVATE_SCENE,
            dust_scn,
        )

        character.event_handler.register_event(
            EventHandler.Event.PATH_COMPLETE,
            input_path,
            EventHandler.Action.ACTIVATE_SCENE,
            strengthen_flash_scn,
        )
        character.event_handler.register_event(
            EventHandler.Event.SCENE_COMPLETE,
            strengthen_flash_scn,
            EventHandler.Action.ACTIVATE_SCENE,
            strengthen_scn,
        )
        self.pending_chars.append(character)
    random.shuffle(self.pending_chars)
    self.fall_delay = 20
    self.max_fall_delay = 20
    self.min_fall_delay = 15
    self.reset = False
    self.fall_group_maxsize = 1
    self.stage = "falling"
    self.unvacuumed_chars = list(self.terminal._input_characters)
    random.shuffle(self.unvacuumed_chars)

get_effect_and_args()

Get the effect class and its configuration class.

Source code in terminaltexteffects/effects/effect_crumble.py 
23
24
25
def get_effect_and_args() -> tuple[type[typing.Any], type[ArgsDataClass]]:
    """Get the effect class and its configuration class."""
    return Crumble, CrumbleConfig