From 9ed5d09180b6c975d60828265a2cd1eee9ac1ab4 Mon Sep 17 00:00:00 2001 From: David Luevano Alvarado Date: Mon, 23 May 2022 22:38:49 -0600 Subject: edit godot project structure entry --- blog/dst/g/godot_project_structure.html | 35 ++++++++++++++++++++++----------- 1 file changed, 23 insertions(+), 12 deletions(-) (limited to 'blog/dst/g') diff --git a/blog/dst/g/godot_project_structure.html b/blog/dst/g/godot_project_structure.html index 7e3f0b5..5e6f93f 100644 --- a/blog/dst/g/godot_project_structure.html +++ b/blog/dst/g/godot_project_structure.html @@ -78,8 +78,8 @@

General Godot project structure

-

One of my first issues when starting a project is how to structure everything. So I had to spend some time researching best practices and go with what I like the most.

-

The first place to look for is of course the official Godot documentation on Project organization; along with project structure discussion, also comes with best practices for code style and what-not. I don’t like this project/directory structure that much, just because it tells you to bundle everything under the same directory but it’s a really good starting point, for example it tells you to use:

+

One of my first issues when starting a project is how to structure everything. So I had to spend some time researching best practices and go with what I like the most and after trying some of them I wanted to write down somewhere what I’m sticking with.

+

The first place to look for is, of course, the official Godot documentation on Project organization; along with project structure discussion, also comes with best practices for code style and what-not. I don’t like this project/directory structure that much, just because it tells you to bundle everything under the same directory but it’s a really good starting point, for example it tells you to use:

-

It might look like it’s more work, but I prefer it like this. I wish this site was still available, as I got most of my ideas from there, but apparently the owner is not maintaining his site anymore; but there is this excelent comment on reddit which shows a project/sirectory structure more in line with what I’m currently using (and similr to the site that is down that I liked that much). I just do somethings a bit different, and end up with:

+

It might look like it’s more work, but I prefer it like this. I wish this site was still available, as I got most of my ideas from there and was a pretty good resource, but apparently the owner is not maintaining his site anymore; but there is this excelent comment on reddit which shows a project/directory structure more in line with what I’m currently using (and similr to the site that is down that I liked). I ended up with:

+
  • sfx/
      +
    • +
    +
  • +
  • vfx/
      +
    • +
    +
  • +
  • etc/
      +
    • +
    +
  • Main.tscn (the entry point of the game)
  • main.gd
  • -
  • icon.png
  • +
  • icon.png (could also be on a separate “icons” directory)
  • project.godot
  • \<any other repository related files>
  • -

    And so on, I hope the idea is clear. Basically you need to abstract some entity/object that you’re going to use into its more basic form and use subdirectories for each level of abstraction (a player is an actor and thus we use actor/player; a box is part of the world, and is a level so we can use levels/common/decor/box or something like that). Once you have the most basic abstraction done, anything that belongs to that abstraction will have all of its assets/sounds/shaders/etc in it’s directory.

    +

    And so on, I hope the idea is clear. I’ll probably change my mind on the long run, but for now this has been working fine.