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
Copy file name to clipboardExpand all lines: engine_details/development/compiling/compiling_for_linuxbsd.rst
+39Lines changed: 39 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -297,6 +297,45 @@ Manager.
297
297
:ref:`doc_data_paths_self_contained_mode` by creating a file called
298
298
``._sc_`` or ``_sc_`` in the ``bin/`` folder.
299
299
300
+
Compiling with AccessKit support
301
+
--------------------------------
302
+
303
+
AccessKit provides support for screen readers.
304
+
305
+
By default, Godot is built with AccessKit dynamically linked. You can use it by placing
306
+
``accesskit.so`` alongside the executable.
307
+
308
+
.. note:: You can use dynamically linked AccessKit with export templates as well, rename
309
+
the SO to ``accesskit.{architecture}.so``
310
+
and place them alongside the export template executables, and the libraries will
311
+
be automatically copied during the export process.
312
+
313
+
To compile Godot with statically linked AccessKit:
314
+
315
+
- Download the pre-built static libraries from `godot-accesskit-c-static library <https://github.com/godotengine/godot-accesskit-c-static/releases>`_, and unzip them.
316
+
- When building Godot, add ``accesskit_sdk_path={path}`` to tell SCons where to look for the AccessKit libraries:
317
+
318
+
::
319
+
320
+
scons platform=linuxbsd accesskit_sdk_path=<...>
321
+
322
+
.. note:: You can optionally build the godot-angle-static libraries yourself with
323
+
the following steps:
324
+
325
+
1. Clone the `godot-accesskit-c-static <https://github.com/godotengine/godot-accesskit-c-static/>`_
326
+
directory and navigate to it.
327
+
2. Run the following command:
328
+
329
+
::
330
+
331
+
cd accesskit-c
332
+
cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
333
+
cmake --build build
334
+
cmake --install build
335
+
336
+
The AccessKit static library should be built using the same compiler you are
Copy file name to clipboardExpand all lines: engine_details/development/compiling/compiling_for_macos.rst
+39Lines changed: 39 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -84,6 +84,45 @@ Manager.
84
84
:ref:`doc_data_paths_self_contained_mode` by creating a file called
85
85
``._sc_`` or ``_sc_`` in the ``bin/`` folder.
86
86
87
+
Compiling with AccessKit support
88
+
--------------------------------
89
+
90
+
AccessKit provides support for screen readers.
91
+
92
+
By default, Godot is built with AccessKit dynamically linked. You can use it by placing
93
+
``accesskit.dylib`` alongside the standalone executable or in the app bundle's ``Frameworks`` folder.
94
+
95
+
.. note:: You can use dynamically linked AccessKit with export templates as well, rename
96
+
the DYLIB to ``accesskit.{architecture}.dylib``
97
+
and place them inside the export template app bundle ``Frameworks`` folder, and the
98
+
libraries will be automatically copied during the export process.
99
+
100
+
To compile Godot with statically linked AccessKit:
101
+
102
+
- Download the pre-built static libraries from `godot-accesskit-c-static library <https://github.com/godotengine/godot-accesskit-c-static/releases>`_, and unzip them.
103
+
- When building Godot, add ``accesskit_sdk_path={path}`` to tell SCons where to look for the AccessKit libraries:
104
+
105
+
::
106
+
107
+
scons platform=macos accesskit_sdk_path=<...>
108
+
109
+
.. note:: You can optionally build the godot-angle-static libraries yourself with
110
+
the following steps:
111
+
112
+
1. Clone the `godot-accesskit-c-static <https://github.com/godotengine/godot-accesskit-c-static/>`_
113
+
directory and navigate to it.
114
+
2. Run the following command:
115
+
116
+
::
117
+
118
+
cd accesskit-c
119
+
cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
120
+
cmake --build build
121
+
cmake --install build
122
+
123
+
The AccessKit static library should be built using the same compiler you are
Copy file name to clipboardExpand all lines: engine_details/development/compiling/compiling_for_windows.rst
+63-23Lines changed: 63 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -218,18 +218,18 @@ optional PIX and Agility SDK components).
218
218
./update_mesa.sh
219
219
scons
220
220
221
-
If you are building with MinGW-w64, add ``use_mingw=yes`` to the ``scons``
222
-
command, you can also specify build architecture using ``arch={architecture}``.
223
-
If you are building with MinGW-LLVM, add both ``use_mingw=yes`` and
224
-
``use_llvm=yes`` to the ``scons`` command.
221
+
If you are building with MinGW-w64, add ``use_mingw=yes`` to the ``scons``
222
+
command, you can also specify the build architecture using ``arch={architecture}``.
223
+
If you are building with MinGW-LLVM, add both ``use_mingw=yes`` and
224
+
``use_llvm=yes`` to the ``scons`` command.
225
225
226
-
If you are building with MinGW and the binaries are not located in
227
-
the ``PATH``, add ``mingw_prefix="/path/to/mingw"`` to the ``scons``
228
-
command.
226
+
If you are building with MinGW and the binaries are not located in
227
+
the ``PATH``, add ``mingw_prefix="/path/to/mingw"`` to the ``scons``
228
+
command.
229
229
230
-
Mesa static library should be built using the same compiler and the
231
-
same CRT (if you are building with MinGW) you are using for building
232
-
Godot.
230
+
The Mesa static library should be built using the same compiler and the
231
+
same CRT (if you are building with MinGW) you are using for building
232
+
Godot.
233
233
234
234
Optionally, you can compile with the following for additional features:
235
235
@@ -282,6 +282,46 @@ Or, with all options enabled:
282
282
multi-arch. DLLs will be copied to the appropriate ``bin/<arch>/``
283
283
subdirectories and at runtime the right one will be loaded.
284
284
285
+
Compiling with AccessKit support
286
+
--------------------------------
287
+
288
+
AccessKit provides support for screen readers.
289
+
290
+
By default, Godot is built with AccessKit dynamically linked. You can use it by placing
291
+
``accesskit.dll`` alongside the executable.
292
+
293
+
.. note:: You can use dynamically linked AccessKit with export templates as well, rename
294
+
the DLL to ``accesskit.{architecture}.dll``
295
+
and place them alongside the export template executables, and the libraries will
296
+
be automatically copied during the export process.
297
+
298
+
To compile Godot with statically linked AccessKit:
299
+
300
+
- Download the pre-built static libraries from `godot-accesskit-c-static library <https://github.com/godotengine/godot-accesskit-c-static/releases>`_, and unzip them.
301
+
- When building Godot, add ``accesskit_sdk_path={path}`` to tell SCons where to look for the AccessKit libraries:
302
+
303
+
::
304
+
305
+
scons platform=windows accesskit_sdk_path=<...>
306
+
307
+
.. note:: You can optionally build the godot-angle-static libraries yourself with
308
+
the following steps:
309
+
310
+
1. Clone the `godot-accesskit-c-static <https://github.com/godotengine/godot-accesskit-c-static/>`_
311
+
directory and navigate to it.
312
+
2. Run the following command:
313
+
314
+
::
315
+
316
+
cd accesskit-c
317
+
cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
318
+
cmake --build build
319
+
cmake --install build
320
+
321
+
The AccessKit static library should be built using the same compiler and the
322
+
same CRT (if you are building with MinGW) you are using for building
323
+
Godot.
324
+
285
325
Compiling with ANGLE support
286
326
----------------------------
287
327
@@ -293,13 +333,13 @@ By default, Godot is built with dynamically linked ANGLE, you can use it by plac
293
333
``libEGL.dll`` and ``libGLESv2.dll`` alongside the executable.
294
334
295
335
.. note:: You can use dynamically linked ANGLE with export templates as well, rename
296
-
aforementioned DLLs to ``libEGL.{architecture}.dll`` and ``libGLESv2.{architecture}.dll``
297
-
and place them alongside export template executables, and libraries will
336
+
the DLLs to ``libEGL.{architecture}.dll`` and ``libGLESv2.{architecture}.dll``
337
+
and place them alongside the export template executables, and the libraries will
298
338
be automatically copied during the export process.
299
339
300
340
To compile Godot with statically linked ANGLE:
301
341
302
-
- Download pre-built static libraries from `godot-angle-static library <https://github.com/godotengine/godot-angle-static/releases>`_, and unzip them.
342
+
- Download the pre-built static libraries from `godot-angle-static library <https://github.com/godotengine/godot-angle-static/releases>`_, and unzip them.
303
343
- When building Godot, add ``angle_libs={path}`` to tell SCons where to look for the ANGLE libraries:
304
344
305
345
::
@@ -319,18 +359,18 @@ To compile Godot with statically linked ANGLE:
319
359
./update_angle.sh
320
360
scons
321
361
322
-
If you are buildng with MinGW, add ``use_mingw=yes`` to the command,
323
-
you can also specify build architecture using ``arch={architecture}``.
324
-
If you are building with MinGW-LLVM, add both ``use_mingw=yes`` and
325
-
``use_llvm=yes`` to the ``scons`` command.
362
+
If you are buildng with MinGW, add ``use_mingw=yes`` to the command,
363
+
you can also specify the build architecture using ``arch={architecture}``.
364
+
If you are building with MinGW-LLVM, add both ``use_mingw=yes`` and
365
+
``use_llvm=yes`` to the ``scons`` command.
326
366
327
-
If you are building with MinGW and the binaries are not located in
328
-
the ``PATH``, add ``mingw_prefix="/path/to/mingw"`` to the ``scons``
329
-
command.
367
+
If you are building with MinGW and the binaries are not located in
368
+
the ``PATH``, add ``mingw_prefix="/path/to/mingw"`` to the ``scons``
369
+
command.
330
370
331
-
ANGLE static library should be built using the same compiler and the
332
-
same CRT (if you are building with MinGW) you are using for building
333
-
Godot.
371
+
The ANGLE static library should be built using the same compiler and the
372
+
same CRT (if you are building with MinGW) you are using for building
0 commit comments