# UMarkup **UMarkup** is a simplified extension for **Unity RichText Markup**，It can enhance the text style of **Log** / **UGUI Text** / **GUI Label**, also for **TextMeshPro**. ![topLanguage](https://camo.githubusercontent.com/73bbaaa7c64526f7f4fe3ea87cc2f8ffd48b36304369141de3f35ad6017d8b7c/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c616e6775616765732f746f702f6c73393531322f554d61726b7570) ![size](https://camo.githubusercontent.com/648cdf0ac512277a627b8dd4f0e6a4476494b89a6cf1645122fbd25942ed58d2/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c616e6775616765732f636f64652d73697a652f6c73393531322f554d61726b7570) ![issue](https://camo.githubusercontent.com/f5a41a8ce76b5ec3ab65f7101d6cf61cc4e2c4e437975a28c3710dd131f370a3/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6973737565732f6c73393531322f554d61726b7570) ![license](https://camo.githubusercontent.com/70d288e08bec114e4e39f931e7c83131dc177db74f4b6f66dbf76e34ae6c3e54/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f6c73393531322f554d61726b7570) ![last](https://camo.githubusercontent.com/1373578a0bab4dc301b6dec8e5f061360c2a24a18e326562529befcd079babe7/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6173742d636f6d6d69742f6c73393531322f554d61726b7570) * 1. [How to use](https://github.com/ls9512/UMarkup/raw/master/#Howtouse) * 1.1. [Common Styles](https://github.com/ls9512/UMarkup/raw/master/#CommonStyles) * 1.2. [Extension Method](https://github.com/ls9512/UMarkup/raw/master/#ExtensionMethod) * 1.3. [Static Method](https://github.com/ls9512/UMarkup/raw/master/#StaticMethod) * 2. [Supported Tags](https://github.com/ls9512/UMarkup/raw/master/#SupportedTags) * 2.1. [Font Sytle](https://github.com/ls9512/UMarkup/raw/master/#FontSytle) * 2.2. [Color Sytle](https://github.com/ls9512/UMarkup/raw/master/#ColorSytle) * 2.3. [Other](https://github.com/ls9512/UMarkup/raw/master/#Other) * 3. [Custom Style](https://github.com/ls9512/UMarkup/raw/master/#CustomStyle) * 4. [Extension for TextMeshPro](https://github.com/ls9512/UMarkup/raw/master/#ExtensionforTextMeshPro) * 4.1. [Supported Tags](https://github.com/ls9512/UMarkup/raw/master/#SupportedTags-1) * 4.2. [Supported Size Formart](https://github.com/ls9512/UMarkup/raw/master/#SupportedSizeFormart) ## 1. How to use ### 1.1. Common Styles Use common styles in a concise way: ``` cs var str1 = "[Markup Test 1]" // Complex Style + " Complex Style".Color(Color.green).Bold().Size(15) // White + " White".Color(Color.white) // Italics + " Italics".Italic() // Bold + " Bold".Bold(); Debug.Log(str1); ``` ### 1.2. Extension Method Use extension methods to organize multiple different styles: ``` cs var str2 = "[Markup Test 2]" // Complex Style + " Complex Style".ToMarkup(UMarkup.Green, UMarkup.Bold, UMarkup.Size(15)) // White + " White".ToMarkup(Color.white) // Italics + " Italics".ToMarkup(UMarkup.Italic) // Bold + " Bold".ToMarkup(UMarkup.Bold); Debug.Log(str2); ``` ### 1.3. Static Method ``` cs var str3 = "[Markup Test 3]" // Complex Style + UMarkup.Create(" Complex Style", UMarkup.Green, UMarkup.Bold, UMarkup.Size(15)) // White + UMarkup.Create(" White", UMarkup.Color(Color.white)) // Italics + UMarkup.Create(" Italics", UMarkup.Italic) // Bold + UMarkup.Create(" Bold", UMarkup.Bold); Debug.Log(str3); ``` ## 2. Supported Tags ### 2.1. Font Sytle * Size * Bold * Italic ### 2.2. Color Sytle * Red * Green * Blue * White * Blank * Yellow * Cyan * Magenta * Gray * Clear * Color ### 2.3. Other * Material * Quad ## 3. Custom Style Support for custom extended styles can be obtained by creating a **MarkupAdapter** with custom parameters. ``` cs public static class MarkupCustomStyleSample { // Custom single mark style public static MarkupAdapter CustomStyle1 { get; } = new MarkupAdapter(""); // Custom left and right mark Style public static MarkupAdapter CustomStyle2 { get; } = new MarkupAdapter("", ""); } ``` ## 4. Extension for TextMeshPro You can also use **UMarkup** to build strings for **TextMeshPro**. The supported tag styles are as follows: ### 4.1. Supported Tags * AlignLeft * AlignCenter * AlignRight * Alpha * CharacterSpace * Font * Indentation * LineHeight * LineIndentation * Link * Lowercase * Uppercase * AllCaps * SmallCaps * Margin * Mark * MonoSpace * Noparse * NoBreakingSpaces * PageBreak * HorizontalPosition * Size * HorizontalSpace * Sprite * Underline * Strikethrough * Style * Superscript * Subscript * VerticalOffset * Width ### 4.2. Supported Size Formart * Pixels * FontUnits * Percentages