Skip to content

Commit 1817fec

Browse files
try
1 parent cfad3ea commit 1817fec

16 files changed

+287
-217
lines changed

README.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
## Libraries: raymath, raygui, rlgl, physac and GLFW
33
## Backends: Desktop, SDL, DRM, Web
44

5-
Chatroom: [Discord](https://discord.gg/fKDwt85aX6) or [Matrix](https://matrix.to/#/#raylib-python-cffi:matrix.org)
5+
Chatroom: [Discord](https://discord.gg/fKDwt85aX6)
66

77
New CFFI API static bindings.
88
* Automatically generated to be as close as possible to
@@ -39,7 +39,8 @@ Then install
3939
python3 -m pip install setuptools
4040
python3 -m pip install raylib==5.0.0.4
4141

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.
4344
using homebrew, apt, etc.
4445

4546
## Windows
@@ -68,7 +69,7 @@ if you want to test them.)
6869
Binaries require OS newer than Ubuntu 2020, x64 or arm64. Otherwise build from source.
6970
(Pip should attempt automatically but will need Raylib itself installed and also pkg-config.)
7071

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
7273
so may not work on other boards.
7374

7475
## Raspberry Pi
@@ -79,6 +80,7 @@ so may not work on other boards.
7980

8081
There is now a separate dynamic version of this binding:
8182

83+
python3 -m pip uninstall raylib
8284
python3 -m pip install raylib_dynamic
8385

8486
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.
106108
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)
107109
to let us know what you did.
108110

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.
110113

111114
If it still doesn't work, [submit an issue](https://github.com/electronstudio/raylib-python-cffi/issues).
112115

113116

114117
# How to use
115118

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:
117121

118122
### If you are familiar with C coding and the Raylib C library and you want to use an exact copy of the C API
119123

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).
121125

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
123127

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).
125129

126130
# Running in a web browser
127131

