project_organization.rst 1.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  1. .. _doc_project_organization:
  2. Project organization
  3. ====================
  4. Introduction
  5. ------------
  6. This tutorial is aimed to propose a simple workflow on how to organize
  7. projects. Since Godot allows the programmer to use the file-system as he
  8. or she pleases, figuring out a way to organize the projects when
  9. starting to use the engine can be a little challenging. Because of this,
  10. a simple workflow will be described, which can be used or not, but
  11. should work as a starting point.
  12. Additionally, using version control can be challenging so this
  13. proposition will include that too.
  14. Organization
  15. ------------
  16. Godot is scene based in nature, and uses the filesystem as-is,
  17. without metadata or an asset database.
  18. Unlike other engines, a lot of resource are contained within the scene
  19. itself, so the amount of files in the filesystem is considerably lower.
  20. Considering that, the most common approach is to group assets close to scenes as,
  21. when a project grows, it makes it more maintainable.
  22. As example, base sprite images, 3D model scenes or meshes, materials, etc.
  23. can usually be organized in a place, while a separate folder is used
  24. to store built levels that use them.
  25. ::
  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 version previous to 3.0 did the import process from files outside
  39. the project. While this can be useful in very large projects, it
  40. resulted in an organization hazzle for most developers.
  41. Because of this, assets are now imported from within the project
  42. folder transparently.