bracket-lib 0.8.7

Meta-crate holding the entirety of bracket-lib (and exposing it). Use this for the full roguelike toolkit experience.
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
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

# Terminal Examples


## alpha


[Source Code](https://github.com/amethyst/bracket-lib/blob/master/bracket-terminal/examples/alpha.rs)

Demonstrates the RGBA capabilities of the library, when alpha blending is enabled on a sparse console overlaying a simple console. Also uses the `VirtualConsole` feature to create a large psuedo-console containing a chunk of *A Tale of Two Cities*, and rendering that as the base layer.

![](./ex_bt_alpha.gif)

## astar_mouse


[Source Code](https://github.com/amethyst/bracket-lib/blob/master/bracket-terminal/examples/astar_mouse.rs)

Generates a random blob map, and places a player on it. The player moves to wherever the mouse is clicked, using A star pathfinding. Also generates real-time field of view for the player as they zip around.

![](./ex_bt_astar_mouse.gif)

## bench_scalable


[Source Code](https://github.com/amethyst/bracket-lib/blob/master/bracket-terminal/examples/bench_scalable.rs)

Generates a completely random console, as fast as possible. Uses the resizable console option to allow the window to be resized while it runs, and queries the console for dimensions---filling as much of it as possible.

No screenshot, sorry.

## benchmark


[Source Code](https://github.com/amethyst/bracket-lib/blob/master/bracket-terminal/examples/benchmark.rs)

Draws a random console as fast as possible. No resizing.

## colorfont


[Source Code](https://github.com/amethyst/bracket-lib/blob/master/bracket-terminal/examples/colorfont.rs)

Demonstrates that you can use color in your font graphic if you want to.

![](./ex_bt_colorfont.jpg)

## dwarfmap


[Source Code](https://github.com/amethyst/bracket-lib/blob/master/bracket-terminal/examples/dwarfmap.rs)

An homage to *Dwarf Fortress*. Generates a 3D map, and then renders it top-down with darkening for lower than the player z-levels. Implements a-star pathing in 3D, and mouse-based navigation.

![](./ex_bt_dwarfmap.gif)

## flexible


[Source Code](https://github.com/amethyst/bracket-lib/blob/master/bracket-terminal/examples/flexible.rs)

Demonstrates using a fancy/flexible console to make a spinning `@` bounce around the screen.

![](./ex_bt_flex.gif)

## fontswitch


[Source Code](https://github.com/amethyst/bracket-lib/blob/master/bracket-terminal/examples/fontswitch.rs)

Demonstrates switching fonts at run-time.

![](./ex_bt_fontswitch.gif)

## hello_minimal


[Source Code](https://github.com/amethyst/bracket-lib/blob/master/bracket-terminal/examples/hello_minimal.rs)

Minimal hello world, see the quick start guide.

## hello_terminal


[Source Code](https://github.com/amethyst/bracket-lib/blob/master/bracket-terminal/examples/hello_terminal.rs)

See the quick start guide---a bouncing hello world.

![](./ex_bt_hello_terminal.gif)

## input_harness


[Source Code](https://github.com/amethyst/bracket-lib/blob/master/bracket-terminal/examples/input_harness.rs)

A handy tool to display the key code and mouse information about keys/mouse as they are utilized. Also demonstrates the `advanced_input` system, providing inputs as a stream of events rather than a simple set.

![](./ex_bt_input_harness.jpg)

## keyboard


[Source Code](https://github.com/amethyst/bracket-lib/blob/master/bracket-terminal/examples/keyboard.rs)

Mostly a debugging tool. Demonstrates keys and their various modifier combiantions.

## native_gl


[Source Code](https://github.com/amethyst/bracket-lib/blob/master/bracket-terminal/examples/native_gl.rs)

Demonstrates how to access the underlying OpenGL system, if you should need it. Note that if you really want to write a GL application, this is a really inefficient way to do it---but it gets you started, and offers a way to perform quick OpenGL calls if you just need something fancy.

![](./ex_bt_native_gl.jpg)

## no_cls


[Source Code](https://github.com/amethyst/bracket-lib/blob/master/bracket-terminal/examples/no_cls.rs)

Mostly a debugging tool, this example shows that consoles accumulate data if you don't call `cls`. This was important for debugging the native console implementations and their dirty-render detection.

## post_process


[Source Code](https://github.com/amethyst/bracket-lib/blob/master/bracket-terminal/examples/postprocess.rs)

Demonstrates reading a REX Paint file (.xp), and rendering it to the screen. Enables or disables the terminal's post-processing options, screen-burn and uses scan-lines.

![](./ex_bt_post.jpg)

## return_error


[Source Code](https://github.com/amethyst/bracket-lib/blob/master/bracket-terminal/examples/return_error.rs)

Demonstrates how to return and act on errors from initialization, should you wish to do so.

## rex


[Source Code](https://github.com/amethyst/bracket-lib/blob/master/bracket-terminal/examples/rex.rs)

Loads Nyan Cat from an embedded REX Paint file, and renders it to the screen.

![](./ex_bt_rex.jpg)

## sparse


[Source Code](https://github.com/amethyst/bracket-lib/blob/master/bracket-terminal/examples/sparse.rs)

Demonstrates layering a sparse console on top of a simple console, with different fonts on each.

![](./ex_bt_sparse.jpg)

## sparse_cls


[Source Code](https://github.com/amethyst/bracket-lib/blob/master/bracket-terminal/examples/sparse_cls.rs)

Debugging tool, designed to help me notice when I break clearing sparse consoles again!

## sprites


[Source Code](https://github.com/amethyst/bracket-lib/blob/master/bracket-terminal/examples/sprites.rs)

Uses the sprite layer type (in its infancy) to animate some sprites as they run around the screen.

![](./ex_bt_sprites.gif)

## squishy


[Source Code](https://github.com/amethyst/bracket-lib/blob/master/bracket-terminal/examples/squishy.rs)

A benchmark tool that also demonstrates the ability to "squish" terminals by dynamically resizing the size of each tile.

## textblock


[Source Code](https://github.com/amethyst/bracket-lib/blob/master/bracket-terminal/examples/textblock.rs)

Demonstrates the text-block tool, and how it can help with large amounts of text.

![](./ex_bt_textblock.jpg)

## textsprites


[Source Code](https://github.com/amethyst/bracket-lib/blob/master/bracket-terminal/examples/textsprites.rs)

Demonstrates the "multi-tile text sprite" system. You can batch some characters together for quick rendering.

![](./ex_bt_textsprites.gif)

## tiles


[Source Code](https://github.com/amethyst/bracket-lib/blob/master/bracket-terminal/examples/tiles.rs)

Uses graphical fonts instead of ASCII/CP437 for a visual dungeon experience.

![](./ex_bt_tiles.jpg)

## unicode


[Source Code](https://github.com/amethyst/bracket-lib/blob/master/bracket-terminal/examples/unicode.rs)

Demonstrates that if you *really* want to (it's slow!), you can load a giant font containing lots of unicode and display multi-lingual terminals. Run this one in `release` mode. It takes far too long to start, otherwise.

![](./ex_bt_unicode.jpg)

## virtual_console


[Source Code](https://github.com/amethyst/bracket-lib/blob/master/bracket-terminal/examples/virtual_console.rs)

Demonstrates using a virtual console to hold a lot of data, and then displaying windows into the virtual console. This can be handy for logs, manuals and similar. *This should have a seizure warning*

![](./ex_bt_virtual_console.jpg)

## walking


[Source Code](https://github.com/amethyst/bracket-lib/blob/master/bracket-terminal/examples/walking.rs)

Demonstrates walking around a map.

## walking_with_is_pressed


[Source Code](https://github.com/amethyst/bracket-lib/blob/master/bracket-terminal/examples/walking_with_is_pressed.rs)

The same walking demo, but using the `is_pressed` function (for advanced input) rather than the simple key enum.