Press / to search

Screens folder

contains textures such as background, foreground, midground, scrolling images and masks.

All of the layers of a screen can be merged to make a result like the example below (without counting the hidden wall because that’s a type of prop). Every layer has its own name, format and folder; hover on the image below and click on the image you want to know more about!

Image of contents

All the following details can be found inside the Screen page, therefore the documentation is omitting the unnecessary Screens page navigation on each step.

Background

At the lowest ground there’s the background.
The background is commonly used for skies or gradients to put on the back end of screens.

Adding a background

Using the Go to screen… button or the up-down arrows, move to the screen you want to add a background.
Right-click on the preview on the left-side of the page, a context menu like the following should appear.
Navigate into Add on screen…, then Grounds, then click on Background.
Select your background image and click Open.
After clicking Open, you should be able to see your new background inside Worldsmith!

Replacing or removing a background

Using the Go to screen… button or the up-down arrows, move to the screen you have the background you want to change/get rid of.
From the right side of the page, expand the Grounds tab.

From here, you can click Replace (the yellow button) to replace an existing background with another one, or click Delete (the red button) to delete the background.

Steps (without Worldsmith)

Adding/replacing a background

To add a new or replace an existing background:

If you are not using Worldsmith, convert an image file into a packed XNB file with the following details:
resolution 480x360 pixels
File name bgSCREEN NUMBER
(e.g. bg65)
Place the new packed file in the screens/background folder.
If a file is already existing, replace it with the new file.

Removing a background

To remove an unwanted background:

Navigate to the screens/background folder.
Simply delete the file that you don’t want.
Following the logic, if you don’t want the background of your 5th screen, you will remove bg65.xnb.

Scrolling images

The scrolling texture is commonly used for mist clouds or birds flying in the distance right before the player layer but above the background.

Adding a scrolling image

Adding a scrolling image has not been yet implemented inside Worldsmith. If you’d like to add a scrolling image, consider looking out the Steps (without Worldsmith).

Replacing or deleting a scrolling image

Using the Go to screen… button or the up-down arrows, move to the screen you have the scrolling image you want to change/get rid of.
From the right side of the page, expand the Scrolling images tab.
Click on the scrolling image you are looking for helping you by viewing the preview on the left side.

From here, you can click Replace (the two arrows yellow button) to replace an existing scrolling image with another one, or click Delete (the red button) to delete the scrolling image.

Scrolling image settings

Use the Position inputbox to move your scrolling image through the screen, change its direction (horizontal or vertical) with the dropdown labelled as Direction, change its scroll multiplier (to make it faster or slower and changing directions) with the dedicated scroll bar or change its layer to make your scrolling image more immersive inside your screen.

Steps (without Worldsmith)

The scrolling images are managed by an XML file, that determines their texture, position, velocity, layer mode and possible additional frames. In order to have a working scrolling image, you will need to have both the XML file and the packed XNB file.

If this is the first time hearing about XMLs, find out what they are and how to use them.

Adding a scrolling image

If you want to add a new scrolling image:

If you are not using Worldsmith, convert an image file into a packed XNB file.
While there aren’t any restrictions with how it should be named, avoid using spaces or special characters and it’s suggested that you name it in a way that you can retroactively know which file is later on. An example could be:
```
`SCREEN`_[NAME]_[NUMBER] (e.g. 65_clouds_1)
```
If you follow such, you can easily tell which screen the scrolling image is used from, what is in the scrolling image, and a number if you have more than one scrolling images.
Head to the following folder: screens/scrolling.
You can put your new packed scrolling image inside the textures folder. Write down your scrolling image file name somewhere, this will be used later.

Check if you already have an existing xml file for the screen that you want to add your new scrolling image, you can easily find it by searching “scroll” and then the screen number (e.g. scroll65.xml).

If the file doesn’t exists, don’t worry!

Copy the following snippet:

  <?xml version="1.0"?>
  <ScrollingBGdata xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
      <scroll_speed>10</scroll_speed>
      <layers>
          <Layer>
              <texture>YOUR_SCROLLING_IMAGE_NAME_HERE</texture>
              <position>0</position>
              <scroll_multiplier>1</scroll_multiplier>
              <direction>Horizontal</direction>
          </Layer>
      </layers>
  </ScrollingBGdata>

Create a new xml file called scroll[SCREEN] (e.g. scroll65.xml), open it and paste the snippet above

