Introduction
This channel contains templates for some of the more commonly used structures in PvME guides. You can use them as they are, or modify them as required.
Formatting Embeds
This refers to Discord embed messages that are JSON-formatted to produce good looking output. The basic template is shared below, as well as ways to see the output in real-time for faster and easier writing.
Embed Commands
⬥ \n = add a new line.
⬥ \u00a0\u00a0\u00a0\u00a0 = add 4 spaces after a new line.
⬥ \n\u00a0\u00a0\u00a0\u00a0• = add a new line and 4 spaces (to add sub-subpoints).
⬥ \n\u200B = add a blank line at the end of string.
⬥ [text](website link) = add hyperlink (links will only resolve if they are valid and exist).
⬥ [text]($linkmsg_tagword$) = add link to previous discord message in the channel that has been tagged using .tag:tagword (links will only resolve if they are valid and exist).
A example embed structure is given below, as a starting point to create your own embeds.
..
{
"embed": {
"title": "__Embed Template Example__",
"description": "This is the embed description. Ask for help if you have any questions!",
"color": 39423,
"thumbnail": {
"url": "https://cdn.discordapp.com/embed/avatars/0.png"
},
"footer": {
"icon_url": "https://cdn.discordapp.com/embed/avatars/0.png",
"text": "Some embed footer text."
},
"fields": [
{
"name": "__Field 1__",
"value": "⬥ Field 1 point\n\u00a0\u00a0\u00a0\u00a0• Field 1 subpoint\n⬥ Field 1 point"
},
{
"name": "__Field 2__",
"value": "⬥ Field 2 point\n\u00a0\u00a0\u00a0\u00a0• Field 2 subpoint\n\u00a0\u00a0\u00a0\u00a0• Field 2 subpoint"
},
{
"name": "__Field 3__",
"value": "⬥ Field 3 point\n⬥ Field 3 point with embedded hyperlink to [Google Search](https://www.google.com/)."
}
]
}
}
..embed:json
When rendered, this looks like the following:
Note: Not all fields are mandatory, adjust it as required. Other template examples are given below as well.
Note: Links will only resolve if they are valid and exist.
General Guide Writing Template
The following template covers the basic structure of a guide for reference. Copy this into the Guide Editor tool and use it as a starting point for the guide layout.
# Title
..img:https://img.pvme.io/images/gIzPFEV.png
Note: a **Table of Contents** can be found in the pins.
..
## __Intro__
..tag:intro
[Brief overview of the boss]
..
## __Presets__
..tag:presets
{
"embed": {
"title": "",
"color": 39423,
"image": {
"url": "[Link to preset image]"
},
"fields": [
{
"name": "__[Preset name] Suggestion__",
"value": "⬥ [[Preset breakdown]]([Link to preset breakdown])\n\u200B\n\u200B Describe ammo/EoFs",
"inline": true
}
]
}
}
..embed:json
..
## __Mechanics__
..tag:mechanics
{
"embed": {
"color": 39423,
"fields": [
{
"name": "__Mechanic 1__",
"value": "⬥ [[Description of mechanic]]([Link to gif of mechanic])\n\u00a0\u00a0\u00a0\u00a0• [Describe how to handle mechanic]\n\u200B"
},
{
"name": "__Mechanic 2__",
"value": "⬥ [Description of mechanic]([Link to gif of mechanic])\n\u00a0\u00a0\u00a0\u00a0• [Describe how to handle mechanic]"
}
]
}
}
..embed:json
## __**Strategy (Delete if not applicable)**__
..tag:strategy
⬥ [Explain the fight and how to generally handle it, break it down into phases if applicable]
..
## __**Rotations__ (Delete if not applicable)**__
..tag:rotations
⬥ [Phase 1 rotations]
⬥ [Phase 2 rotations]
..
## __Example Kills__
..tag:example
Table of Contents (Basic)
This is a basic ToC embed structure, typically paired with the previous basic guide layout. All guides must contain a ToC at the end (and in the pinned messages).
..
{
"embed": {
"title": "__Table of Contents__",
"color": 39423,
"fields": [
{
"name": "__Introduction__",
"value": "[Link]($linkmsg_intro$)",
"inline": true
},
{
"name": "__Presets__",
"value": "[Link]($linkmsg_presets$)",
"inline": true
},
{
"name": "__Mechanics__",
"value": "[Link]($linkmsg_mechanics$)",
"inline": true
},
{
"name": "__Strategy__",
"value": "[Link]($linkmsg_strategy$)",
"inline": true
},
{
"name": "__Rotations__",
"value": "[Link]($linkmsg_rotations$)",
"inline": true
},
{
"name": "__Example Kills__",
"value": "[Link]($linkmsg_example$)",
"inline": true
}
]
}
}
..embed:json
..pin:delete
Note: Links will only resolve if they are valid and exist.
Table of Contents (v2)
This is an alternate approach to the Table of Contents embed, and may be useful in cases where the channels are longer, or to make it easier for users to identify relevant sections and links.
..
{
"embed": {
"title": "__Table of Contents__",
"color": 39423,
"fields": [
{
"name": "__Group 1__",
"value": "⬥ [Section 1]($linkmsg_section1$)\n⬥ [Section 2]($linkmsg_section2$)",
"inline": true
},
{
"name": "__Group 2__",
"value": "⬥ [Section 1]($linkmsg_basicguide$)\n⬥ [Section 2]($linkmsg_section2$)\n⬥ [Section 3]($linkmsg_section3$)\n⬥ [Section 4]($linkmsg_section4$)",
"inline": true
},
{
"name": "__Group 3__",
"value": "⬥ [Section 1]($linkmsg_section1$)\n⬥ [Section 2]($linkmsg_section2$)\n⬥ [Section 3]($linkmsg_section3$)\n⬥ [Section 4]($linkmsg_section4$)",
"inline": true
}
]
}
}
..embed:json
When rendered, it looks like the following:
Note: Links will only resolve if they are valid and exist.
Example Kills
An embed format to add example kills to a guide.
..
{
"embed": {
"title": "__Example Kills__",
"description": "Some example kills to compare and improve your own kills with.\nSuggested [Video Walkthrough](link_to_walkthrough)",
"color": 39423,
"fields": [
{
"name": "__Magic__ <:Magic:689504724159823906>",
"value": "⬥ [Kill Description](link_to_kill)"
},
{
"name": "__Melee__ <:melee:1096130867279171706>",
"value": "⬥ [Kill Description](link_to_kill)"
},
{
"name": "__Ranged__ <:range:580168050121113623>",
"value": "⬥ [Kill Description](link_to_kill)"
}
]
}
}
..embed:json
When rendered, it looks like the following:
Note: Links will only resolve if they are valid and exist.
Minimal Embed 1
A regular embed with some optional tags removed, to make it smaller and more compact.
..
{
"embed": {
"title": "__[embed title]__",
"description": "[embed description]",
"color": 39423,
"fields": [
{
"name": "__[field name]__",
"value": "[field contents]"
}
]
}
}
..embed:json
When rendered, it looks like the following;
Note: Links will only resolve if they are valid and exist.
Minimal Embed 2
Another version of a minimal embed, even compact.
..
{
"embed": {
"title": "__[embed title]__",
"description": "[embed description]",
"color": 39423
}
}
..embed:json
When rendered, it gives the following output:
Note: Links will only resolve if they are valid and exist.