docs-src/pyray.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,6 @@ Example program:
5656
init_window(800, 450, "Raylib texture test")
5757
...
5858
59-
(You don't need to use the PyRay() class anymore.)
6059
6160
`See all examples here <https://github.com/electronstudio/raylib-python-cffi/tree/master/examples>`_
6261

docs/BUILDING.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ <h2>Or, Build from source manually<a class="headerlink" href="#or-build-from-sou
127127
<p>If the Pip build doesn’t work, please submit a bug. (And if you have
128128
fixed it, a PR.)</p>
129129
</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
131131
at <a class="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>
132132
<section id="windows-manual-build">
133133
<h3>Windows manual build<a class="headerlink" href="#windows-manual-build" title="Link to this heading"></a></h3>

docs/README.html

Lines changed: 24 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@
6464
</li>
6565
<li class="toctree-l1"><a class="reference internal" href="#how-to-use">How to use</a><ul>
6666
<li class="toctree-l2"><a class="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-
<li class="toctree-l2"><a class="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+
<li class="toctree-l2"><a class="reference internal" href="#if-you-prefer-a-more-pythonistic-api">If you prefer a more Pythonistic API</a></li>
6868
</ul>
6969
</li>
7070
<li class="toctree-l1"><a class="reference internal" href="#running-in-a-web-browser">Running in a web browser</a></li>
@@ -116,7 +116,7 @@ <h2>Libraries: raymath, raygui, rlgl, physac and GLFW<a class="headerlink" href=
116116
</section>
117117
<section id="backends-desktop-sdl-drm-web">
118118
<h2>Backends: Desktop, SDL, DRM, Web<a class="headerlink" href="#backends-desktop-sdl-drm-web" title="Link to this heading"></a></h2>
119-
<p>Chatroom: <a class="reference external" href="https://discord.gg/fKDwt85aX6">Discord</a> or <a class="reference external" href="https://matrix.to/#/#raylib-python-cffi:matrix.org">Matrix</a></p>
119+
<p>Chatroom: <a class="reference external" href="https://discord.gg/fKDwt85aX6">Discord</a></p>
120120
<p>New CFFI API static bindings.</p>
121121
<ul class="simple">
122122
<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
153153
python3 -m pip install raylib==5.0.0.4
154154
</pre></div>
155155
</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.
157158
using homebrew, apt, etc.</p>
158159
<section id="windows">
159160
<h2>Windows<a class="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">
162163
</section>
163164
<section id="macos">
164165
<h2>MacOS<a class="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+
<ul class="simple">
168+
<li><p>arm64 MacOS 14</p></li>
169+
<li><p>x64 MacOS 10.13, or newer.</p></li>
170+
</ul>
166171
<p>Older MacOS requires building from source but this is usually simple:</p>
167172
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>brew install pkg-config
168173
brew install raylib
169174
python3 -m pip install raylib==5.0.0.4
170175
</pre></div>
171176
</div>
177+
<p>(I do have binaries for arm64 MacOS 11, 12 and 13 but I have no way of testing they work, so post an issue
178+
if you want to test them.)</p>
172179
</section>
173180
<section id="linux">
174181
<h2>Linux<a class="headerlink" href="#linux" title="Link to this heading"></a></h2>
175182
<p>Binaries require OS newer than Ubuntu 2020, x64 or arm64. Otherwise build from source.
176183
(Pip should attempt automatically but will need Raylib itself installed and also pkg-config.)</p>
177-
<p>The arm64 builds are built on Raspberry Pi arm64 Bullseye
184+
<p>The arm64 binaries are built on Raspberry Pi arm64 Bullseye with OpenGL 2.0
178185
so may not work on other boards.</p>
179186
</section>
180187
<section id="raspberry-pi">
@@ -184,7 +191,8 @@ <h2>Raspberry Pi<a class="headerlink" href="#raspberry-pi" title="Link to this h
184191
<section id="dynamic-binding-version">
185192
<h2>Dynamic binding version<a class="headerlink" href="#dynamic-binding-version" title="Link to this heading"></a></h2>
186193
<p>There is now a separate dynamic version of this binding:</p>
187-
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>python3 -m pip install raylib_dynamic
194+
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>python3 -m pip uninstall raylib
195+
python3 -m pip install raylib_dynamic
188196
</pre></div>
189197
</div>
190198
<p>It works on some systems where the static version doesn’t, <a class="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
196204
python3 -m pip install raylib_sdl
197205
</pre></div>
198206
</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>
200208
</section>
201209
<section id="drm-backend">
202210
<h2>DRM backend<a class="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
205213
python3 -m pip install raylib_drm
206214
</pre></div>
207215
</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>
209217
</section>
210218
<section id="problems">
211219
<h2>Problems?<a class="headerlink" href="#problems" title="Link to this heading"></a></h2>
212220
<p>If it doesn’t work, <a class="reference internal" href="BUILDING.html"><span class="std std-doc">try to build manually.</span></a>. If that works then <a class="reference external" href="https://github.com/electronstudio/raylib-python-cffi/issues">submit an issue</a>
213221
to let us know what you did.</p>
214-
<p>If you need help you can try asking <a class="reference external" href="https://discord.gg/raylib">on Discord</a>.</p>
222+
<p>If you need help you can try asking on <a class="reference external" href="https://discord.gg/fKDwt85aX6">our discord</a>. There is also a large <a class="reference external" href="https://discord.gg/raylib">Raylib discord</a>
223+
for issues that are not Python-specific.</p>
215224
<p>If it still doesn’t work, <a class="reference external" href="https://github.com/electronstudio/raylib-python-cffi/issues">submit an issue</a>.</p>
216225
</section>
217226
</section>
218227
<section id="how-to-use">
219228
<h1>How to use<a class="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, <code class="docutils literal notranslate"><span class="pre">raylib</span></code> and <code class="docutils literal notranslate"><span class="pre">pyray</span></code>. (There is no separate package for
230+
pyray). You can use either or both:</p>
221231
<section id="if-you-are-familiar-with-c-coding-and-the-raylib-c-library-and-you-want-to-use-an-exact-copy-of-the-c-api">
222232
<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<a class="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 <a class="reference external" href="https://electronstudio.github.io/raylib-python-cffi/raylib.html">the C API</a>.</p>
233+
<p>Use <a class="reference external" href="https://electronstudio.github.io/raylib-python-cffi/raylib.html">the raylib module</a>.</p>
224234
</section>
225-
<section id="if-you-prefer-a-slightly-more-pythonistic-api-and-don-t-mind-it-might-be-slightly-slower">
226-
<h2>If you prefer a slightly more Pythonistic API and don’t mind it might be slightly slower<a class="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>
227-
<p>Use <a class="reference external" href="https://electronstudio.github.io/raylib-python-cffi/pyray.html">the Python API</a>.</p>
235+
<section id="if-you-prefer-a-more-pythonistic-api">
236+
<h2>If you prefer a more Pythonistic API<a class="headerlink" href="#if-you-prefer-a-more-pythonistic-api" title="Link to this heading"></a></h2>
237+
<p>Use <a class="reference external" href="https://electronstudio.github.io/raylib-python-cffi/pyray.html">the pyray module</a>.</p>
228238
</section>
229239
</section>
230240
<section id="running-in-a-web-browser">

