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
|
**Bidi** is a tiny framework/fantasy console for developing small video games for
learning and recreation. It takes heavy inspiration from
[LÖVE](https://www.love2d.org/), [Pico8](https://www.lexaloffle.com/pico-8.php)
and [Atari 2600](https://en.wikipedia.org/wiki/Atari_2600).
You develop your games in Lua and you are only allowed to have one Lua file
where all your code lives. You can then load external assets like images and
sounds.
> [!IMPORTANT]
> The Raylib library in the `vendor` folder contains prebuilt artifacts. All
> libraries are also available in the `archive` folder. You can manually
> download and replace them from official repositories if desired; they have
> not been tampered with.
## Documentation
### Quick example
```lua
-- mygame.lua
-- bidi -f mygame.lua
open_window(800, 800, "My Game")
set_fps(60)
while window_running() do
start_drawing()
clear_window(color.BLACK)
draw_rect(100, 100, 300, 200, color.YELLOW)
draw_text("Label text", 10, 10, 20, color.VIOLET)
draw_line(400, 10, 500, 100, color.RED)
draw_circle(500, 500, 100, color.BLUE)
draw_ellipse(200, 500, 100, 50, color.BLUE)
draw_triangle(20, 20, 100, 20, 50, 100, color.BLUE)
draw_text(string.format("fps: %d", get_fps()), 10, 30, 20, color.VIOLET)
draw_text(string.format("dt: %.3f", get_dt()), 10, 50, 20, color.VIOLET)
if button_down(button.PAD_UP) then
draw_text("Pad Up", 10, 10, 20, color.VIOLET)
end
draw_info()
stop_drawing()
end
close_window()
```
### Included functions
| Function | Arguments | Returns |
| ---------------- | ------------------------------------------------------------------------------------------- | -------- |
| `open_window` | `number width`, `number height`, `string title` | |
| `close_window` | | |
| `window_running` | | `bool` |
| `start_drawing` | | |
| `stop_drawing` | | |
| `clear_window` | `color color` | |
| `start_camera` | | |
| `stop_camera` | | |
| `move_camera` | `number x`, `number y` | |
| `set_fps` | `number fps` | |
| `get_fps` | | `number` |
| `get_dt` | | `number` |
| `get_width` | | `number` |
| `get_height` | | `number` |
| `draw_info` | | |
| `draw_rect` | `number x`, `number y`, `number width`, `number height`, `color color` | |
| `draw_text` | `string text`, `number x`, `number y`, `number font_size`, `color color` | |
| `draw_pixel` | `number x`, `number y`, `color color` | |
| `draw_line` | `number x1`, `number y1`, `number x2`, `number y2`, `color color` | |
| `draw_circle` | `number center_x`, `number center_y`, `number radius`, `color color` | |
| `draw_ellipse` | `number center_x`, `number center_y`, `number radius_h`, `number radius_v`, `color color` | |
| `draw_triangle` | `number x1`, `number y1`, `number x2`, `number y2`, `number x3`, `number y3`, `color color` | |
| `load_image` | `TODO` | |
| `load_audio` | `TODO` | |
| `button_down` | `button button` | `bool` |
| `button_pressed` | `button button` | `bool` |
### Controller mappings
| Button | Keyboard | Xbox | Playstation | Nintendo |
| ---------------- | -------- | ---- | ----------- | -------- |
| button.PAD_UP | W | N/A | N/A | N/A |
| button.PAD_DOWN | S | N/A | N/A | N/A |
| button.PAD_LEFT | A | N/A | N/A | N/A |
| button.PAD_RIGHT | D | N/A | N/A | N/A |
| button.A | L | N/A | N/A | N/A |
| button.B | P | N/A | N/A | N/A |
| button.X | K | N/A | N/A | N/A |
| button.Y | O | N/A | N/A | N/A |
### Default colors
| Color Name | Red (r) | Green (g) | Blue (b) | Alpha (a) |
| ------------------ | ------- | --------- | -------- | --------- |
| `color.LIGHTGRAY` | 200 | 200 | 200 | 255 |
| `color.GRAY` | 130 | 130 | 130 | 255 |
| `color.DARKGRAY` | 80 | 80 | 80 | 255 |
| `color.YELLOW` | 253 | 249 | 0 | 255 |
| `color.GOLD` | 255 | 203 | 0 | 255 |
| `color.ORANGE` | 255 | 161 | 0 | 255 |
| `color.PINK` | 255 | 109 | 194 | 255 |
| `color.RED` | 230 | 41 | 55 | 255 |
| `color.MAROON` | 190 | 33 | 55 | 255 |
| `color.GREEN` | 0 | 228 | 48 | 255 |
| `color.LIME` | 0 | 158 | 47 | 255 |
| `color.DARKGREEN` | 0 | 117 | 44 | 255 |
| `color.SKYBLUE` | 102 | 191 | 255 | 255 |
| `color.BLUE` | 0 | 121 | 241 | 255 |
| `color.DARKBLUE` | 0 | 82 | 172 | 255 |
| `color.PURPLE` | 200 | 122 | 255 | 255 |
| `color.VIOLET` | 135 | 60 | 190 | 255 |
| `color.DARKPURPLE` | 112 | 31 | 126 | 255 |
| `color.BEIGE` | 211 | 176 | 131 | 255 |
| `color.BROWN` | 127 | 106 | 79 | 255 |
| `color.DARKBROWN` | 76 | 63 | 47 | 255 |
| `color.WHITE` | 255 | 255 | 255 | 255 |
| `color.BLACK` | 0 | 0 | 0 | 255 |
| `color.BLANK` | 0 | 0 | 0 | 0 |
| `color.MAGENTA` | 255 | 0 | 255 | 255 |
## Libraries & Assets
- https://github.com/rxi/microtar
- https://github.com/lua/lua
- https://github.com/raysan5/raylib
- https://github.com/rxi/json.lua
- https://dejavu-fonts.github.io/
## Cool tools
- https://hardwaretester.com/gamepad
## Development references
- https://www.love2d.org/wiki/Main_Page
- https://www.lexaloffle.com/dl/docs/pico-8_manual.html
- https://home.cs.colorado.edu/~main/bgi/doc/
|
