Refactor the project tree

[akien-mga]

@bojidar-bg already started this in https://github.com/KOBUGE-Games/jetpaca/tree/refactor-move, so opening this issue so that he can explain what he's up to :p

[bojidar-bg]

Well, the current plan is to divide everything in nice small (5-6 files) folders. Once this is done, we might move some of the art as well, but I'm not sure if this is a very good idea. Also, we might have to move some things (like interaction/fountain) to other folders, as needed.

[akien-mga]

Sounds good to me. I'm not too fond of folders with only one or two files like enemies/elevator right now, but it's not a big deal. We should try as much as possible to find a more or less definitive layout now, since each git mv makes the git history super hard to read :)

[bojidar-bg]

Ok, refactor-move was merged, it is time to think what else should be moved :smile:

Current project structure (with notes)

Assets

• art - All assets, here be dragons (and other nasty creatures probably).
• sound - Various SFX.
• music - All background musics, plus (please move!) the sound for the checkpoint.

In-game objects

• characters - All NPCs, currently only the wise_alpaca is here.
• enemies - Everything that hurts the player, or is related to hurting goes here.
• interaction - Everything that interacts with each other, like locks + keys, buttons + elevators, etc. Also all pickups go here (Maybe we should move them somewhere else? @akien-mga ).
• player - The player scene itself, as well as some previous iterations that should be deleted.
• props - Everything that just sits around the stages, waiting to be either broken or pushed away.

Stages

• stages - All levels, as well as the level-listing file.
• tilesets - various tilesets used throughout the stages.

User interface

• hud - The in-game GUI.
• menu - The first screen, as well as the stage selection menu.

Misc.

• shared - All global scripts and autoloads.
• engine.cfg

[akien-mga]

A question about the art/ folder, as I've played around with it a bit while creating https://github.com/KOBUGE-Games/jetpaca-assets-art:

Should we keep everything in art/, or move the assets to the folder of their corresponding scenes/scripts? And if we keep everything in art/, should we try to replicate a structure similar to the source repo and/or the current scenes file organisation?

[bojidar-bg]

Well, I have no definite decision on that one, there are problems in both cases:

• If we decide to move it to various scene and script folders, then artists won't feel as comfortable as otherwise. Also, it would clutter some directories, like the player and enemies directories
• If we don't, then the whole scene separation idea plummets to the ground...

So while I lean a bit in favour of the first, I'm not really sure if it would organise things at all.