player-safe

README

Player Safe

A Gitbook plugin that allows Dungeon Masters (DMs) to hide data from their players in a simple way.

Installation

Within your book.json in the root of your gitbook project, add the following:

{
  "plugins": ["player-safe"]
}

Run a gitbook install to download and install the latest Player Safe version.

Usage

Hide large areas.


You arrived at a barn, littered with the bodies of cows, rotten and festering.

{% PlayerSafe %}

The cows were actually killed weeks ago by a hungry Orc, found [here](../characters/orc.md).
When the players investigate the cows, they'll find teeth marks and small Orcish trinkets.

{% endPlayerSafe %}

The door had clearly been broken in a forced-entry.

.. will result in ..


You arrived at a barn, littered with the bodies of cows, rotten and festering.

The door had clearly been broken in a forced-entry.

Redact some areas.


You arrived at a barn, littered with the bodies of cows, rotten and festering.

The cows were actually killed weeks ago by {% PlayerRedacted %} a hungry Orc, found [here](../characters/orc.md) {% endPlayerRedacted %}.
When the players {% PlayerRedacted %} investigate the cows {% endPlayerRedacted %}, they'll find {% PlayerRedacted %} teeth marks and small Orcish trinkets {% endPlayerRedacted %}.

The door had clearly been broken in a forced-entry.

.. will result in ..


You arrived at a barn, littered with the bodies of cows, rotten and festering.

The cows were actually killed weeks ago by ■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■.
When the players ■■■■■■■■■■■■■■■■■■■■, they'll find ■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■.

The door had clearly been broken in a forced-entry.

Note

In my haste, I named the plugin Player Safe implying that the text between the tags would be safe for players to view.

It's not the case, annoyingly. Regardless, PlayerUnsafe will also work the same way if you're worried you'll forget.

Sorry about that.

Plugin

A Gitbook plugin that allows Dungeon Masters (DMs) to hide data from their players in a simple way.

https://github.com/GitbookIO/plugin


Latest: 1.1.8

1.0.0, 1.0.1, 1.0.2, 1.1.0, 1.1.1, 1.1.2, 1.1.3, 1.1.4, 1.1.5, 1.1.6, 1.1.7, 1.1.8,

Requirements

GitBook
1.1.8 *

Maintainers

Open on NPM