index.rst 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172
  1. :allow_comments: False
  2. .. _doc_c_sharp:
  3. C#/.NET
  4. =======
  5. C# is a high-level programming language developed by Microsoft. Godot supports
  6. C# as an option for a scripting language, alongside Godot's own
  7. :ref:`GDScript <doc_gdscript>`.
  8. The standard Godot executable does not contain C# support out of the box. Instead,
  9. to enable C# support for your project you need to `download a .NET version <https://godotengine.org/download/>`_
  10. of the editor from the Godot website.
  11. .. toctree::
  12. :maxdepth: 1
  13. :name: toc-learn-scripting-C#
  14. c_sharp_basics
  15. c_sharp_features
  16. c_sharp_style_guide
  17. diagnostics/index
  18. Godot API for C#
  19. ----------------
  20. As a general purpose game engine Godot offers some high-level features as a part
  21. of its API. Articles below explain how these features integrate into C# and how
  22. C# API may be different from GDScript.
  23. .. toctree::
  24. :maxdepth: 1
  25. :name: toc-learn-scripting-C#-differences
  26. c_sharp_differences
  27. c_sharp_collections
  28. c_sharp_variant
  29. c_sharp_signals
  30. c_sharp_exports
  31. c_sharp_global_classes
  32. .. _doc_c_sharp_platforms:
  33. C# platform support
  34. -------------------
  35. .. seealso::
  36. See :ref:`doc_system_requirements` for hardware and software version
  37. requirements for the Godot engine.
  38. .. note::
  39. Since C# projects use the .NET runtime, also check the system requirements
  40. for the version of .NET that you'll be using.
  41. See `supported OS <https://github.com/dotnet/core/tree/main/release-notes#supported-os>`_.
  42. Since Godot 4.2, projects written in C# support all desktop platforms (Windows, Linux,
  43. and macOS), as well as Android and iOS.
  44. Android support is currently experimental.
  45. iOS support is currently experimental and has a few limitations.
  46. - The official export templates for the iOS simulator only supports the ``x64`` architecture.
  47. - Exporting to iOS can only be done from a MacOS device.
  48. Currently, projects written in C# cannot be exported to the web platform. To use C#
  49. on that platform, consider Godot 3 instead.