Skip to content
/ RTMSDF Public

2D signed distance field generators & importers for Unreal Engine 5

License

Notifications You must be signed in to change notification settings

rtm223/RTMSDF

Repository files navigation

RTMSDF - 2D Signed Distance Field Generators & Importers for Unreal Engine 5

RTMSDF

An Unreal Engine 5 Plugin that provides importers for generating 2D SDFs from .svg source files and all Unreal-supported texture source files (.psd, .png, .tif etc). Uses MSDFGen for processing of SVG files. Currently supports UE5.4+

See Changelog for details of what is new in version 1.0.

Downloading from GitHub

You can either clone this repository if you're comfortable with git and building Unreal cpp projectsfrom source, otherwise you can download a pre-built binary release.

Cloning the repository

Source files will need to be placed in either {Project}/Plugins/RTMSDF/ or {Engine}/Plugins/RTMSDF/

Download Binary releases

Download the latest binary release as a zip file and extract it in either your {Project}/Plugins/ or {Engine}/Plugins/ directory

Quick Start

1. Enable the Plugin

Ensure that the plugin is enabled for your project, either by manually adding it to your .uproject file, or in editor via the Plugins window:

  1. Choose Edit > Plugins from the top menu bar
  2. Find the plugin called Signed Distance Fields [RTMSDF] or search "RTMSDF"
  3. Ensure the box to the left of the icon is checked
  4. If you needed to check the box, restart the editor

2. Configure Interchange

Configure Interchange to be add the importers to the texture pipeline

  1. Choose Edit > Project Settings from the top menu bar
  2. Find Engine > Interchange in the side bar (do NOT search for it)
  3. Under Import Content > Content Import Settings > Pipeline Stacks find Textures and add a new element to the Pipelines array
  4. Select Interchange_RTMSDF_BitmapPipeline.
    • If you cannot see it it the drop down, check the plugin is enabled and that you have Show Plugin Content checked in the Asset Picker ⚙️Settings
  5. Click Set as Defaultin the top right of the window.
    • If you can't see this button, check that you found the Interchange via the side bar and not by searching

NOTE: Interchange settings are per-user, so if you are working on a team it is important to Set as Defaults and commit the DefaultEngine.ini file to VCS

3. Import Your First SDFs

Start by trying to import one of the example assets

  1. Navigate to the folder with RTMSDF.uplugin in
  2. Find the SourceAssets/Examples/Textures/ subdirectory
  3. Drag one of the .png files and one of the .svg files into your content browser
  4. The thumbnails should look similar to the ones below (orange/purple, with "SDF" or "MSDF" in the corner)
    • If they don't show up like that, double check the Plugin and interchange settings, or contact me via Bluesky, Mastodon or email
    • Hopefully there will be a troubleshooting guide available soon

Further Reading

Check out the Docs for more info. Recommended next steps are

  • Generation - to find out more about generating SDFs and import options
  • Examples to see some of the effects you can create with SDF textures

About

2D signed distance field generators & importers for Unreal Engine 5

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Contributors 3

  •  
  •  
  •