File System Structure

This page is created to give a general overview of the game file structure that can be found in the device folger.

To start with these are folders that you should be most aware of:

Main.scn

This is the only scene not inside any folder and the frame for some base functionalities of the game. Some adjustments can be made here, but as it is set up once, it will likely not be touched too much in further development. This scene controls some general things like:

• General transitions between the scenes
  • Changes of windowsize would need to be adjusted here as well
  • Changes of general transition possible
• Global background music scene
  • The scene leads to a global scene where you can change the music.
  • Note: For the global loop to work, we need an .ogg file.
• Global dialog control
  • Note: This is not where you change the dialogue or the apperance of it.

Globals

The globals folder contains mainly scripts that can used universally for similar nodes in similar scenes. There are also scenes that are implemented to be valid for the entire game play.

Most of the times you won't actively look for the files in the globals folder, but see them already integrated in / connected to scenes, like in the main.scn.

Scenes

This is probably the folder where we will edit the most, because it contains the scenes that will be different rooms in our case.

Each room gets its own subfolder that contains:

• sprites
  • all designs needed in the specific scene will go in this folder
• sounds
  • sounds that are specific to the scene
• scene files
  • one main scene for a room
  • multiple scenes that are placed into the main scene of the room where each scene is an item
• esc files
  • for each scene there should be an esc file with the same name that will control the actions happening when interacting with a scene object

Translations

This is where we will control the actual dialogues and manage translations. This happens outside of Godot.

The files that will need to be updated and filled with our text / translations are the general.csv and strings_final.csv

Note: How we will deal with this exactly and most efficiently is still open for discussion. Apparently there is a way to update the csv with entries as you configure the esc files. This needs to be further looked into yet.

UI

The UI folder contains all the scenes and its associated scripts that control the User Interface, including:

• Start scene (Choose language | Start game)
  • main-menu
• Look and function of Inventory for all scenes
  • inventory
• Loook and function of Control Buttons for all scenes
  • verb-menu and action-menu
• Position of Inventory and Control Buttons in scenes
  • hud
• Fonts
• PopUp when clicking x button of the window (Do you want to quit?)
  • confirm_popup
• Credits
  • credits
• Box where text appears inside
  • dialog_default
• Box for dialog with options
  • dd_default