https://github.com/maaack/the-cat-with-eight

https://github.com/maaack/the-cat-with-eight

Last synced: 4 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/maaack/the-cat-with-eight
• Owner: Maaack
• License: mit
• Created: 2023-11-12T03:30:12.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-11-21T02:28:14.000Z (over 2 years ago)
• Last Synced: 2025-03-01T21:48:31.301Z (over 1 year ago)
• Language: GDScript
• Size: 62.3 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
# Godot Game Template

For Godot 4.1.3

This template has a dynamic main menu, pause menu, and credits scene. Multiple options menus to choose from with key rebinding and persistent config settings.

## Features

### App (Base)

The `App/` folder holds the core components of the menus application.

-   Main Menu    

-   Options Menus

-   Pause Menu

-   Credits

-   Loading Screen

-   Persistent Settings

-   Simple Config Interface

-   Keyboard/Mouse Support

-   Gamepad Support

### Extras

The `Extras/` folder holds components that extend the core application.

-   Example Game Scene

-   Opening Scene

-   End Credits

-   Logging Scripts

-   Reset Logs Option

-   Additional Inherited Scenes from `App/`:

    -   `OptionsMenu.tscn`

    -   `MasterOptionsMenu.tscn`

    -   `MainMenu.tscn` 

    -   `PauseMenu.tscn`

    -   `InitApp.tscn`

  

## Usage

### App vs. Extras

To begin with, use the `Extras/` folder, and make changes there. However, to start minimally, use just the `App/` folder. Compare [Features](#features) to decide.

#### Minimal

If you just want to use just the projects minimum `App/` folder:

1.  Go to `Project > Project Settings… > General > Application > Run`.

2.  Update `Main Scene` to `res://App/Scenes/InitApp/InitApp.tscn`.

3.  Close the window.

    

The remaining instructions will apply the same for either folder you decide to use.

#### Extra Minimal

The pause menu feature can be removed if not used. From the `App/` folder, delete `PauseMenu/*`, `PauseMenuController.gd`, and `InGameMenuController.gd`. The last will need to be removed from the project's autoload, as well.

### New Project

These instructions assume starting with the entire contents of the project folder.

  

1.  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 `MainMenu.tscn`.

    5.  Select the `Title` node.

    6.  Update the `Text` to `"Game Name"`.

    7.  Save the scene.

2.  Point the main menu to the game scene.

    

    1.  Open `MainMenu.tscn`.

    2.  Select the `MainMenu` node.

    3.  Update `Game Scene Path` to the path of “Game Name” game scene.

    4.  Save the scene.

3.  Update the project’s inputs.

    

    1.  Go to `Project > Project Settings… > Input Map`.

    2.  Update the input actions and keybindings for “Game Name”.

    3.  Close the window.

    4.  Open `InputOptionsMenu.tscn`.

    5.  Select the `Controls` node.

    6.  Update the `Action Name Map` to show readable names for “Game Name” input actions.

    7.  Update the `Add Button Texture` and `Remove Button Texture` with textures.

    8.  Save the scene.

    

4.  Update the game credits / attribution.

    

    1.  Copy `ATTRIBUTION_example.md` over `ATTRIBUTION.md`.

    2.  Update `ATTRIBUTION.md` with “Game Name” credits, following the example.

    3.  Reload `Credits.tscn` scene to apply changes from `ATTRIBUTION.md`.

    4.  Include the attribution in exports.

        1.  Go to Project > Export.

        2.  Select one of “Game Name” presets (or set them up).

        3.  Select the Resources tab.

        4.  Update `Filters to export non-resource file/folders` to include `ATTRIBUTION.md`.

        5.  Close the window.

    

### Existing Project

For an existing project, just copy over the `App/` folder (optionally the `Extras/` folder, as well).

  

1.  Update the project’s main scene.

    

    1.  Go to Project > Project Settings… > General > Application > Run.

    2.  Update `Main Scene` to `res://…/InitApp.tscn`.

    3.  Close the window.

    

2.  Update the project’s autoloads.

    

    1.  Go to Project > Project Settings… > Autoload.

    2.  Add `res://App/Scripts/SceneLoader.gd`.

    3.  Add `res://App/Scripts/InGameMenuController.gd`.

    4.  Optionally add `res://Extras/Scripts/RuntimeLogger.gd`.

    5.  Close the window.

3.  Update the project’s name.

    

    1.  Open `MainMenu.tscn`.

    2.  Select the `Title` node.

    3.  Update the `Text` to `Game Name`.

    4.  Save the scene.

    

4.  Point the main menu to the game scene.

    

    1.  Open `MainMenu.tscn`.

    2.  Select the `MainMenu` node.

    3.  Update `Game Scene Path` to the path of “Game Name” game scene.

    4.  Save the scene.

    

5.  Update the project’s inputs.

    

    1.  Open `InputOptionsMenu.tscn`.

    2.  Select the `Controls` node.

    3.  Update the `Action Name Map` to show readable names for “Game Name” input actions.

    4.  Update the `Add Button Texture` and `Remove Button Texture` with textures.

    5.  Save the scene.

6.  Update the game credits / attribution.

    

    1.  Copy `ATTRIBUTION_example.md` over `ATTRIBUTION.md`.

    2.  Update `ATTRIBUTION.md` with “Game Name” credits, following the example.

    3.  Reload `Credits.tscn` scene to apply changes from `ATTRIBUTION.md`.

    4.  Include the attribution in exports.

        1.  Go to Project > Export.

        2.  Select one of “Game Name” presets (or set them up).

        3.  Select the Resources tab.

        4.  Update `Filters to export non-resource file/folders` to include `ATTRIBUTION.md`.

        5.  Close the window.

   

## Links

[Attribution](ATTRIBUTION.md)  

[License](LICENSE.txt)