godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-03 05:48:42 +03:00
Code Issues Packages Projects Releases Wiki Activity

Fix small problems in the "External libraries" and "Custom modules" pages

Browse Source
This commit is contained in:
Michael Alexsander Silva Dias
2018-11-15 14:06:32 -02:00
parent 1c24ed7d7a
commit 2d019998b5
2 changed files with 13 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
development/cpp/binding_to_external_libraries.rst
View File

@@ -6,9 +6,10 @@ Binding to external libraries
Modules
-------
The Summator example in :ref:`_doc_custom_modules_in_c++` is great for small, custom modules, but
what if you want to use a larger, external library? Let's look at an example
using Festival, a speech synthesis (text-to-speech) library written in C++.
The Summator example in :ref:`doc_custom_modules_in_c++` is great for small,
custom modules, but what if you want to use a larger, external library?
Let's look at an example using Festival, a speech synthesis (text-to-speech)
library written in C++.
To bind to an external library, set up a module directory similar to the Summator example:
@@ -116,12 +117,13 @@ documentation for specific instructions on how to do this for your operation sys
installation commands for Linux below, for reference.
::
sudo apt-get install festival festival-dev <-- Installs festival and speech_tools libraries
apt-cache search festvox-* <-- Displays list of voice packages
sudo apt-get install festvox-don festvox-rablpc16k festvox-kallpc16k festvox-kdlpc16k <-- Installs voices
.. note::
**Important** The voices that Festival uses (and any other potential external/3rd-party
**Important:** The voices that Festival uses (and any other potential external/3rd-party
resource) all have varying licenses and terms of use; some (if not most) of them may be
be problematic with Godot, even if the Festival Library itself is MIT License compatible.
Please be sure to check the licenses and terms of use.
@@ -132,6 +134,7 @@ festival and speech_tools libraries can be installed from the modules/tts/ direc
git using the following commands:
::
git clone https://github.com/festvox/festival
git clone https://github.com/festvox/speech_tools
@@ -139,11 +142,12 @@ If you don't want the external repository source files committed to your reposit
can link to them instead by adding them as submodules (from within the modules/tts/ directory), as seen below:
::
git submodule add https://github.com/festvox/festival
git submodule add https://github.com/festvox/speech_tools
.. note::
**Important** Please note that Git submodules are not used in the Godot repository. If
**Important:** Please note that Git submodules are not used in the Godot repository. If
you are developing a module to be merged into the main Godot repository, you should not
use submodules. If your module doesn't get merged in, you can always try to implement
the external library as a GDNative C++ plugin.

7
development/cpp/custom_modules_in_cpp.rst
View File

@@ -241,9 +241,10 @@ You can now use your newly created module from any script:
And the output will be ``60``.
.. seealso:: The previous Summator example is great for small, custom modules, but
what if you want to use a larger, external library? Refer to :ref:`_doc_binding_to_external_libraries`
for details about binding to external libraries.
.. seealso:: The previous Summator example is great for small, custom modules,
but what if you want to use a larger, external library? Refer to
:ref:`doc_binding_to_external_libraries` for details about binding to
external libraries.
Improving the build system for development
------------------------------------------