Added documentation to readme

Author Mitja Felicijan <mitja.felicijan@gmail.com> 2025-08-09 07:11:27 +0200
Committer Mitja Felicijan <mitja.felicijan@gmail.com> 2025-08-09 07:11:27 +0200
Commit 3ee2999394ab2b60b0e9c6482d00c0b2c6fbf5d5 (patch)
-rw-r--r-- README.md 64
1 files changed, 63 insertions, 1 deletions
diff --git a/README.md b/README.md
...
13
> download and replace them from official repositories if desired; they have
13
> download and replace them from official repositories if desired; they have
14
> not been tampered with.
14
> not been tampered with.
15
  
15
  
16
## Controller mappings
16
## Documentation
  
17
  
  
18
### Included functions
17
  
19
  
  
20
| Function            | Description | Arguments | Returns |
  
21
|---------------------|-------------|-----------|---------|
  
22
| open_window         |             |           |         |
  
23
| close_window        |             |           |         |
  
24
| window_running      |             |           | bool    |
  
25
| start_drawing       |             |           |         |
  
26
| stop_drawing        |             |           |         |
  
27
| clear_window        |             |           |         |
  
28
| start_camera        |             |           |         |
  
29
| stop_camera         |             |           |         |
  
30
| move_camera         |             |           |         |
  
31
| set_fps             |             |           |         |
  
32
| get_fps             |             |           | number  |
  
33
| get_dt              |             |           | number  |
  
34
| get_width           |             |           | number  |
  
35
| get_height          |             |           | number  |
  
36
| draw_info           |             |           |         |
  
37
| draw_rect           |             |           |         |
  
38
| draw_text           |             |           |         |
  
39
| draw_pixel          |             |           |         |
  
40
| draw_line           |             |           |         |
  
41
| draw_circle         |             |           |         |
  
42
| draw_ellipse        |             |           |         |
  
43
| draw_triangle       |             |           |         |
  
44
| load_image          |             |           |         |
  
45
| load_audio          |             |           |         |
  
46
| button_down         |             |           | bool    |
  
47
| button_pressed      |             |           | bool    |
  
48
  
  
49
### Controller mappings
18
  
50
  
19
| Button           | Keyboard | Xbox | Playstation | Nintendo |
51
| Button           | Keyboard | Xbox | Playstation | Nintendo |
20
|------------------|----------|------|-------------|----------|
52
|------------------|----------|------|-------------|----------|
...
26
| button.B         | P        | N/A  |             |          |
58
| button.B         | P        | N/A  |             |          |
27
| button.X         | K        | N/A  |             |          |
59
| button.X         | K        | N/A  |             |          |
28
| button.Y         | O        | N/A  |             |          |
60
| button.Y         | O        | N/A  |             |          |
  
61
  
  
62
### Default colors
  
63
  
  
64
| Color Name          | Red (r) | Green (g) | Blue (b) | Alpha (a) |
  
65
|---------------------|---------|-----------|----------|-----------|
  
66
| `color.LIGHTGRAY`   | 200     | 200       | 200      | 255       |
  
67
| `color.GRAY`        | 130     | 130       | 130      | 255       |
  
68
| `color.DARKGRAY`    | 80      | 80        | 80       | 255       |
  
69
| `color.YELLOW`      | 253     | 249       | 0        | 255       |
  
70
| `color.GOLD`        | 255     | 203       | 0        | 255       |
  
71
| `color.ORANGE`      | 255     | 161       | 0        | 255       |
  
72
| `color.PINK`        | 255     | 109       | 194      | 255       |
  
73
| `color.RED`         | 230     | 41        | 55       | 255       |
  
74
| `color.MAROON`      | 190     | 33        | 55       | 255       |
  
75
| `color.GREEN`       | 0       | 228       | 48       | 255       |
  
76
| `color.LIME`        | 0       | 158       | 47       | 255       |
  
77
| `color.DARKGREEN`   | 0       | 117       | 44       | 255       |
  
78
| `color.SKYBLUE`     | 102     | 191       | 255      | 255       |
  
79
| `color.BLUE`        | 0       | 121       | 241      | 255       |
  
80
| `color.DARKBLUE`    | 0       | 82        | 172      | 255       |
  
81
| `color.PURPLE`      | 200     | 122       | 255      | 255       |
  
82
| `color.VIOLET`      | 135     | 60        | 190      | 255       |
  
83
| `color.DARKPURPLE`  | 112     | 31        | 126      | 255       |
  
84
| `color.BEIGE`       | 211     | 176       | 131      | 255       |
  
85
| `color.BROWN`       | 127     | 106       | 79       | 255       |
  
86
| `color.DARKBROWN`   | 76      | 63        | 47       | 255       |
  
87
| `color.WHITE`       | 255     | 255       | 255      | 255       |
  
88
| `color.BLACK`       | 0       | 0         | 0        | 255       |
  
89
| `color.BLANK`       | 0       | 0         | 0        | 0         |
  
90
| `color.MAGENTA`     | 255     | 0         | 255      | 255       |
29
  
91
  
30
## Libraries & Assets
92
## Libraries & Assets
31
  
93
  
...