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: a9ccac82ea
Branches Tags
godot-docs
/
getting_started
/
workflow
/
project_setup
/
project_organization.rst

project_organization.rst 2.0 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263 
  1. .. _doc_project_organization:
    2. 

  2. 

  3. Project organization
    4. 

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

  5. 

  6. Introduction
    7. 

  7. ------------
    8. 

  8. 

  9. This tutorial aims to propose a simple workflow on how to organize
    10. 

  10. projects. Since Godot allows the programmer to use the filesystem as
    11. 

  11. they please, figuring out a way to organize projects when starting
    12. 

  12. to use the engine can be a little challenging. Because of this, the
    13. 

  13. tutorial describes a simple workflow, which should work as a starting
    14. 

  14. point, regardless of whether it is used.
    15. 

  15. 

  16. Additionally, using version control can be challenging, so this
    17. 

  17. proposition will include that too.
    18. 

  18. 

  19. Organization
    20. 

  20. ------------
    21. 

  21. 

  22. Godot is scene-based in nature, and uses the filesystem as-is,
    23. 

  23. without metadata or an asset database.
    24. 

  24. 

  25. Unlike other engines, many resources are contained within the scene
    26. 

  26. itself, so the amount of files in the filesystem is considerably lower.
    27. 

  27. 

  28. Considering that, the most common approach is to group assets as close
    29. 

  29. to scenes as possible; when a project grows, it makes it more
    30. 

  30. maintainable.
    31. 

  31. 

  32. As an example, one can usually place into a single folder their basic assets,
    33. 

  33. such as sprite images, 3D model meshes, materials, and music, etc.
    34. 

  34. They can then use a separate folder to store built levels that use them.
    35. 

  35. 

  36. ::
    37. 

  37. 

  38.     /project.godot
    39. 

  39.     /docs/.gdignore
    40. 

  40.     /docs/learning.html
    41. 

  41.     /models/town/house/house.dae
    42. 

  42.     /models/town/house/window.png
    43. 

  43.     /models/town/house/door.png
    44. 

  44.     /characters/player/cubio.dae
    45. 

  45.     /characters/player/cubio.png
    46. 

  46.     /characters/enemies/goblin/goblin.dae
    47. 

  47.     /characters/enemies/goblin/goblin.png
    48. 

  48.     /characters/npcs/suzanne/suzanne.dae
    49. 

  49.     /characters/npcs/suzanne/suzanne.png
    50. 

  50.     /levels/riverdale/riverdale.scn
    51. 

  51. 

  52. Importing
    53. 

  53. ---------
    54. 

  54. 

  55. Godot versions prior to 3.0 did the import process from files outside
    56. 

  56. the project. While this can be useful in large projects, it
    57. 

  57. resulted in an organization hassle for most developers.
    58. 

  58. 

  59. Because of this, assets are now transparently imported from within the project
    60. 

  60. folder.
    61. 

  61. 

  62. If a folder shouldn't be imported into Godot, an exception can be made with a
    63. 

  63. .gdignore file.
    64.