Compendium Editor

Show Preview

Drafts:

---
title: Guide Template # name of your guide should match with the first header
description: Small template for creating a Compendium guide.
dateCreated: 2025-01-01
lastUpdated: 2025-01-01
seasons: shadowsOfTheDeep # optional if you guide is season specific
modes: pve # optional; pve, pvpve, pvp
content: worldEvent # optional; general, tipsAndTricks, lore, event, world event
author: MyName
keywords: my guide,a world event,pve,shadowsOfTheDeep,locker,chest # keywords by which your guide should be found in the search
visible: false # gets changed to true once published
---

# Guide Template
A template to create an guide for the SnB Tools Compendium.

---

## Content

## Description
</div>

## General
This guide acts as a starting point for creating your own guide and shows the different options that can be used when writing it.\
Following below are general informations about the technical functions and how to utilize them. After that you can find a example structure that most guides follow.

Images are not supported in the preview as they get manually added when publishing the guide. For this please leave placeholders where they should be and provide the images later via discord ([Publishing](#publishing)).

## Technical
### Github Flavored Markdown
The Compendium uses a markdown notation called Github Flavored Markdown (GFM) which extends the default Markdown format with additional functions and formats.
You can find a great overview over here: [GitHub Guide](https://docs.github.com/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/quickstart-for-writing-on-github)

### SnB Tools Functions
To make the writing easy and enhance the user experience items, cosmetics, sets and more can be directly linked in the guide with the following formats.

- Item, Cosmetic, Commodity, Material: `nashkar`, `stingyJack`, `blueLotusOpium`, `blightedFuel`
- Set: `caliban;set`, `elDorado;set`
- Seasons: `ragingTides`

Additionally can any text be colored with the 5 rarities of the game.

- Rare: `A rare chest;rarity-rare`
- Epic link to a previous section: [`Github Flavored Markdown;rarity-epic`](#github-flavored-markdown)
- Legendary and bold: **`Really Legendary Item;rarity-legendary`**

## Example Structure

### Lore
This section can contain Skull and Bones lore related to your topic, but also real life background informations.

### Approach
This section explains how to approach the world event for example in multiple chapters starting with the location, its attacks and in the end the tips and recommend loadouts. It is common that the attacks and tips don't have a dedicated chapter, but follow after the location.

#### Location
A small description of where it is located related to the nearest outpost for example.

#### Recommended Loadouts
Try to link some loadouts that could be helpful for your topic and explain shortly why you recommend those.

### Possible Rewards
This section contains an info about the reward, in most cases the chest including an img, its description, possible items and cosmetics.

![Icon of Treasure Chest]()

#### Description
> This is a special chest.

#### Items

| Reward     |
|------------|
| `cogwheel` |
| `woodTar`  |
| `camphor`  |
| `nutmeg`   |

<details>
<summary><h6 class="clean">Chest Info Image</h6></summary>

![Info of Treasure Chest]()

</details>

#### Cosmetics

| Reward | Set |
| --- | :---: |
| `kingsWill` | `dmcCosmetics;set` |
| `kingsFavor` | `dmcCosmetics;set` |
| `dmcSoldierTop` |
| `jaegerOfficerCoat` <br/> *Exclusive drop.* |
| `dmcBreechesBlue` |
| `dutchLeggings` |
| `dmcSoldierBand` |

---

## Images
</summary>

![Image of a nice ship]()

</details>

## Publishing
Once you're happy with the draft or need some help you can contact **herby2212** on discord via direct message for more informations and next steps.

Guide Template

A template to create an guide for the SnB Tools Compendium.

Content

General
Technical
- Github Flavored Markdown
- SnB Tools Functions
Example Structure
Images
Publishing

Description

General

This guide acts as a starting point for creating your own guide and shows the different options that can be used when writing it.
Following below are general informations about the technical functions and how to utilize them. After that you can find a example structure that most guides follow.

Technical

Github Flavored Markdown

The Compendium uses a markdown notation called Github Flavored Markdown (GFM) which extends the default Markdown format with additional functions and formats. You can find a great overview over here: GitHub Guide

SnB Tools Functions

To make the writing easy and enhance the user experience items, cosmetics, sets and more can be directly linked in the guide with the following formats.

Item, Cosmetic, Commodity, Material: Nashkar, Stingy Jack, Blue Lotus Opium, Blighted Fuel
Set: Caliban Set, El Dorado Set
Seasons: Y1S1 - Raging Tides

Additionally can any text be colored with the 5 rarities of the game.

Rare: A rare chest
Epic link to a previous section: Github Flavored Markdown
Legendary and bold: Really Legendary Item

Example Structure

Lore

This section can contain Skull and Bones lore related to your topic, but also real life background informations.

Approach

This section explains how to approach the world event for example in multiple chapters starting with the location, its attacks and in the end the tips and recommend loadouts. It is common that the attacks and tips don't have a dedicated chapter, but follow after the location.

Location

A small description of where it is located related to the nearest outpost for example.

Recommended Loadouts

Try to link some loadouts that could be helpful for your topic and explain shortly why you recommend those.

Possible Rewards

This section contains an info about the reward, in most cases the chest including an img, its description, possible items and cosmetics.

Images are not supported in the Preview.

Description

This is a special chest.

Items

Reward
Cogwheel
Wood Tar
Camphor
Nutmeg

Chest Info Image

Images are not supported in the Preview.

Cosmetics

Reward	Set
King's Will	DMC Cosmetics Set
King's Favor	DMC Cosmetics Set
DMC Soldier Top
Jäger Officer Coat Exclusive drop.
DMC Breeches Blue
Dutch Leggings
DMC Soldier Band

Images

Images are not supported in the Preview.

Publishing

Once you're happy with the draft or need some help you can contact herby2212 on discord via direct message for more informations and next steps.

Version 1.14 - Already checked out the new Wardrobe?Made with ❤ for the community!