godottest/godot/addons/maaacks_game_template/docs/NewProject.md

New Projects

These instructions assume starting with the entire contents of the project folder. This will be the case when cloning the repo, or starting from the template version in the Godot Asset Library accessible from the Project Manager window.

1. Finish setup.

   1. Delete duplicate example files.

      1. Go to Project > Tools > Run Maaack's Game Template Setup....
      2. In the Setup Wizard window next to "Delete Example Files", click Run.
      3. In the next window, select Yes to continue with removing the example files.

   2. Update autoload file paths.

      1. Go to Project > Tools > Run Maaack's Game Template Setup....
      2. In the Setup Wizard window next to "Update Autoload Paths", click Run.

   3. Set a default theme.

      1. Go to Project > Tools > Run Maaack's Game Template Setup....
      2. In the Setup Wizard window next to "Set the Default Theme", click Run.
      3. In the next window, select the desired theme from the preview and select Yes to set it as the project's default theme.

2. Update the project’s name.

   1. Go to Project > Project Settings… > General > Application > Config.
   2. Update Name to "Game Name".
   3. Close the window.
   4. Open main_menu_with_animations.tscn.
   5. Select the TitleLabel node.
   6. The Text should match the project's name.
      1. If Text is customized, set Auto Update to false.
   7. Select the SubtitleLabelNode node and customize the Text as desired.
   8. Save the scene.

3. Add background music and sound effects to the UI.

   1. Verify the Music and SFX audio busses.

      1. Open the Audio bus editor.
      2. Confirm that Music and SFX audio busses are available.
      3. If the audio bus doesn't exist, add it and save the project.

   2. Add background music to the Main Menu.

      1. Import the music asset into the project.
      2. Open main_menu_with_animations.tscn.
      3. Select the BackgroundMusicPlayer node.
      4. Assign the music asset to the stream property.
      5. Make sure that the bus property is set to Music.
      6. Save the scene.
      7. Optionally, repeat steps 3-5 for background music nodes in:
         1. opening_with_logo.tscn
         2. game_ui.tscn
         3. end_credits.tscn

   3. Add sound effects to UI elements.

      1. By scene.

         1. Open main_menu_with_animations.tscn and pause_menu.tscn.
         2. Select the UISoundController node.
         3. Add audio streams to the various UI node events.
         4. Save the scenes.

      2. Project-wide.

         1. Open project_ui_sound_controller.tscn.
         2. Select the UISoundController node.
         3. Add audio streams to the various UI node events.
         4. Save the scene.

4. Add readable names for input actions to the controls menu.

   1. Open input_options_menu.tscn.
   2. In the scene tree, select the Controls node.
   3. In the node inspector, select the desired input remapping mode (defaults to List).
   4. In the scene tree, select InputActionsList or InputActionsTree, depending on the choice of input remapping. The other node should be hidden.
   5. In the node inspector, update the Input Action Names and corresponding Readable Action Names to show user-friendly names for the project's input actions.
   6. Save the scene.

5. Add / remove configurable settings to / from menus.

   1. Open mini_options_menu.tscn or [audio|visual|input|game]_options_menu.tscn scenes to edit their options.
   2. If an option is not desired, it can always be hidden, or removed entirely (sometimes with some additional work).
   3. If a new option is desired, refer to Adding Custom Options.

6. Update the game credits / attribution.

   1. Update the example ATTRIBUTION.md with the project's credits.
   2. Open scrollable_credits.tscn and scrolling_credits.tscn.
   3. Check the CreditsLabel has updated with the text.
   4. Optionally, change settings or disable Auto Update.
   5. Save both scenes (even they show no changes).

7. Keep, update, or remove res://LICENSE.txt.

8. Optionally, if using Git for version control, update .gitignore to include addons/.

9. Continue with:

   1. Setting up the Main Menu.
   2. Setting up a Game Scene.
   3. Loading scenes asynchronously.
   4. Adding icons to the Input Options.
   5. Adding Custom Options.
   6. Utilizing Game Saving.