Skip to content

The config.yml file

Lennart edited this page Nov 16, 2022 · 5 revisions

You can customize your wallpaper composition to your needs and taste by writing your own config.yml file.
Pass your own script to the program by adding the -c flag to the program call.

Example config file:

settings:
  width: 1920
  height: 1080
  bg-color: "#000000"

planets:
  meteosat-11:
    x: 960
    y: 540
    size: 1060
    color: natural_color

The Tab width must be 2 spaces!

Settings block

  • The settings Block specifies the global settings for your wallpaper.\
  • bg-color is a hex string and needs to be in quotation marks.

Planets block

  • All displayed images are listed here.
  • Each satellite image consist of its own block. The name of the block specifies the satellite source.
  • To see a list of all available satellites and their exact names, go to Supported Satellites
  • Each satellite has its individual set of parameters.
  • Coordinate System (0,0) is in the Top Left Corner and positive values go Down/Right!
  • Pixel Coordinates for planet positioning is always refers to the center of the planet!

Meteosat, Goes, Himawari

name description
x The Image`s position along the x axis.
y The Image`s position along the y axis.
size The size in pixel of one image side (Images are quadratic)
color The Color composite Product. Choose between "natural_color" and "geocolor".

SDO

name description
x The Image`s position along the x axis.
y The Image`s position along the y axis.
size The size in pixel of one image side (Images are quadratic)
bandwidth The bandwidth Channel. Choose between "0171", "0171pfss", "0304", "0304pfss", "HMIIC.

Sentinel

name description
x The Image`s position along the x axis.
y The Image`s position along the y axis.
width Th width of the image in pixel.
height The height of the Image in pixel.
scale The of the image in Km.
latitude The latitude of the position the image is centered around.
longitude The longitude of the position the image is centered around.

Apod (astronomy picture of the day)

name description
x The Image`s position along the x axis.
y The Image`s position along the y axis.
size The size in pixel of one image side (Images are quadratic)
fit Fill: The image will be stretched or squished to fit.
Contain: The image keeps its aspect ratio, but is resized to fit within the given dimension
Cover: The image keeps its aspect ratio and fills the given dimension. The image will be clipped to fit.

A few Example Files and its images, also featured in the Readme.

config1.yml:

settings:
  width: 1920
  height: 1080
  bg-color: "#000000"

planets:
  meteosat-11:
    x: 960
    y: 540
    size: 1040
    color: natural_color

config2.yml:

settings:
  width: 1920
  height: 1080
  bg-color: "#000000"

planets:
  goes-16:
    x: 960
    y: 540
    size: 1040
    color: geocolor

config3.yml

settings:
  width: 1920
  height: 1080
  bg-color: "#000000"

planets:
  meteosat-11:
    x: 1200
    y: 540
    size: 300
    color: natural_color
    
  sdo:
    x: -200
    y: 540
    size: 1400
    bandwidth: "0304"