Home Explore Help
Sign In
godotengine
/
godot-docs
mirror of https://github.com/godotengine/godot-docs
Watch 1
Star 1
Fork 0
Files
Branch: 3.0
Branches Tags
godot-docs
/
getting_started
/
workflow
/
project_setup
/
project_organization.rst

project_organization.rst 1.9 KB
Permalink 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 is aimed to propose a simple workflow on how to organize
    10. 

  10. projects. Since Godot allows the programmer to use the file-system as
    11. 

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

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

  13. a simple workflow will be described, which can be used or not, but
    14. 

  14. should work as a starting point.
    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, a lot of resource 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 close to scenes as,
    29. 

  29. when a project grows, it makes it more maintainable.
    30. 

  30. 

  31. As example, base sprite images, 3D model scenes or meshes, materials, etc.
    32. 

  32. can usually be organized in a place, while a separate folder is used
    33. 

  33. to store built levels that use them.
    34. 

  34. 

  35. ::
    36. 

  36. 

  37.     /project.godot
    38. 

  38.     /docs/.gdignore
    39. 

  39.     /docs/learning.html
    40. 

  40.     /models/town/house/house.dae
    41. 

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

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

  43.     /characters/player/cubio.dae
    44. 

  44.     /characters/player/cubio.png
    45. 

  45.     /characters/enemies/goblin/goblin.dae
    46. 

  46.     /characters/enemies/goblin/goblin.png
    47. 

  47.     /characters/npcs/suzanne/suzanne.dae
    48. 

  48.     /characters/npcs/suzanne/suzanne.png
    49. 

  49.     /levels/riverdale/riverdale.scn
    50. 

  50. 

  51. Importing
    52. 

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

  53. 

  54. Godot version previous to 3.0 did the import process from files outside
    55. 

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

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

  57. 

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

  59. folder transparently.
    60. 

  60. 

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

  62. .gdignore file.
    63. 

  63.