project_organization.rst 1.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  1. .. _doc_project_organization:
  2. Project organization
  3. ====================
  4. Introduction
  5. ------------
  6. Since Godot has no restrictions on project structure or filesystem usage,
  7. organizing files when learning the engine can seem challenging. This
  8. tutorial suggests a workflow which should be a good starting point.
  9. We will also cover using version control with Godot.
  10. Organization
  11. ------------
  12. Godot is scene-based in nature, and uses the filesystem as-is,
  13. without metadata or an asset database.
  14. Unlike other engines, many resources are contained within the scene
  15. itself, so the amount of files in the filesystem is considerably lower.
  16. Considering that, the most common approach is to group assets as close
  17. to scenes as possible; when a project grows, it makes it more
  18. maintainable.
  19. As an example, one can usually place into a single folder their basic assets,
  20. such as sprite images, 3D model meshes, materials, and music, etc.
  21. They can then use a separate folder to store built levels that use them.
  22. ::
  23. /project.godot
  24. /docs/.gdignore
  25. /docs/learning.html
  26. /models/town/house/house.dae
  27. /models/town/house/window.png
  28. /models/town/house/door.png
  29. /characters/player/cubio.dae
  30. /characters/player/cubio.png
  31. /characters/enemies/goblin/goblin.dae
  32. /characters/enemies/goblin/goblin.png
  33. /characters/npcs/suzanne/suzanne.dae
  34. /characters/npcs/suzanne/suzanne.png
  35. /levels/riverdale/riverdale.scn
  36. Importing
  37. ---------
  38. Godot versions prior to 3.0 did the import process from files outside
  39. the project. While this can be useful in large projects, it
  40. resulted in an organization hassle for most developers.
  41. Because of this, assets are now transparently imported from within the project
  42. folder.
  43. If a folder shouldn't be imported into Godot, an exception can be made with a
  44. .gdignore file.