Wallpaper Engine - Designer Documentation

# User Properties Introduction

Wallpaper Engine allows you to make parts of your wallpaper configurable by your users by adding so called user properties to your project. These user properties appear on the right-hand side when a user selects your wallpaper in the Wallpaper Engine Installed tab. In this guide, we will explain how to create and make use of properties and what each property type represents. Advanced users can also integrate user properties into their SceneScript code, this is documented in the SceneScript section of the documentation.

# User Properties

The following user property types are available in Wallpaper Engine. Click on any of them to view a detailed description on how they work:

  • Color (color): A color picker
  • Slider (slider): A slider that allows users to select a number within a specified range
  • Checkbox (bool): A checkbox that is either on or off
  • Combo (combo): A dropdown selector where each element has a text and a hidden value
  • Text (textinput): A text input field
  • Texture (texture): Allows users to replace a texture with a custom image or video

Properties will be shown on the right-hand side when a wallpaper is selected:

User Properties

You can always view, edit and even create new properties by opening your project in the Wallpaper Engine editor, navigating to the Edit menu at the top and selecting Change Project settings.

# Group Property Type

There is one special property type: The Group property. Adding this property will add all following properties to a group, allowing users to selectively hide them from the options list. The group property only features a label which you can use as a group name.

User Properties

To end a property group, you need to create another group property. If you have user properties which are not supposed to be part of a property group, place them before the first group in the property list.

# Conditionally hiding certain properties with display conditions

In some cases, you may want to show additional properties only under certain conditions. For example, you may have a clock in your wallpaper and you want to give users the ability to hide the clock and change between a 24 hour and 12 hour format. In this case, you might create two checkbox properties:

  • Show Clock
  • Use 24h format

Since the "Use 24h format" user property does not make sense on its own, it is best that you hide it if the clock is disabled. This can significantly reduce clutter in your wallpaper settings, making it easier for users to configure your wallpaper.

To implement this, first create the Show Clock checkbox property (or whatever user property name makes sense in your wallpaper). Take note of the Key that Wallpaper Engine automatically generates below your user property name. In the case of "Show Clock", the key would be show_clock.

Now, create your related user properties. During the creation, you can configure a display condition at the bottom of the creation form. All you need to do is to add the following code there (just replace show_clock with the key of your user property):

show_clock.value == true

You can see the entire process in this video:

TIP

You can also create display conditions for combo properties with a dropdown list of options. In that case, you would need to replace the true keyword with a value that you have created in the combo property. For example:

yourproperty.value == "example123"

← Color User Property →