Type (special) Revision Release 2024.3703 Keywords Splash Screen Control, splash screen Platforms Android, iOS
This special plugin, enables control of the default Solar2D branded splash screen that is displayed when apps start up on a device. Rather than adding capabilities to Lua code, this plugin enables the ability to control the splash screen from within build.settings
.
To remove splash screen, add the splashScreen
table to the project’s build.settings
with the enable
key set to false
:
settings = { splashScreen = { enable = false }, }
Alternatively, you can remove the splash screen on a
settings = { splashScreen = { ios = { enable = false }, android = { enable = true } }, }
If you’d like to display your own custom splash screen, include the splashScreen
table within build.settings
as above, but set the enable
key to true
and add an image
key defining the image name. For instance:
settings = { splashScreen = { enable = true, image = "mySplashScreen.png" }, }
Alternatively, you can customize the splash screen on a
settings = { splashScreen = { ios = { enable = true, image = "mySplashScreen_iOS.png" }, android = { enable = true, image = "mySplashScreen_Android.png" } }, }
For customized implementation, image
indicates the path to any image file in the project. The image will be displayed on a black background and it will match the default orientation of the app, scaled to fit the screen of the current device. You may need to experiment to arrive at the ideal image for your splash screen, but if it’s large enough for the largest device your app is intended to run on, you only need one image.
Because build.settings
does not apply to app builds performed via Solar2D Native, special handling is required to customize the splash screen in these instances. Please see the Solar2D Native section below for details.
Because build.settings
does not apply to app builds performed via Solar2D Native, special handling is required to customize the splash screen in these instances:
For iOS, place an image named _CoronaSplashScreen.png
in the root of your app bundle, specifying it as a “resource” in Xcode.
For Android, place an image named _corona_splash_screen.png
within res/drawable/
using whatever mechanism is appropriate in Android Studio or otherwise.