Skip to main content

Customizing Builds

TODO

This article is a work in progress

The boot logo is shown when the device is powered on, and before any boot animation starts. It is a static BMP file that should display a logo.

Since the resolutions of screens vary, it should be centrally located, and use a background that is the same as the start of the boot animation documented below.

Unless otherwise agreed, this is the Apostrophy logo.

Boot Animation​

The boot sequence of the phone consists of the following three components;

  1. A static Apostrophy logo is displayed for approximately 3 seconds, see Boot Logo,

  2. An animation plays for approximately 5 seconds, during which a sound may be heard,

  3. Either the setup wizard dialog, or the default user (owner) lock screen is displayed.

Implementation of a Boot Animation​

  • A static Apostrophy logo is displayed preceeding the animation part, and it is not normally customized. However, it's color scheme may need to be altered to facilitate the starting frame of the custom boot animation.

  • Custom boot animations are controlled through a description text file containing the devices horizontal and vertical resolution and the framerate at which the animation is to run, as well as the stages at which certain animations are to play, in the following syntax;

    [width] [height] [framerate]
    [c|p] [loops] [pause] [folder] [background]
    [c|p] [loops] [pause] [folder] [background]
    [c|p] [loops] [pause] [folder] [background]

    The last line of desc.txt must be an empty line

    For example;

    1080 2400 24
    c 1 0 part0 000000
    c 1 0 part1 000000
    p 1 0 part2 000000

    This constitutes a 3-phase animation, 2 parts of which are forcefully continuous and the last part being one that is abruptly cut when the OS has completed loading.

  • The images MUST be in PNG format.

  • Neither the directory hierarchy nor the image filenames can contain spaces. Use dashes and underscores where needed.

  • Images are played in the order in which they appear when alphabetically sorted. It is recommended to use a suffix for numbering and thus sequencing, and not a prefix.

  • The zip file you deliver must be created without compression.

    An example command-line invocation (that avoids .DS_Store and alike):

    $ cd /path/to/boot-animation-source-material/
    $ zip -0qry -i \*.txt \*.png \*.wav @ ../bootanimation.zip *.txt part*

  • At a framerate that does not correspond to the refresh rate of the screen in a sensible way, divergence may result in a poor animation quality.

  • At a framerate of 24, the phone will rotate through a directory part0 with 24 images in 1 second. Design the number of images to use in the animation accordingly.

    This means your sequence existing of 120 images will last for 5 seconds.

  • You MAY supply an audio.wav to be included in your animation. The duration of this audio file playing must not exceed the animation.

    Apostrophy will by default include a carefully crafted, specifically designed 384 kbit/s silence.

  • You MUST leave the last phase as interruptable by the OS having loaded succesfully.

Setup Wizard​

TBD

Iconography​

TBD

Sound Package​

TBD

Wallpapers​

TBD