Reorganize project folder and naming convention

[afonsolage]

Actual state

Currently the project has the following folder structure:

• blender - contains all blender related files
  • models
• docker - contains all docker-compose files and pgdata persistent data
• gimp - contains all gimp project files
• logs
• mariadb - contains docker-compose for mariadb, unused anymore
• notes - personal notes
• shared - common files that can be used by client and server projects
  • resources - everything that isn't a script
  • scripts - script files
• skyon_client - godot project of client
  • assets - assets files, like fonts, images and etc
  • import - models imported from blender
  • resources - generated resources, like materials, items resource and so on
  • scenes - holds all and only scenes related files
  • scripts - holds all and only scripts related files
• skyon_server - godot project of server
  • resources - generated resources, like materials, items resource and so on
  • scenes - holds all and only scenes related files
  • scripts - holds all and only scripts related files
• sql_scripts - sql scripts which were used to modify the DB
• start.sh - utility script to init godot projects with custom settings
• stop.sh - utility script to stop godot
• test - legacy test folder not used anymore
• tools - script tools used to ease the development process

Scripts and scenes folders are more complex, so here they are in more detail:

client

On client-side, scenes have visual and only information that client actually needs to have.

• scenes
  • btree - Contains behavior tree scenes to be reused. Not used on client, can be removed
  • characters - Contains character related scenes, like main player or other players
  • components - Components scenes that can be reused. They should be more specialized as possible to ease the reuse
  • misc - Scenes that aren't that important so doesn't fit on existing categories and doesn't deserve their own
  • mobs - NPCs characters in general, like monsters, resources and such
  • systems - Scenes that contains systems, which are behavior and data only scenes, they have no visuals
  • tools - Utility tools to ease the development process, like the item manager tool, which create item resources
  • ui - GUI related scenes, like Windows and HUD interfaces
• scripts
  • components - Data-only objects used by systems. Components can only have functions to modify it's own data
  • nodes - Scripts that attached to a existing scene node (or will be attached at runtime) to customize their behavior
  • shared - Scripts shared between server and client. Usually have only logic data and functions
  • singletons - Singleton script objects. Should be kept as fewer as possible
  • systems - Scripts system, which are behavior and data only objects, they have no visuals

server

On server-side, there is no visual, but have collision, volume and other data used to compute behavior

• scenes
  • btree - Contains behavior tree scenes to be reused.
  • characters - Contains character related scenes, like main player or other players
  • components - Components scenes that can be reused. They should be more specialized as possible to ease the reuse
  • debug - Debug only scenes, used to ease the development process
  • mobs - NPCs characters in general, like monsters, resources and such
  • tools - Utility tools to ease the development process, like the item manager tool, which create item resources

• scripts

  • components - Data-only objects used by systems. Components can only have functions to modify it's own data
  • nodes - Scripts that attached to a existing scene node (or will be attached at runtime) to customize their behavior
  • shared - Scripts shared between server and client. Usually have only logic data and functions
  • singletons - Singleton script objects. Should be kept as fewer as possible
  • systems - Scripts system, which are behavior and data only objects, they have no visuals

  What is working good

• shared folder, since saves a lot of time by reusing logic between client and server
• systems folder, because keep all systems in a single place helps to understand what is happening
• singletons folder, for the same behavior as before

What isn't working good

• The root folder is a mess, should be organized to have fewer root folders as possible
• Personal files, like logs and notes, are places inside the project folder, they should be removed
• Persistent database files, like pgdata, because this will cause conflict when developing with multi-devs
• resources and assets is confusing, since resource is an asset
• import and assets for the same reason as above
• scenes and scripts separation isn't quite good. it's a common pattern on Godot (and even Unity) but when project grows, this becomes too complex
• scenes and nodes for the same behavior as before
• components the idea is fine, but maybe organize components by the systems which are using them?

Proposed state

Selling points

• Reduced number of root folders
• Merged resources and import folders inside assets folder
• No more scenes and scripts separation, they live together now
• Components lives under system specific folders

Questions to be solved

• Systems folder should have a nodes folder?
• Should we have a commons folder to hold scripts or nodes which doesn't belong to any system?

Final overview

• infra - Contains all infrastructure related files and folders
  • docker - Docker compose containers scripts
  • db - Docker compose scripts for db container
  • sql_scripts - SQL Scripts used by the project
  • backup - Contains a full backup which enables a fresh use of the game
  • updates - Scripts which updates the database to latest version
• assets - Projects and assets which are used to create final assets for the game
  • gimp - Gimp only files
  • blender - Blender only files
• shared - Common files that can be used by client and server projects
  • scripts - Scripts shared between server and client. Usually have only logic data and functions
• client
  • assets - assets files, like fonts, images and etc
  • fonts - self-explanatory
  • icons - self-explanatory
  • models - Contains models files imported for external tools, like Blender
  • resources - Assets that contains data related to some game behavior
  • textures - Texture files assets
  • singletons - Singleton script objects. Should be kept as fewer as possible
  • systems - Grouped behaviors and data of the game, which are independent it selves
  • [Some System] - This folder should exists for every existing system
    • components - Components used by this system
    • nodes? - Nodes used or managed (added and removed) by this system
  • commons? - Common nodes or scripts used by many systems
  • tools - Utility tools to ease the development process, like the item manager tool, which create item resources
• server
  • resources - Assets that contains data related to some game behavior
  • singletons - Singleton script objects. Should be kept as fewer as possible
  • systems - Grouped behaviors and data of the game, which are independent it selves
  • [Some System] - This folder should exists for every existing system
    • components - Components used by this system
    • nodes? - Nodes used or managed (added and removed) by this system
  • commons? - Common nodes or scripts used by many systems
• tools - Helper scripts and tools