docs/_sources/BUILDING.rst.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ project.
3838
If the Pip build doesn’t work, please submit a bug. (And if you have
3939
fixed it, a PR.)
4040

41-
Manual instructions follow, but may be outdated, so see also how we actually build the wheels
41+
Manual instructions follow, but are probably outdated, so see instead how we actually build the wheels
4242
at https://github.com/electronstudio/raylib-python-cffi/blob/master/.github/workflows/build.yml
4343

4444
Windows manual build

docs/_sources/README.md.txt

Lines changed: 20 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
## Libraries: raymath, raygui, rlgl, physac and GLFW
33
## Backends: Desktop, SDL, DRM, Web
44

5-
Chatroom: [Discord](https://discord.gg/fKDwt85aX6) or [Matrix](https://matrix.to/#/#raylib-python-cffi:matrix.org)
5+
Chatroom: [Discord](https://discord.gg/fKDwt85aX6)
66

77
New CFFI API static bindings.
88
* Automatically generated to be as close as possible to
@@ -39,7 +39,8 @@ Then install
3939
python3 -m pip install setuptools
4040
python3 -m pip install raylib==5.0.0.4
4141

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.
4344
using homebrew, apt, etc.
4445

4546
## Windows
@@ -50,20 +51,25 @@ Use an [official Windows Python release](https://www.python.org/downloads/window
5051

5152
## MacOS
5253

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.
5457

5558
Older MacOS requires building from source but this is usually simple:
5659

5760
brew install pkg-config
5861
brew install raylib
5962
python3 -m pip install raylib==5.0.0.4
6063

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+
6167
## Linux
6268

6369
Binaries require OS newer than Ubuntu 2020, x64 or arm64. Otherwise build from source.
6470
(Pip should attempt automatically but will need Raylib itself installed and also pkg-config.)
6571

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
6773
so may not work on other boards.
6874

6975
## Raspberry Pi
@@ -74,6 +80,7 @@ so may not work on other boards.
7480

7581
There is now a separate dynamic version of this binding:
7682

83+
python3 -m pip uninstall raylib
7784
python3 -m pip install raylib_dynamic
7885

7986
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:
8592
python3 -m pip uninstall raylib
8693
python3 -m pip install raylib_sdl
8794

88-
You can't have multiple backends installed at once.
95+
You can't have multiple raylib packages installed at once.
8996

9097
## DRM backend
9198

@@ -94,29 +101,31 @@ This uses the Linux framebuffer for devices that don't run X11/Wayland:
94101
python3 -m pip uninstall raylib
95102
python3 -m pip install raylib_drm
96103

97-
You can't have multiple backends installed at once.
104+
You can't have multiple raylib packages installed at once.
98105

99106
## Problems?
100107

101108
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)
102109
to let us know what you did.
103110

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.
105113

106114
If it still doesn't work, [submit an issue](https://github.com/electronstudio/raylib-python-cffi/issues).
107115

108116

109117
# How to use
110118

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:
112121

113122
### If you are familiar with C coding and the Raylib C library and you want to use an exact copy of the C API
114123

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).
116125

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
118127

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).
120129

121130
# Running in a web browser
122131

docs/_sources/pyray.rst.txt

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,6 @@ Example program:
5656
init_window(800, 450, "Raylib texture test")
5757
...
5858
59-
(You don't need to use the PyRay() class anymore.)
6059
6160
`See all examples here <https://github.com/electronstudio/raylib-python-cffi/tree/master/examples>`_
6261

0 commit comments

Comments
 (0)