Text Formatting
OrbRPG provides a custom Markdown implementation called OrbMarkdown to support rich text formatting in various parts of the application. This allows users to add structure and style to their content without needing complex HTML knowledge.
Where is it used?
OrbMarkdown is available in:
- Chats: Messages can be formatted.
- Game Details: Description, Player Requirements, etc.
- Guild Posts: The article text of a post on a Guild Noticeboard.
- Guild Events: The description of an event.
The same syntax works in all of them.
Supported Markdown Syntax
OrbMarkdown is close to the Markdown you may know already. Some of it we left out, and a few things we added, such as the width of an image. Here is everything it understands.
Paragraphs & Line Breaks
OrbMarkdown preserves line breaks similar to Discord message formatting.
- Line Breaks: A single new line in the editor creates a line break in the output. No need for double spaces.
- Paragraphs: Leave an empty line between text blocks to create a new paragraph.
Text Styles
| Style | Syntax | Example | Result |
|---|---|---|---|
| Bold | **text** | **Bold Text** | Bold Text |
| Italic | *text* | *Italic Text* | Italic Text |
Code | `text` | `const x = 1` | const x = 1 |
Headings
Use # at the start of a line to create headings. OrbMarkdown supports up to 3 levels.
| Level | Syntax | Example |
|---|---|---|
| Heading 1 | # Text | # Main Title |
| Heading 2 | ## Text | ## Section Title |
| Heading 3 | ### Text | ### Subsection |
Lists
Create bulleted lists using * or - at the start of a line.
* Item 1
* Item 2
- Item 3
Links
You can create named links or let raw URLs be automatically converted.
| Type | Syntax | Example |
|---|---|---|
| Named Link | [text](url) | [OrbRPG](https://orbrpg.com) |
| Auto URL | https://... | https://google.com |
Images
Insert an image with an exclamation mark, the description in square brackets, and the image address in round brackets.
| Type | Syntax |
|---|---|
| Image |  |
| Image with a width | {maxWidth=400} |
The width is optional. A plain number means pixels, so maxWidth=400 asks for 400 pixels wide. An image never grows wider than the text column around it, whatever you ask for. Any setting other than maxWidth is ignored, so a typo costs you the width, not the image.
Always write the description. Some places on OrbRPG show text only, and there your words appear in place of the picture.
Tip: writing a post on a Guild Noticeboard? Upload the picture to the post's Illustrations gallery and click it, instead of typing the address by hand. See Guild Noticeboard.
Game Card Behavior
Formatting is disabled for Game Cards. It means text will be rendered as plain text without any Markdown formatting. This ensures a consistent appearance for all game cards, regardless of the content provided by Game Masters.
Note: as Card Snipped it shown only on Game Card it does not support formatting.