Go to file
Andrii Doroshenko (Xrayez) a96f0e98d7 Add custom_modules build option to compile external user modules
This patch adds ability to include external, user-defined C++ modules
to be compiled as part of Godot via `custom_modules` build option
which can be passed to `scons`.

```
scons platform=x11 tools=yes custom_modules="../project/modules"
```

Features:

- detects all available modules under `custom_modules` directory the
same way as it does for built-in modules (not recursive);
- works with both relative and absolute paths on the filesystem;
- multiple search paths can be specified as a comma-separated list.

Module custom documentation and editor icons collection and generation
process is adapted to work with absolute paths needed by such modules.

Also fixed doctool bug mixing absolute and relative paths respectively.

Implementation details:

- `env.module_list` is a dictionary now, which holds both module name as
  key and either a relative or absolute path to a module as a value.
- `methods.detect_modules` is run twice: once for built-in modules, and
  second for external modules, all combined later.
- `methods.detect_modules` was not doing what it says on the tin. It is
  split into `detect_modules` which collects a list of available modules
  and `write_modules` which generates `register_types` sources for each.
- whether a module is built-in or external is distinguished by relative
  or absolute paths respectively. `custom_modules` scons converter
  ensures that the path is absolute even if relative path is supplied,
  including expanding user paths and symbolic links.
- treats the parent directory as if it was Godot's base directory, so
  that there's no need to change include paths in cases where custom
  modules are included as dependencies in other modules.
2020-05-25 15:33:32 +03:00
.github Merge pull request #38262 from Xrayez/resurrect-issues 2020-05-25 11:35:07 +02:00
core Merge pull request #38887 from AndreaCatania/oahash_imp 2020-05-25 11:55:06 +02:00
doc Clarifies 'icon_separation' in TabContainer (instead of 'hseparation') 2020-05-21 21:53:17 +02:00
drivers Delete DummyMesh when RasterizerStorageDummy is freed 2020-05-20 21:23:37 -04:00
editor Add custom_modules build option to compile external user modules 2020-05-25 15:33:32 +03:00
main Add custom_modules build option to compile external user modules 2020-05-25 15:33:32 +03:00
misc SCons: Improve registration of compilation_db tool, check version 2020-05-18 14:11:19 +02:00
modules Add custom_modules build option to compile external user modules 2020-05-25 15:33:32 +03:00
platform Merge pull request #39004 from nekomatata/android-reset-surface 2020-05-24 22:31:03 +02:00
scene Merge pull request #38978 from nekomatata/remote-inspector-res-preview 2020-05-25 08:33:21 +02:00
servers doc: Sync classref with current source 2020-05-20 15:29:37 +02:00
thirdparty xatlas: Sync with upstream 470576d 2020-05-20 13:51:15 +02:00
.appveyor.yml Added compilation database support for clang and gcc 2020-05-12 13:07:50 +02:00
.clang-format Style: clang-format: Disable KeepEmptyLinesAtTheStartOfBlocks 2020-05-14 16:54:55 +02:00
.clang-tidy Style: Enforce braces around if blocks and loops 2020-05-14 21:57:34 +02:00
.editorconfig Miscellaneous cleanup for the Android codebase: 2020-03-04 12:16:17 -08:00
.gitattributes Mark *.tza files as binary in .gitattributes for old Git versions 2020-05-12 09:49:19 +02:00
.gitignore Add custom.py to .gitignore 2020-05-18 10:28:43 +03:00
.mailmap Update AUTHORS and DONORS list 2020-04-17 13:40:29 +02:00
.travis.yml Re-enable travis CI for javascript platform. 2020-05-10 18:22:48 +02:00
AUTHORS.md Update AUTHORS and DONORS list 2020-04-17 13:40:29 +02:00
CHANGELOG.md Changelog: Mention 3.2 changes to TileMap features 2020-02-05 15:10:58 +01:00
CODE_OF_CONDUCT.md Add a link to the code of conduct in the repository 2019-12-22 18:05:24 +01:00
CONTRIBUTING.md Improve CONTRIBUTING.md and update it to follow recent changes 2020-02-01 09:57:32 +01:00
COPYRIGHT.txt xatlas: Sync with upstream 470576d 2020-05-20 13:51:15 +02:00
DONORS.md Update DONORS list 2020-05-05 16:24:40 +02:00
gles_builders.py GLSL: Change shader type specifier from [vertex] to #[vertex] 2020-05-18 10:58:14 +02:00
icon.png Optimize images losslessly using oxipng -o6 --strip all --zopfli 2018-06-28 19:17:41 +02:00
icon.svg Use new Godot icon consistently everywhere 2017-05-17 19:53:59 +02:00
LICENSE.txt Update copyright statements to 2020 2020-01-01 11:16:22 +01:00
logo.png Optimize images losslessly using oxipng -o6 --strip all --zopfli 2018-06-28 19:17:41 +02:00
logo.svg Use new Godot icon consistently everywhere 2017-05-17 19:53:59 +02:00
LOGO_LICENSE.md Improve documentation of thirdparty code snippets 2017-05-07 11:42:37 +02:00
methods.py Add custom_modules build option to compile external user modules 2020-05-25 15:33:32 +03:00
platform_methods.py SCons: Format buildsystem files with psf/black 2020-03-30 09:05:53 +02:00
README.md Add TODOs Badge to README 2020-03-25 19:53:51 -04:00
SConstruct Add custom_modules build option to compile external user modules 2020-05-25 15:33:32 +03:00
version.py Bump version to 4.0-dev 2020-01-29 13:37:17 +01:00

Godot Engine logo

Godot Engine

Homepage: https://godotengine.org

2D and 3D cross-platform game engine

Godot Engine is a feature-packed, cross-platform game engine to create 2D and 3D games from a unified interface. It provides a comprehensive set of common tools, so that users can focus on making games without having to reinvent the wheel. Games can be exported in one click to a number of platforms, including the major desktop platforms (Linux, Mac OSX, Windows) as well as mobile (Android, iOS) and web-based (HTML5) platforms.

Free, open source and community-driven

Godot is completely free and open source under the very permissive MIT license. No strings attached, no royalties, nothing. The users' games are theirs, down to the last line of engine code. Godot's development is fully independent and community-driven, empowering users to help shape their engine to match their expectations. It is supported by the Software Freedom Conservancy not-for-profit.

Before being open sourced in February 2014, Godot had been developed by Juan Linietsky and Ariel Manzur (both still maintaining the project) for several years as an in-house engine, used to publish several work-for-hire titles.

Screenshot of a 3D scene in Godot Engine

Getting the engine

Binary downloads

Official binaries for the Godot editor and the export templates can be found on the homepage.

Compiling from source

See the official docs for compilation instructions for every supported platform.

Community and contributing

Godot is not only an engine but an ever-growing community of users and engine developers. The main community channels are listed on the homepage.

To get in touch with the developers, the best way is to join the #godotengine IRC channel on Freenode.

To get started contributing to the project, see the contributing guide.

Documentation and demos

The official documentation is hosted on ReadTheDocs. It is maintained by the Godot community in its own GitHub repository.

The class reference is also accessible from within the engine.

The official demos are maintained in their own GitHub repository as well.

There are also a number of other learning resources provided by the community, such as text and video tutorials, demos, etc. Consult the community channels for more info.

Travis Build Status AppVeyor Build Status Code Triagers Badge Translate on Weblate Total alerts on LGTM TODOs