If the file already exists:
Copy the following snippet:
  <Layer>
      <texture>YOUR_SCROLLING_IMAGE_NAME_HERE</texture>
      <position>0</position>
      <scroll_multiplier>1</scroll_multiplier>
      <direction>Horizontal</direction>
  </Layer>
Inside the layers tag, below already existing Layers, paste your snippet.

Replace YOUR_SCROLLING_IMAGE_NAME_HERE with the filename of your new packed scroll image.
Replace Horizontal with Vertical if you’d like your scrolling image to display vertically.

Replacing a scrolling image

To replace an already existing scrolling image:

Convert the new scrolling image into a packed XNB file.
Replace the old file with the new file in the screens/scrolling/textures.
If your packed file isn’t named the same as before, you will need to change the texture tag in the xml file(s) that previously had the old file or remove the layer completely.

Removing a scrolling image

To remove a scrolling image:

Find the scrolling packed image of your choice and remove it.
You will need to remove each Layer tag in the xml file(s) that contained your old file as texture.

If you want the scrolling image to start in a different X position, change the position tag into the X value you want. Same goes for the velocity of the scroll image, if you think it’s too fast or too slow, change the scroll_multiplier to the value that you want. The higher is the number the faster it will go, and dont’ worry, the number works both in positive and negative.

Midground

Right after the scrolling images, there’s the midground.
The midground is usually used for platforms and details that are behind the player (the player can go over them).

Adding a midground

Using the Go to screen… button or the up-down arrows, move to the screen you want to add a midground.
Right-click on the preview on the left-side of the page, a context menu like the following should appear.
Navigate into Add on screen…, then Grounds, then click on Midground.
Select your midground image and click Open.
After clicking Open, you should be able to see your new midground inside Worldsmith!

Replacing or removing a midground

Using the Go to screen… button or the up-down arrows, move to the screen you have the midground you want to change/get rid of.
From the right side of the page, expand the Grounds tab.

From here, you can click Replace (the yellow button) to replace an existing midground with another one, or click Delete (the red button) to delete the midground.

Steps (without Worldsmith)

Adding/replacing a midground

To add a new or replace an existing midground:

If you are not using Worldsmith, convert an image file into a packed XNB file with the following details:
resolution 480x360 pixels
File name SCREEN NUMBER
(e.g. 65)
Place the new packed file in the screens/midground folder.
If a file is already existing, replace it with the new file.

Removing a midground

To remove an unwanted midground:

Navigate to the screens/midground folder.
Simply delete the file that you don’t want.
Following the logic, if you don’t want the midground of your 5th screen, you will remove 5.xnb.

Weather

Weather is above the player layer-wise.
The weather is a particle effect that can help to create depth in your level.

We are planning to change the weather to make it more customizable in the future. As of now, it works in the same way JumpKingPlus did.

Adding a weather

Using the Go to screen… button or the up-down arrows, move to the screen you want to add a weather.
Right-click on the preview on the left-side of the page, a context menu like the following should appear.
Navigate into Add on screen…, then Weather and mask, then click on Weather.
A new prompt will show up asking to you select a weather.
After selecting a weather, click Clise and you should be able to see your new weather inside Worldsmith!

Replacing or removing a weather

Using the Go to screen… button or the up-down arrows, move to the screen you have the weather you want to change/get rid of.
From the right side of the page, expand the Weather and mask tab.

From here, you can click Replace (the yellow button with the arrows) to replace an existing weather with another one, click Delete (the red button) to remove the weather from the current screen or change the weather settings (with the yellow button with the cog).

Steps (without Worldsmith)

The weather.xml file can be found inside the particles folder of your level.

Adding/removing weather

Make a list of the screens where you want to add a specific weather.
Navigate to particles and open weather.xml.
Inside this file you should see plenty of pre-existing particles that can be used for your level. Find which weather to use.
Navigate to the Weather tag that contains your chosen value.
Inside screens, add the following snippet and replace YOUR_HITBOX_SCREEN with the screen number for each screen you want to have the weather in:
```
 <int>YOUR_HITBOX_SCREEN</int>
```
If you want to modify the velocity, you can tinker with the fps value.
Despite the weather is behind the player by default, the weather can be on the foreground by adding the following snippet in the Weather tag.
```
     <foreground>true</foreground>
```

To remove the weather from one or multiple screens:

Write down the screen(s) you want to remove the weather.
Navigate to particles and open weather.xml.
Search for each screen number and remove their entire int tag.

