You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Automatically generated to be as close as possible to
@@ -39,7 +39,8 @@ Then install
39
39
python3 -m pip install setuptools
40
40
python3 -m pip install raylib==5.0.0.4
41
41
42
-
On most platforms it should install a binary wheel. If yours isn't available then pip will attempt to build from source, in which case you will need to have Raylib development libs installed, e.g.
42
+
On most platforms it should install a binary wheel. If yours isn't available then pip will attempt to build from
43
+
source, in which case you will need to have Raylib development libs installed, e.g.
43
44
using homebrew, apt, etc.
44
45
45
46
## Windows
@@ -68,7 +69,7 @@ if you want to test them.)
68
69
Binaries require OS newer than Ubuntu 2020, x64 or arm64. Otherwise build from source.
69
70
(Pip should attempt automatically but will need Raylib itself installed and also pkg-config.)
70
71
71
-
The arm64 builds are built on Raspberry Pi arm64 Bullseye
72
+
The arm64 binaries are built on Raspberry Pi arm64 Bullseye with OpenGL 2.0
72
73
so may not work on other boards.
73
74
74
75
## Raspberry Pi
@@ -79,6 +80,7 @@ so may not work on other boards.
79
80
80
81
There is now a separate dynamic version of this binding:
81
82
83
+
python3 -m pip uninstall raylib
82
84
python3 -m pip install raylib_dynamic
83
85
84
86
It works on some systems where the static version doesn't, [but be sure to read these caveats before using it](https://electronstudio.github.io/raylib-python-cffi/dynamic.html)
@@ -106,22 +108,24 @@ You can't have multiple raylib packages installed at once.
106
108
If it doesn't work, [try to build manually.](BUILDING.rst). If that works then [submit an issue](https://github.com/electronstudio/raylib-python-cffi/issues)
107
109
to let us know what you did.
108
110
109
-
If you need help you can try asking [on Discord](https://discord.gg/raylib).
111
+
If you need help you can try asking on [our discord](https://discord.gg/fKDwt85aX6). There is also a large [Raylib discord](https://discord.gg/raylib)
112
+
for issues that are not Python-specific.
110
113
111
114
If it still doesn't work, [submit an issue](https://github.com/electronstudio/raylib-python-cffi/issues).
112
115
113
116
114
117
# How to use
115
118
116
-
There are two APIs, you can use either or both:
119
+
There are two modules in the raylib package, `raylib` and `pyray`. (There is no separate package for
120
+
pyray). You can use either or both:
117
121
118
122
### If you are familiar with C coding and the Raylib C library and you want to use an exact copy of the C API
119
123
120
-
Use [the C API](https://electronstudio.github.io/raylib-python-cffi/raylib.html).
124
+
Use [the raylib module](https://electronstudio.github.io/raylib-python-cffi/raylib.html).
121
125
122
-
### If you prefer a slightly more Pythonistic API and don't mind it might be slightly slower
126
+
### If you prefer a more Pythonistic API
123
127
124
-
Use [the Python API](https://electronstudio.github.io/raylib-python-cffi/pyray.html).
128
+
Use [the pyray module](https://electronstudio.github.io/raylib-python-cffi/pyray.html).
<p>If the Pip build doesn’t work, please submit a bug. (And if you have
128
128
fixed it, a PR.)</p>
129
129
</div>
130
-
<p>Manual instructions follow, but may be outdated, so see also how we actually build the wheels
130
+
<p>Manual instructions follow, but are probably outdated, so see instead how we actually build the wheels
131
131
at <aclass="reference external" href="https://github.com/electronstudio/raylib-python-cffi/blob/master/.github/workflows/build.yml">https://github.com/electronstudio/raylib-python-cffi/blob/master/.github/workflows/build.yml</a></p>
132
132
<sectionid="windows-manual-build">
133
133
<h3>Windows manual build<aclass="headerlink" href="#windows-manual-build" title="Link to this heading"></a></h3>
Copy file name to clipboardExpand all lines: docs/README.html
+24-14Lines changed: 24 additions & 14 deletions
Original file line number
Diff line number
Diff line change
@@ -64,7 +64,7 @@
64
64
</li>
65
65
<liclass="toctree-l1"><aclass="reference internal" href="#how-to-use">How to use</a><ul>
66
66
<liclass="toctree-l2"><aclass="reference internal" href="#if-you-are-familiar-with-c-coding-and-the-raylib-c-library-and-you-want-to-use-an-exact-copy-of-the-c-api">If you are familiar with C coding and the Raylib C library and you want to use an exact copy of the C API</a></li>
67
-
<liclass="toctree-l2"><aclass="reference internal" href="#if-you-prefer-a-slightly-more-pythonistic-api-and-don-t-mind-it-might-be-slightly-slower">If you prefer a slightly more Pythonistic API and don’t mind it might be slightly slower</a></li>
67
+
<liclass="toctree-l2"><aclass="reference internal" href="#if-you-prefer-a-more-pythonistic-api">If you prefer a more Pythonistic API</a></li>
68
68
</ul>
69
69
</li>
70
70
<liclass="toctree-l1"><aclass="reference internal" href="#running-in-a-web-browser">Running in a web browser</a></li>
<li><p>Automatically generated to be as close as possible to
@@ -153,7 +153,8 @@ <h1>Installation<a class="headerlink" href="#installation" title="Link to this h
153
153
python3 -m pip install raylib==5.0.0.4
154
154
</pre></div>
155
155
</div>
156
-
<p>On most platforms it should install a binary wheel. If yours isn’t available then pip will attempt to build from source, in which case you will need to have Raylib development libs installed, e.g.
156
+
<p>On most platforms it should install a binary wheel. If yours isn’t available then pip will attempt to build from
157
+
source, in which case you will need to have Raylib development libs installed, e.g.
157
158
using homebrew, apt, etc.</p>
158
159
<sectionid="windows">
159
160
<h2>Windows<aclass="headerlink" href="#windows" title="Link to this heading"></a></h2>
@@ -162,19 +163,25 @@ <h2>Windows<a class="headerlink" href="#windows" title="Link to this heading">
162
163
</section>
163
164
<sectionid="macos">
164
165
<h2>MacOS<aclass="headerlink" href="#macos" title="Link to this heading"></a></h2>
165
-
<p>Binaries require arm64 MacOS 13 or x64 MacOS 12 or newer.</p>
166
+
<p>Binaries require:</p>
167
+
<ulclass="simple">
168
+
<li><p>arm64 MacOS 14</p></li>
169
+
<li><p>x64 MacOS 10.13, or newer.</p></li>
170
+
</ul>
166
171
<p>Older MacOS requires building from source but this is usually simple:</p>
<p>It works on some systems where the static version doesn’t, <aclass="reference external" href="https://electronstudio.github.io/raylib-python-cffi/dynamic.html">but be sure to read these caveats before using it</a></p>
@@ -196,7 +204,7 @@ <h2>SDL backend<a class="headerlink" href="#sdl-backend" title="Link to this hea
196
204
python3 -m pip install raylib_sdl
197
205
</pre></div>
198
206
</div>
199
-
<p>You can’t have multiple backends installed at once.</p>
207
+
<p>You can’t have multiple raylib packages installed at once.</p>
200
208
</section>
201
209
<sectionid="drm-backend">
202
210
<h2>DRM backend<aclass="headerlink" href="#drm-backend" title="Link to this heading"></a></h2>
@@ -205,26 +213,28 @@ <h2>DRM backend<a class="headerlink" href="#drm-backend" title="Link to this hea
205
213
python3 -m pip install raylib_drm
206
214
</pre></div>
207
215
</div>
208
-
<p>You can’t have multiple backends installed at once.</p>
216
+
<p>You can’t have multiple raylib packages installed at once.</p>
209
217
</section>
210
218
<sectionid="problems">
211
219
<h2>Problems?<aclass="headerlink" href="#problems" title="Link to this heading"></a></h2>
212
220
<p>If it doesn’t work, <aclass="reference internal" href="BUILDING.html"><spanclass="std std-doc">try to build manually.</span></a>. If that works then <aclass="reference external" href="https://github.com/electronstudio/raylib-python-cffi/issues">submit an issue</a>
213
221
to let us know what you did.</p>
214
-
<p>If you need help you can try asking <aclass="reference external" href="https://discord.gg/raylib">on Discord</a>.</p>
222
+
<p>If you need help you can try asking on <aclass="reference external" href="https://discord.gg/fKDwt85aX6">our discord</a>. There is also a large <aclass="reference external" href="https://discord.gg/raylib">Raylib discord</a>
223
+
for issues that are not Python-specific.</p>
215
224
<p>If it still doesn’t work, <aclass="reference external" href="https://github.com/electronstudio/raylib-python-cffi/issues">submit an issue</a>.</p>
216
225
</section>
217
226
</section>
218
227
<sectionid="how-to-use">
219
228
<h1>How to use<aclass="headerlink" href="#how-to-use" title="Link to this heading"></a></h1>
220
-
<p>There are two APIs, you can use either or both:</p>
229
+
<p>There are two modules in the raylib package, <codeclass="docutils literal notranslate"><spanclass="pre">raylib</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">pyray</span></code>. (There is no separate package for
<h2>If you are familiar with C coding and the Raylib C library and you want to use an exact copy of the C API<aclass="headerlink" href="#if-you-are-familiar-with-c-coding-and-the-raylib-c-library-and-you-want-to-use-an-exact-copy-of-the-c-api" title="Link to this heading"></a></h2>
223
-
<p>Use <aclass="reference external" href="https://electronstudio.github.io/raylib-python-cffi/raylib.html">the C API</a>.</p>
<h2>If you prefer a slightly more Pythonistic API and don’t mind it might be slightly slower<aclass="headerlink" href="#if-you-prefer-a-slightly-more-pythonistic-api-and-don-t-mind-it-might-be-slightly-slower" title="Link to this heading"></a></h2>
* Automatically generated to be as close as possible to
@@ -39,7 +39,8 @@ Then install
39
39
python3 -m pip install setuptools
40
40
python3 -m pip install raylib==5.0.0.4
41
41
42
-
On most platforms it should install a binary wheel. If yours isn't available then pip will attempt to build from source, in which case you will need to have Raylib development libs installed, e.g.
42
+
On most platforms it should install a binary wheel. If yours isn't available then pip will attempt to build from
43
+
source, in which case you will need to have Raylib development libs installed, e.g.
43
44
using homebrew, apt, etc.
44
45
45
46
## Windows
@@ -50,20 +51,25 @@ Use an [official Windows Python release](https://www.python.org/downloads/window
50
51
51
52
## MacOS
52
53
53
-
Binaries require arm64 MacOS 13 or x64 MacOS 12 or newer.
54
+
Binaries require:
55
+
* arm64 MacOS 14
56
+
* x64 MacOS 10.13, or newer.
54
57
55
58
Older MacOS requires building from source but this is usually simple:
56
59
57
60
brew install pkg-config
58
61
brew install raylib
59
62
python3 -m pip install raylib==5.0.0.4
60
63
64
+
(I do have binaries for arm64 MacOS 11, 12 and 13 but I have no way of testing they work, so post an issue
65
+
if you want to test them.)
66
+
61
67
## Linux
62
68
63
69
Binaries require OS newer than Ubuntu 2020, x64 or arm64. Otherwise build from source.
64
70
(Pip should attempt automatically but will need Raylib itself installed and also pkg-config.)
65
71
66
-
The arm64 builds are built on Raspberry Pi arm64 Bullseye
72
+
The arm64 binaries are built on Raspberry Pi arm64 Bullseye with OpenGL 2.0
67
73
so may not work on other boards.
68
74
69
75
## Raspberry Pi
@@ -74,6 +80,7 @@ so may not work on other boards.
74
80
75
81
There is now a separate dynamic version of this binding:
76
82
83
+
python3 -m pip uninstall raylib
77
84
python3 -m pip install raylib_dynamic
78
85
79
86
It works on some systems where the static version doesn't, [but be sure to read these caveats before using it](https://electronstudio.github.io/raylib-python-cffi/dynamic.html)
@@ -85,7 +92,7 @@ This is not well tested but has better support for controllers:
85
92
python3 -m pip uninstall raylib
86
93
python3 -m pip install raylib_sdl
87
94
88
-
You can't have multiple backends installed at once.
95
+
You can't have multiple raylib packages installed at once.
89
96
90
97
## DRM backend
91
98
@@ -94,29 +101,31 @@ This uses the Linux framebuffer for devices that don't run X11/Wayland:
94
101
python3 -m pip uninstall raylib
95
102
python3 -m pip install raylib_drm
96
103
97
-
You can't have multiple backends installed at once.
104
+
You can't have multiple raylib packages installed at once.
98
105
99
106
## Problems?
100
107
101
108
If it doesn't work, [try to build manually.](BUILDING.rst). If that works then [submit an issue](https://github.com/electronstudio/raylib-python-cffi/issues)
102
109
to let us know what you did.
103
110
104
-
If you need help you can try asking [on Discord](https://discord.gg/raylib).
111
+
If you need help you can try asking on [our discord](https://discord.gg/fKDwt85aX6). There is also a large [Raylib discord](https://discord.gg/raylib)
112
+
for issues that are not Python-specific.
105
113
106
114
If it still doesn't work, [submit an issue](https://github.com/electronstudio/raylib-python-cffi/issues).
107
115
108
116
109
117
# How to use
110
118
111
-
There are two APIs, you can use either or both:
119
+
There are two modules in the raylib package, `raylib` and `pyray`. (There is no separate package for
120
+
pyray). You can use either or both:
112
121
113
122
### If you are familiar with C coding and the Raylib C library and you want to use an exact copy of the C API
114
123
115
-
Use [the C API](https://electronstudio.github.io/raylib-python-cffi/raylib.html).
124
+
Use [the raylib module](https://electronstudio.github.io/raylib-python-cffi/raylib.html).
116
125
117
-
### If you prefer a slightly more Pythonistic API and don't mind it might be slightly slower
126
+
### If you prefer a more Pythonistic API
118
127
119
-
Use [the Python API](https://electronstudio.github.io/raylib-python-cffi/pyray.html).
128
+
Use [the pyray module](https://electronstudio.github.io/raylib-python-cffi/pyray.html).
0 commit comments