shreyanavigyan/godot-awesome-splash

Collection of splash screens in Godot

Overview

Collection of splash screens for Godot Engine. Easy to use, fast Installing, multiple resolutions.

You can edit the code, change the logo as you like.

I used GDAction for animation.

Run on Desktop:

Run on mobile:

Support to easily change logo, title, description by changing constant variables

You can use preview_demo to choose the right splash screen for your project:

Install and use

Watch tutorial video here

Installation

Copy the contents of the plugins to the same folder in your project and activate AwesomeSplash and GDAction.

If you need more details, you can watch the video above.

How to use AwesomeSplash

1. Create folder src/demo_collection/ (if it doesn't exist then you can create src folder and demo_collection folder)
2. Copy demo splash you like to your project in to demo_collection folder. (Note: If you copy to another folder, just fix the "Load failed due to missing dependencies" error by clicking "Fix Dependencies" and selecting your path.)
3. Create SplashContainer.
4. Drag and drop splash_screen.tscn to SplashContainer.

If you need more details, you can watch the video above.

QA:

How to set main screen is AwesomeSplash.

In Godot engine: Select Project > Project Settings... > Application -> Run -> Main Scene: Select to your Screen Splash screen

How to hide the default splash screen of Godot engine.

In Godot engine: Select Project > Project Settings... > Application -> Boot Splash -> Image: select (res://addons/awesome_splash/assets/None.png)

I got an error message "Load failed due to missing dependencies":

Please put the correct "demo folder" in the path src/demo_collection/

(Note: If you copy to another folder, just fix the "Load failed due to missing dependencies" error by clicking "Fix Dependencies" and selecting your path.)

I don't want to put the code at "src/demo_collection/":

Yes, after successful first run you can change it, godot will automatically fix the import for you. So after successful run you can change the directory of the code.

I want to change the logo, title, and description in the template.

Yes, you can change background color, animation time, logo, title... via constant variables in the splash_screen.gb file.

const LOGO_PATH := "res://src/demo_collection/demo7/src/logo.png"
const TITLE := "GODOT"
const DESCRIPTION := "Game engine"

You should use a logo that is only white. I can script to manually adjust all logos to 1 color but it doesn't seem like a good idea as it can ruin your design. I'm still looking for ideas for this, maybe it will be added in the future.

I want to the user that can skip this splash when they tap on the screen.

This feature already exists, in the splash container, you change the function _splash_screen_can_be_skipped_when_clicked_screen to return true (default is false).

func _splash_screen_can_be_skipped_when_clicked_screen() -> bool:
    return true

I want to run on mobile (android, ios.. ), what do I need to do?

You don't need to do anything, the splash screen will automatically adjust for you.

Contribution

Contributions are welcome and are accepted via pull requests.

You can use Tween, AnimationPlayer or GDAction ...etc.. to create SplashScreen.

You can contribute code and submit pull or you can provide ideas and resources by creating an issue. :)

License

MIT License

Copyright (c) 2021-present, Duong Vi Tuan