version_control_systems.rst 1.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  1. .. _doc_version_control_systems:
  2. Version Control Systems
  3. =======================
  4. Introduction
  5. ------------
  6. Godot aims to be VCS friendly and generate mostly readable and mergeable files.
  7. Godot also supports the use of version control systems in the editor itself.
  8. However, VCS in the editor requires a plugin for the specific VCS you are using.
  9. VCS can be setup or shut down in the editor under **Project > Version Control**.
  10. .. image:: img/version_control_menu.png
  11. Official Git plugin
  12. -------------------
  13. Using Git from inside the editor is supported with an official plugin.
  14. You can find the latest releases
  15. `here <https://github.com/godotengine/godot-git-plugin/releases>`__. Documentation on how to use the Git
  16. plugin can be found
  17. `here <https://github.com/godotengine/godot-git-plugin/wiki>`__.
  18. Files to exclude from VCS
  19. -------------------------
  20. There are some folders Godot creates you should have your VCS ignore:
  21. - ``.import/``: This folder stores all the files it imports automatically based on
  22. your source assets and their import flags.
  23. - ``*.translation``: These files are binary imported translations generated from CSV files.
  24. - ``export_presets.cfg``: This file contains all the export presets for the
  25. project, including sensitive information such as Android keystore credentials.
  26. - ``.mono/``: This folder stores automatically-generated Mono files. It only exists
  27. in projects that use the Mono version of Godot.
  28. Working with Git on Windows
  29. ---------------------------
  30. Most Git for Windows clients are configured with the ``core.autocrlf`` set to ``true``.
  31. This can lead to files unnecessarily being marked as modified by Git due to their line endings being converted automatically.
  32. It is better to set this option as::
  33. git config --global core.autocrlf input