https://github.com/ls9512/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.
https://github.com/ls9512/umarkup
game game-development markup richtext ugui-text uguicomponent ui uigui unity unity3d unity3d-plugin
Last synced: 6 months ago
JSON representation
UMarkup is a simplified extension for Unity RichText Markup，It can enhance the text style of Log / UGUI Text / GUI Label, also for TextMeshPro.
- Host: GitHub
- URL: https://github.com/ls9512/umarkup
- Owner: ls9512
- License: mit
- Created: 2020-12-04T06:14:20.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-03-23T17:50:17.000Z (over 3 years ago)
- Last Synced: 2025-04-02T06:51:14.031Z (6 months ago)
- Topics: game, game-development, markup, richtext, ugui-text, uguicomponent, ui, uigui, unity, unity3d, unity3d-plugin
- Language: C#
- Homepage:
- Size: 19.5 KB
- Stars: 27
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# 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**.
[](https://996.icu)
* 1. [How to use](#Howtouse)
* 1.1. [Common Styles](#CommonStyles)
* 1.2. [Extension Method](#ExtensionMethod)
* 1.3. [Static Method](#StaticMethod)
* 2. [Supported Tags](#SupportedTags)
* 2.1. [Font Sytle](#FontSytle)
* 2.2. [Color Sytle](#ColorSytle)
* 2.3. [Other](#Other)
* 3. [Custom Style](#CustomStyle)
* 4. [Extension for TextMeshPro](#ExtensionforTextMeshPro)
* 4.1. [Supported Tags](#SupportedTags-1)
* 4.2. [Supported Size Formart](#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