If you wanted to show the weather only in a portion of the screen, continue reading about weather masks.

Mask for weather

The weather, being an effect that repeats on the whole screen, can be rather annoying or obstructing other details on screen, that’s there the mask comes in. Masks can be used to give more depth to the level by cutting out the unnecessary particle (for example, inside a building like shown above).

Mask

The mask works just like the difference effect on Photoshop, which lets you display the particles effect only on the blue/cyan ( #0094FF) mask you are creating.

The mask only takes effect if a weather is present on a certain screen. Check out how to add a weather on a screen before continuing.

Adding weather mask

Using the Go to screen… button or the up-down arrows, move to the screen you want to add a weather mask.
Right-click on the preview on the left-side of the page, a context menu like the following should appear.
Navigate into Add on screen…, then Weather and mask, then click on Mask.
Select your mask image and click Open.
After clicking Open, you should be able to see your new mask inside Worldsmith!

Replacing or removing a weather mask

Using the Go to screen… button or the up-down arrows, move to the screen you have the weather mask you want to change/get rid of.
From the right side of the page, expand the Weather and mask tab.

From here, you can click Replace (the yellow button) to replace an existing weather mask with another one, or click Delete (the red button) to delete the mask.

Steps (without Worldsmith)

Adding/replacing a mask

To add a new or replace an existing mask:

Make sure you’ve set the correct particle in your particle configuration file.
If you are not using Worldsmith, convert an image file into a packed XNB file with the following details:
resolution 480x360 pixels
File name MASK NAMEmaskSCREEN NUMBER
(e.g. ashmask65)
Place the new packed file in the screens/masks folder.
If a file is already existing, replace it with the new file.

Removing a mask

To remove an unwanted mask:

Navigate to the screens/masks folder.
Simply delete the file that you don’t want.
Following the logic, if you don’t want the midground of your 5th screen, you will remove whatever file ends with “[…]mask5.xnb”.

Removing a mask inside a screen that has already a particle effect (written on particles/weather.xml) will display the effect on the whole screen. If you want to remove the particle effect, see how you can remove it.

Foreground

The foreground work one layer above the masks and particles.
The foreground is used for details that are in front of the player, such as vines or grass.

Adding a foreground

Using the Go to screen… button or the up-down arrows, move to the screen you want to add a foreground.
Right-click on the preview on the left-side of the page, a context menu like the following should appear.
Navigate into Add on screen…, then Grounds, then click on Foreground.
Select your foreground image and click Open.
After clicking Open, you should be able to see your new foreground inside Worldsmith!
Your foreground might be disabled in the preview by default. To show it, from the right side of the page, expand the Grounds tab and click on the Eye icon to show/hide your foreground.

Replacing or removing a foreground

Using the Go to screen… button or the up-down arrows, move to the screen you have the foreground you want to change/get rid of.
From the right side of the page, expand the Grounds tab.

From here, you can click Replace (the yellow button) to replace an existing foreground with another one, or click Delete (the red button) to delete the foreground.

Steps (without Worldsmith)

Adding/replacing a foreground

To add a new or replace an existing foreground:

If you are not using Worldsmith, convert an image file into a packed XNB file with the following details:
resolution 480x360 pixels
File name fgSCREEN NUMBER
(e.g. fg65)
Place the new packed file in the screens/foreground folder.
If a file is already existing, replace it with the new file.

Removing a foreground

To remove an unwanted foreground:

Navigate to the screens/foreground folder.
Simply delete the file that you don’t want.
Following the logic, if you don’t want the foreground of your 5th screen, you will remove fg5.xnb.

Screens folder recap

Let’s recap the main details for the packed files you will need.

Title	Resolution	File name	Folder	Needs XML?
Background	480x360 pixels	bg`SCREEN` (e.g. bg65)	`screens/background/`	❌
Scrolling image	any	any	`screens/scrolling/textures/`	✔️
Midground	480x360 pixels	`SCREEN` (e.g. 65)	`screeens/midground/`	❌
Mask	480x360 pixels	`MASK_NAME`mask`SCREEN` (e.g. ashmask65)	`screens/masks/`	❌
Foreground	480x360 pixels	fg`SCREEN` (e.g. fg65)	`screens/foreground/`	❌

Next up

Go to GUI to learn where to put the screens in the GUI folder.

resolution	480x360 pixels
File name	bg`SCREEN NUMBER` (e.g. bg65)