INTRODUCTION
IntroductionCore ConceptsGETTING STARTED
InstallationQuick startWhirl Compiler SettingsCORE CONCEPTS
Using Utility ClassesStyle FunctionsPseudo-Classes and statesResponsive DesignResponsive Base ElementThemeArbitrary ValuesLAYOUT
aspect-ratiodisplayoverflowpositionvisibilityobject-fittop / right / bottom / leftFLEXBOX
flex-basisflex-directionflex-wrapflexflex-growflex-shrinkgapjustify-contentalign-contentalign-itemsalign-selfSPACING
paddingmarginSIZING
widthmin-widthmax-widthheightmin-heightmax-heightTYPOGRAPHY
font-sizefont-styleauto-sizetext-outlineletter-spacingtext-aligncolorword-spacingparagraph-spacingtext-overflowoverflow-positionwhite-spaceBACKGROUND
background-colorbackground-imagebackground-positionbackground-repeatbackground-sizeBORDER
border-radiusborder-widthborder-colorEFFECTS
text-shadowopacityFILTER
Filterblurbrightnesscontrastgrayscalehue-rotateinvertsaturatesepiaTRANSITION
transition-propertytransition-durationtransition-timing-functiondelayTRANSFORM
rotatescaletransform-origintranslateInstallation
Get started with WhirlUSS
WhirlUSS is a mostly editor framework that works by scanning all of your C# scripts and UXML files for class names, generating the corresponding styles and then writing them to a USS file. It's fast enough for you not to notice and it automatically detects changes as you work.
Installation
The simplest and fastest way to get up and running with WhirlUSS from scratch is by installing the latest compiled package from the Unity Asset Store. The Asset Store version has been compiled and doesn’t require any extra steps to get it up and running.
However, the alternative is on GitHub. To get the GitHub version running, you could compile it with your IDE of choice or import the scripts into your assets folder, and add 2 different assembly definitions to the runtime and editor folder, and make sure only to select Editor under the Included Platforms for the editor’s assembly definition.
The package is built to support Unity 2022 at a minimum, but it should also work with versions lower than 2022. These are the steps to follow to compile it from GitHub.
- Clone or download the repository from GitHub.
- Open the project in your IDE (e.g., Visual Studio, Rider).
- Add the necessary Unity assemblies to your project references.
- Build the project to generate the DLLs.
- Copy the generated DLLs into your Unity project's Assets/Plugins folder.
- Verify that WhirlUSS is functioning correctly within your Unity project.