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 ++++++++++++++++++++----------- blog/dst/rss.xml | 37 +++++++++++++++++++++------------ blog/dst/sitemap.xml | 20 +++++++++--------- blog/src/.files | 2 +- blog/src/g/godot_project_structure.md | 27 ++++++++++++++---------- 5 files changed, 74 insertions(+), 47 deletions(-) (limited to 'blog') 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.

    @@ -212,7 +223,7 @@

    By David Luévano

    Created: Sun, May 22, 2022 @ 01:16 UTC

    -

    Modified: Sun, May 22, 2022 @ 01:23 UTC

    +

    Modified: Tue, May 24, 2022 @ 04:35 UTC

    Tags: english, gamedev, short

    diff --git a/blog/dst/rss.xml b/blog/dst/rss.xml index d815b06..e97bc22 100644 --- a/blog/dst/rss.xml +++ b/blog/dst/rss.xml @@ -13,8 +13,8 @@ Copyright 2021 David Luévano Alvarado david@luevano.xyz (David Luévano Alvarado) david@luevano.xyz (David Luévano Alvarado) - Sun, 22 May 2022 01:23:08 GMT - Sun, 22 May 2022 01:23:08 GMT + Tue, 24 May 2022 04:35:41 GMT + Tue, 24 May 2022 04:35:41 GMT pyssg v0.7.2 https://validator.w3.org/feed/docs/rss2.html 30 @@ -32,8 +32,8 @@ Gamedev Short Details on the project structure I'm using for Godot, based on preference and some research I did. - 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:

    • /models/town/house/
      • house.dae
        • @@ -61,33 +61,32 @@
    -

    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:

    • /.git
      • -
    • /assets (raw assets/editable assets for their respective software, could also be the whole imported assets from some packs, where you can just select few of them to actually use)
      • +
    • /assets (raw assets/editable assets/asset packs)
    • /releases (executables ready to publish)
    • /src (the actual godot project)
      • .godot/
      • actors/ (or entities)
        • player/
            -
          • assets/
          • sprites/
            • +
          • player.x
          • …
        • enemy/ (this could be a dir with subdirectories for each type of enemy for example…)
            -
          • assets/
          • sprites/
            • +
          • enemy.x
          • …
          • -
        • actor.gd
          • +
        • actor.x
        • …
      • levels/ (or scenes)
        • common/
            -
          • assets/
          • sprites/
          • …
          @@ -104,7 +103,7 @@
        • …
        • -
      • Game.tscn (I consider the “game” itself a level/scene, so I’m including it here)
        • +
      • Game.tscn (I’m considering the “Game” as a level/scene)
      • game.gd
      • @@ -133,16 +132,28 @@
    • …
    +
  • 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.

    ]]>     Will start blogging about gamedev diff --git a/blog/dst/sitemap.xml b/blog/dst/sitemap.xml index 4ca84e6..4220240 100644 --- a/blog/dst/sitemap.xml +++ b/blog/dst/sitemap.xml @@ -4,7 +4,7 @@ xsi:schemaLocation="http://www.sitemaps.org/schemas/sitemap/0.9 http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd"> https://blog.luevano.xyz/g/godot_project_structure.html - 2022-05-22 + 2022-05-24 weekly 1.0 @@ -107,55 +107,55 @@ https://blog.luevano.xyz/tag/@english.html - 2022-05-22 + 2022-05-24 daily 0.5 https://blog.luevano.xyz/tag/@gamedev.html - 2022-05-22 + 2022-05-24 daily 0.5 https://blog.luevano.xyz/tag/@rant.html - 2022-05-22 + 2022-05-24 daily 0.5 https://blog.luevano.xyz/tag/@server.html - 2022-05-22 + 2022-05-24 daily 0.5 https://blog.luevano.xyz/tag/@short.html - 2022-05-22 + 2022-05-24 daily 0.5 https://blog.luevano.xyz/tag/@spanish.html - 2022-05-22 + 2022-05-24 daily 0.5 https://blog.luevano.xyz/tag/@tools.html - 2022-05-22 + 2022-05-24 daily 0.5 https://blog.luevano.xyz/tag/@tutorial.html - 2022-05-22 + 2022-05-24 daily 0.5 https://blog.luevano.xyz/tag/@update.html - 2022-05-22 + 2022-05-24 daily 0.5 diff --git a/blog/src/.files b/blog/src/.files index 1542439..29cdca1 100644 --- a/blog/src/.files +++ b/blog/src/.files @@ -14,4 +14,4 @@ a/volviendo_a_usar_la_pagina.md 1651116062.9191298 1651116501.5491333 0f36388a5a a/devs_android_me_trozaron.md 1652608264.4901433 1652609027.0201497 41c897ac0c6e0bd66f67ddc8286f4413 rant,spanish,update a/password_manager_authenticator_setup.md 1652654434.4686146 1653179084.149559 ccd90b7bb896f09438696bb793eb6138 english,short,tools g/starting_gamedev_blogging.md 1652764794.9016073 1653179221.26956 2d6665cebea06ff376dbde9643a893c4 english,gamedev,short,update -g/godot_project_structure.md 1653182170.4395845 1653182586.3895879 791ab9c902aa15d66218e1e6e6191491 english,gamedev,short +g/godot_project_structure.md 1653182170.4395845 1653366918.4756405 a7b153df43631f17864cd8ab67aca60f english,gamedev,short diff --git a/blog/src/g/godot_project_structure.md b/blog/src/g/godot_project_structure.md index f69a74d..3f013cc 100644 --- a/blog/src/g/godot_project_structure.md +++ b/blog/src/g/godot_project_structure.md @@ -6,9 +6,9 @@ tags: gamedev short english -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. +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](https://docs.godotengine.org/en/stable/tutorials/best_practices/project_organization.html); 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: +The first place to look for is, of course, the official *Godot* documentation on [Project organization](https://docs.godotengine.org/en/stable/tutorials/best_practices/project_organization.html); 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: - /models/town/house/ - house.dae @@ -28,27 +28,26 @@ Where I would prefer to have more modularity, for example: - house.y - house.z -It might look like it's more work, but I prefer it like this. I wish [this site ](https://www.braindead.bzh/entry/creating-a-game-with-godot-engine-ep-2-project-organization) 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](https://www.reddit.com/r/godot/comments/7786ee/comment/dojuzuf/?utm_source=share&utm_medium=web2x&context=3) 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](https://www.braindead.bzh/entry/creating-a-game-with-godot-engine-ep-2-project-organization) 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](https://www.reddit.com/r/godot/comments/7786ee/comment/dojuzuf/?utm_source=share&utm_medium=web2x&context=3) 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: - /.git -- /assets (raw assets/editable assets for their respective software, could also be the whole imported assets from some packs, where you can just select few of them to actually use) +- /assets (raw assets/editable assets/asset packs) - /releases (executables ready to publish) - /src (the actual godot project) - .godot/ - actors/ (or entities) - player/ - - assets/ - sprites/ + - player.x - ... - enemy/ (this could be a dir with subdirectories for each type of enemy for example...) - - assets/ - sprites/ + - enemy.x - ... - - actor.gd + - actor.x - ... - levels/ (or scenes) - common/ - - assets/ - sprites/ - ... - main/ @@ -57,7 +56,7 @@ It might look like it's more work, but I prefer it like this. I wish [this site - ... - dugeon/ - ... - - Game.tscn (I consider the "game" itself a level/scene, so I'm including it here) + - Game.tscn (I'm considering the "Game" as a level/scene) - game.gd - objects/ - box/ @@ -72,11 +71,17 @@ It might look like it's more work, but I prefer it like this. I wish [this site - menus/ - ... - ... + - 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 - ... - \ -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. \ No newline at end of file +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. \ No newline at end of file -- cgit v1.2.3-54-g00ecf