Skip to content

Commit

Permalink
enhanced information inside scaffold README
Browse files Browse the repository at this point in the history
  • Loading branch information
PrimaryFeather committed Aug 2, 2021
1 parent e407c6a commit 78e9d71
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion samples/scaffold_mobile/README.md
Expand Up @@ -3,7 +3,7 @@ Scaffold Project for Mobile Apps

This project is set up as a universal application supporting iPhone and iPad, as well as any Android device.
Use it as the basis for your mobile application projects.
The recommended approach is to simply copy the complete directory somewhere on your disk, rename the classes appropriately, and add your application logic step by step.
The recommended approach is to simply copy the complete directory somewhere onto your disk, rename the classes appropriately, and add your application logic step by step.

Features:

Expand All @@ -13,6 +13,7 @@ Features:
* Contains exemplary adaptive icons for Android and an 'Assets.car' file for iOS icons.
* The project proposes a simple structure to navigate between game and menu.
This is done with three classes: _Root_, _Game_ and _Menu_.
* Contains project files for _Visual Studio Code_ and _IntelliJ IDEA_.

To find out more about multi-resolution development, please visit the [Starling Manual][1].
It also contains an article about [device rotation][2].
Expand All @@ -32,6 +33,24 @@ Change the relevant areas inside `Scaffold_Mobile-app.xml`, as well as `utils/Sc

[3]: https://airnativeextensions.com/extension/com.distriqt.Application

## Updating application icon and launch screen

Since iOS 11, Apple requires the app icon to be added in the form of an `Assets.car` file that needs to be created via Xcode (or online tools created by the developer community). The details are explained in great detail by our friends from distriqt, so please refer to [their tutorial][4] for the details.

The same document also explains how to set up your launch screen (i.e. `LaunchScreen.storyboard`) – but beware that you only need to set that up if you're using a commercial version of AIR. If you're on the 'Free Tier', Harman will show a splash screen anyway, so don't bother with it.

In any case, have a look at the 'util' folder of the Starling download to find the Xcode project that was used to create icons and launch screen for the scaffold project.
Together with above's tutorial, you should be able to adapt it to your needs.

Android nowadays requires 'adaptive icons' for its apps, which means that they are split up into a foreground and a background image.
Those files are most easily created with _Android Studio_ and then imported into your app via a 'resource folder'.

Again, I want to forward you to the respective [tutorial][5] from distriqt.
The scaffold project has its resource folder inside `system/res`; the new `resdir` element inside the application XML will tell AIRs packaging tool where to find them.

[4]: https://docs.airnativeextensions.com/docs/tutorials/ios-icons-assets-car
[5]: https://docs.airnativeextensions.com/docs/tutorials/android-adaptive-icons

## Building the project

Users of "IntelliJ IDEA" can open the project that's stored in `starling/build/idea`.
Expand Down

0 comments on commit 78e9d71

Please sign in to comment.