This guide will cover the steps to create a custom poster that can be used in game. While this guide will reference the creation of a poster, you can replace the word poster with sign in the instructions below for a wall sign instead.

Required Tools & Knowledge

• Photoshop or similar image editing software
  
• Text Editor to create and edit xml files

This guide will not go into full detail on some steps and will refer the reader to the Modding Guide - Custom Artwork where applicable.

Please refer to the Modding Guide - Custom Artwork guide on installing the mod tools and setting up Unity.

The wall poster texture is an image file that contains the the visuals for the poster as well as the poster frame. A template has been provided that can be used to create your poster image.

Inside of Unity you can find the template files in the Project browser under MFModTool > Templates.



Right click the template item and select Show In Explorer. This will open the file location of the
template image png file.

Open this file in an editor window and put your poster imagery inside the marked poster area in the image.

Save your final edited texture to the Export Content folder as described in the Modding Guide - Custom Artwork.

If creating a custom sign use the WallSign-Template instead.

Inside of Unity in the Export Content > Materials folder create a new material by right clicking in the empty folder area and selecting Create -> Material.



Click your new material and in the properties panel at top right set the shader to Mercury Fallen > MF_Standard under the Shader dropdown.



Click the Select button to the right of MainTex and search for, and select, your created poster texture to apply it to the MainTex property.

The BumpMap and MREM textures should also be set and textures are provided for you.

Click select, as your did above, but for the BumpMap texture and search for and apply 'T_WallPoster-N'.

Click select, as your did above, but for the BumpMap texture and search for and apply 'T_WallPoster-MREM'.

Your material should now look as follows:

Now that you have one, or more, poster materials you will need to export them for your mod. Please follow the Modding Guide - Custom Artwork at sections Assign Asset Bundle & Exporting Your Assets.

Now that you have your visual assets ready to go, you'll need to create an xml data object for your new poster material to be used in game.

Browse to your created mod folder and under data create a new xml file. The file name can be named anything you like. Copy and paste the following to your xml file.


Rename the following:

MYMODNAME.MYDATANAME
This is the unique identifier for your poster material data. To ensure it is unique use the naming convention of your mod name + the unique name for this data. Example: "FPPosterMod.ForestPainting".

Make sure to use the same name again in the gstr tag. The text between the gstr tags is the visible name of your poster as it appears in game.

If creating multiple posters you can create an additional gstr tag for each additional poster.

POSTERMATERIALNAME.MAT
This should be the name of your material as your created in the mod tools, but with an additional .mat at the end.

MYPOSTERICON.PNG
If you also exported a custom icon png inside the Icons folder in the mod tools, then this would be the name of that icon file.

Please review the Modding Guide - Getting Started at sections Enabling Mod & Upload To Workshop