index.rst 2.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
  1. :allow_comments: False
  2. .. _doc_compiling_index:
  3. Building from source
  4. ====================
  5. .. highlight:: shell
  6. Godot prides itself on being very easy to build, by C++ project standards.
  7. :ref:`Godot uses the SCons build system <doc_faq_why_scons>`, and after the initial
  8. setup compiling the engine for your current platform should be as easy as running:
  9. ::
  10. scons
  11. But you will probably need to use at least some of the available options to configure
  12. the build to match your specific needs, be it a custom engine fork, a lightweight build
  13. stripped of extra modules, or an executable targeting engine development.
  14. The articles below should help you navigate configuration options available, as well as
  15. prerequisites required to compile Godot exactly the way you need.
  16. .. rubric:: Basics of building Godot
  17. :heading-level: 2
  18. Let's start with basics, and learn how to get Godot's source code, and then which options
  19. to use to compile it regardless of your target platform.
  20. .. toctree::
  21. :maxdepth: 1
  22. :name: toc-devel-compiling
  23. getting_source
  24. introduction_to_the_buildsystem
  25. .. rubric:: Building for target platforms
  26. :heading-level: 2
  27. Below you can find instructions for compiling the engine for your specific target platform.
  28. Note that Godot supports cross-compilation, which means you can compile it for a target platform
  29. that doesn't match your current platform (say, target Linux while being on Windows). The guides
  30. will try their best to cover all possible situations.
  31. .. toctree::
  32. :maxdepth: 1
  33. :name: toc-devel-compiling-platforms
  34. compiling_for_windows
  35. compiling_for_linuxbsd
  36. compiling_for_macos
  37. compiling_for_android
  38. compiling_for_ios
  39. cross-compiling_for_ios_on_linux
  40. compiling_for_web
  41. .. rubric:: Other compilation targets and options
  42. :heading-level: 2
  43. Some additional universal compilation options require further setup. Namely, while Godot
  44. does have C#/.NET support as a part of its main codebase, it does not get compiled by
  45. default to reduce the executable size for users who don't need C# for their projects.
  46. Articles below explain how to configure the buildsystem for cases like this, and also
  47. cover some optimization techniques.
  48. .. toctree::
  49. :maxdepth: 1
  50. :name: toc-devel-compiling-options
  51. compiling_with_dotnet
  52. compiling_with_script_encryption_key
  53. optimizing_for_size