Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: c7a230410f
Branches Tags
godot-docs
/
development
/
compiling
/
compiling_with_mono.rst

compiling_with_mono.rst 3.4 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687 
  1. .. _doc_compiling_with_mono:
    2. 

  2. 

  3. Compiling with Mono
    4. 

  4. ===================
    5. 

  5. 

  6. .. highlight:: shell
    7. 

  7. 

  8. Requirements
    9. 

  9. ------------
    10. 

  10. 

  11. - Mono (the required version is listed here: :ref:`doc_c_sharp`)
    12. 

  12. - MSBuild
    13. 

  13. - pkg-config
    14. 

  14. 

  15. Environment Variables
    16. 

  16. ---------------------
    17. 

  17. 

  18. By default, SCons will try to find Mono in the Windows Registry on Windows or via ``pkg-config`` on other platforms. You can specify a different installation directory by using the following environment variables for the respective ``bits`` option: ``MONO32_PREFIX`` and ``MONO64_PREFIX``.
    19. 

  19. 

  20. The specified directory must contain the subdirectories ``bin``, ``include``, and ``lib``.
    21. 

  21. 

  22. Enable Mono Module
    23. 

  23. --------------------
    24. 

  24. 

  25. By default, the mono module is disabled for builds. To enable it you can pass the option ``module_mono_enabled=yes`` to your SCons command.
    26. 

  26. 

  27. Generate The Glue
    28. 

  28. -------------------
    29. 

  29. 

  30. The glue sources are the wrapper functions that will be called by the managed side. In order to generate them, first, you must build Godot with the options ``tools=yes`` and ``mono_glue=no``:
    31. 

  31. 

  32. ::
    33. 

  33. 

  34.     scons p=<platform> tools=yes module_mono_enabled=yes mono_glue=no
    35. 

  35. 

  36. After the build finishes, you need to run the compiled executable with the parameter ``--generate-mono-glue`` followed by the path to an output directory. This path must be ``modules/mono/glue`` in the Godot directory.
    37. 

  37. 

  38. ::
    39. 

  39. 

  40.     godot --generate-mono-glue modules/mono/glue
    41. 

  41. 

  42. This command will tell Godot to generate the file *modules/mono/glue/mono_glue.gen.cpp*. Once this file is generated, you can build Godot for all the desired targets without the need to repeat this process.
    43. 

  43. 

  44. As always, ``godot`` refers to the compiled Godot binary, so if it isn't in your PATH, you need to give the full path to the executable, e.g. if it is located in the ``bin`` subfolder, it becomes ``bin/godot``.
    45. 

  45. 

  46. Notes
    47. 

  47. ^^^^^
    48. 

  48. -  **Do not** build normal binaries with ``mono_glue=no``. This option disables C# scripting and therefore must only be used for the temporary binary that will be used to generate the glue. Godot should print a message at startup warning you about this.
    49. 

  49. -  The glue sources must be regenerated every time the ClassDB API changes. If there is an API mismatch with the generated glue, Godot will print an error at startup.
    50. 

  50. 

  51. Examples
    52. 

  52. --------
    53. 

  53. 

  54. Example (Windows)
    55. 

  55. ^^^^^^^^^^^^^^^^^
    56. 

  56. ::
    57. 

  57. 

  58.     # Build temporary binary
    59. 

  59.     scons p=windows tools=yes module_mono_enabled=yes mono_glue=no
    60. 

  60.     # Generate glue sources
    61. 

  61.     bin\godot.windows.tools.64.mono --generate-mono-glue modules/mono/glue
    62. 

  62. 

  63.     ### Build binaries normally
    64. 

  64.     # Editor
    65. 

  65.     scons p=windows target=release_debug tools=yes module_mono_enabled=yes
    66. 

  66.     # Export templates
    67. 

  67.     scons p=windows target=debug tools=no module_mono_enabled=yes
    68. 

  68.     scons p=windows target=release tools=no module_mono_enabled=yes
    69. 

  69. 

  70. Example (x11)
    71. 

  71. ^^^^^^^^^^^^^
    72. 

  72. ::
    73. 

  73. 

  74.     # Build temporary binary
    75. 

  75.     scons p=x11 tools=yes module_mono_enabled=yes mono_glue=no
    76. 

  76.     # Generate glue sources
    77. 

  77.     bin/godot.x11.tools.64.mono --generate-mono-glue modules/mono/glue
    78. 

  78. 

  79.     ### Build binaries normally
    80. 

  80.     # Editor
    81. 

  81.     scons p=x11 target=release_debug tools=yes module_mono_enabled=yes
    82. 

  82.     # Export templates
    83. 

  83.     scons p=x11 target=debug tools=no module_mono_enabled=yes
    84. 

  84.     scons p=x11 target=release tools=no module_mono_enabled=yes
    85. 

  85. 

  86. If everything went well, apart from the normal output, SCons should have also built the *GodotSharpTools.dll* assembly and copied it together with the mono runtime shared library to the ``bin`` subdirectory.
    87. 

  87.