imported main menu scene addon
This commit is contained in:
@@ -0,0 +1,68 @@
|
||||
# Basic Setup
|
||||
|
||||
These instructions cover the basics for setting up the template.
|
||||
|
||||
## Setup Wizard
|
||||
|
||||
The _Setup Wizard_ shows the user's progress through the setup process.
|
||||
|
||||
### Open
|
||||
|
||||
Open the _Setup Wizard_ by navigating to `Project > Tools > Run Maaack's Game Template Setup...`.
|
||||
|
||||

|
||||
|
||||
### Check & Complete
|
||||
|
||||
A typical full installation will have the following steps completed:
|
||||
- Using Latest Version
|
||||
- Copy Example Files
|
||||
- Delete Example Files
|
||||
- Update Autoload Paths
|
||||
- Set Main Scene
|
||||
|
||||

|
||||
|
||||
Depending on how the template was installed, or if any issues occurred, some of these may need to be run from the wizard to be completed.
|
||||
|
||||
The remaining steps are optional customizations.
|
||||
|
||||
## Scene Paths
|
||||
|
||||
The flow of scenes in the template is (by default):
|
||||
```
|
||||
Opening -> Main Menu -> Game Scene -> Ending Scene
|
||||
```
|
||||
|
||||
To change the _Main Menu_, _Game Scene_, or _Ending Scene_:
|
||||
|
||||
1. Open `app_config.tscn`.
|
||||
2. Select the `AppConfig` node.
|
||||
3. Update `Main Menu Scene Path` to the desired path (`main_menu_with_animations.tscn` by default).
|
||||
4. Update `Game Scene Path` to the path of the project's game scene (`game_ui.tscn` by default).
|
||||
5. Update the optional `Ending Scene Path` to the desired scene (`end_credits.tscn` by default).
|
||||
6. Save the scene.
|
||||
|
||||
To change the _Opening_:
|
||||
|
||||
1. Navigate to `Project > Project Settings…`
|
||||
2. In the _Project Settings_ window, go to the `General` tab.
|
||||
3. In the settings list, navigate to `Application > Run`.
|
||||
4. Update `Main Scene` to the desired path.
|
||||
|
||||
## Next Steps
|
||||
|
||||
### Recommended
|
||||
1. [Main Menu Setup](/addons/maaacks_game_template/docs/MainMenuSetup.md)
|
||||
2. [Options Menu Setup](/addons/maaacks_game_template/docs/OptionsMenuSetup.md)
|
||||
3. [Game Scene Setup](/addons/maaacks_game_template/docs/GameSceneSetup.md)
|
||||
4. [Updating Credits](/addons/maaacks_game_template/docs/UpdatingCredits.md)
|
||||
5. [Blending Music](/addons/maaacks_game_template/docs/BlendingMusic.md)
|
||||
6. [Adding UI Sound Effects](/addons/maaacks_game_template/docs/AddingUISFX.md)
|
||||
|
||||
### Extra
|
||||
1. [Adding Icons to the Input Options](/addons/maaacks_game_template/docs/InputIconMapping.md)
|
||||
2. [Supporting Joypad Inputs](/addons/maaacks_game_template/docs/JoypadInputs.md)
|
||||
3. [Loading scenes asynchronously](/addons/maaacks_game_template/docs/LoadingScenes.md)
|
||||
4. [Utilizing Game Saving](/addons/maaacks_game_template/docs/GameSaving.md)
|
||||
5. [Uploading to itch.io](/addons/maaacks_game_template/docs/UploadingToItchIo.md)
|
||||
Reference in New Issue
Block a user