Installation of Doddle USS is as simple as adding the package through the Unity package manager, however there is some initial setup required in the editor.

6.000+

Unity Versions

1.0.0

Current Version

Built-in / URP / HDRP

Render Pipelines

  • Add Doddle USS to 'My Assets' on the Unity Asset Store, by clicking 'Add to My Assets' on the Unity Asset Store page
  • In Unity, navigate to Window > Package Manager
  • Change the tab to 'My Assets', find Doddle USS, and press 'Download'
  • Create a new panel settings asset with Right Click/Assets > Create > UI Toolkit > Panel Settings Asset outside of the Doddle USS folder
  • Create a new text settings asset with Right Click/Assets > Create > UI Toolkit > Panel Settings outside of the Doddle USS folder
    • Reference the text settings asset in the panel settings 'Text Settings' field
  • Doddle USS does not ship with any font. Navigate to Assets > Doddle USS > Art > Font
    • Import .ttf files of your desired font for weights 100 (Thin)/300 (Light)/400 (Regular)/700 (Bold), and 900 (Black) regular, and italic versions
    • Right Click/Assets > Create > Text Core > Font Asset > SDF
    • Reference default font SDF asset in the 'Default Font Asset' field
    • OPTIONAL: In order for rich text tags to work with font assets, the 'Font WWeights section for SDF assets need to be populated
  • Navigate to Assets > Doddle USS > Themes > doddle-configuration.tss
    • Update the --font variable paths to point to the newly created SDF font assets
    • Add additional weights if desired and supported by your imported font
    • Utility classes for new font weights do not exist and will need to be created. Read more about Customization.

  • Create a new theme file for your project with Right Click/Assets > Create > UI Toolkit > TSS Theme File outside of the Doddle USS folder
    • Reference doddle-configuration.tss and doddle-palette.tss in the 'Inherited Themes' field
    • Reference your custom style sheets in the 'Style Sheets' field
    • This gives your project access to all of Doddle USS' configuration, colours, and utility classes, but allows you to define your own theme and project specific variables that won't be overwritten on updates
  • Add Doddle USS to your project's assembly reference
  • OPTIONAL: USS is nearly identical to CSS. Setting file associations for .tss, and .uss files with .css can be very useful.
  • Done! It is highly recommended to review some pages in the 'Resources' section