# Foundry VTT - Narrator Tools

![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/elizeuangelo/fvtt-module-narrator-tools)
![GitHub Releases](https://img.shields.io/github/downloads/elizeuangelo/fvtt-module-narrator-tools/latest/total)
![GitHub All Releases](https://img.shields.io/github/downloads/elizeuangelo/fvtt-module-narrator-tools/total?label=downloads)

#### Donations

##### Crypto

[![BTC](https://img.shields.io/badge/bitcoin-gold.svg)](https://blockchair.com/bitcoin/address/bc1qtyy30h4d7yc6d3pjwmu46mpqxw7v50jnsq5sk9)
[![ADA](https://img.shields.io/badge/Cardano-9cf.svg)](https://cardanoscan.io/address/addr1qy32u0vthhy76mdck84nanw6d8t2ufrhv3pzulycp75lcp6jfmzvguq883d96hq5cmys2h28hmqfpjyfz4ceuw29h33sa3t5mf)
[![ETH](https://img.shields.io/badge/ethereum-silver.svg)](https://blockchair.com/ethereum/address/0xa9c30d78f6ba250523289090bcc55832eda19a16)
[![LTC](https://img.shields.io/badge/litecoin-lightgrey.svg)](https://blockchair.com/litecoin/address/LbB43DHAny9CShT5yL6Fc62SMXQUvZVEtZ)
[![DOGE](https://img.shields.io/badge/doge-yellow.svg)](https://blockchair.com/dogecoin/address/DPmkqoDc25YeLhSK2LbQyvyi1yP5f4JvDh)

##### Others

[![ko-fi](https://img.shields.io/badge/Kofi-red.svg)](https://ko-fi.com/B0B024E6C)
[![BuyCoffee](https://img.shields.io/badge/coffee-%243-orange)](https://www.buymeacoffee.com/j6auA0z)

Special tools to increase the immersion in your roleplaying game.

[Wiki for Programmers](https://github.com/elizeuangelo/fvtt-module-narrator-tools/wiki)

## Installation

In the setup screen, use the URL https://raw.githubusercontent.com/elizeuangelo/fvtt-module-narrator-tools/master/module.json to install the module.

## How to Use

The module currently adds chat commands and a new tool on the token toolbox (the button menu on the left).

### New Chat Commands

-   `/desc (or /describe, or /description) [message]` - displays a descriptive message in chat only
-   `/narrate (or /narration) [message]` - displays a limited duration message in the canvas and chat
-   `/note (or /notify or /notification) [message]` - displays a _note message_ in chat only visible to GMs
-   `/as [speaker]` - makes the next messages be sent as the _speaker_. `/as` resets to standard behavior

![img](https://cdn.discordapp.com/attachments/542495303929036824/750483802719125634/narrator-tools_2.jpg)

### Token Toolbox

-   New Scenery Tool - dims the canvas and apply vignette

![img](https://cdn.discordapp.com/attachments/542495303929036824/750424196806475866/Example_narrator_tools.jpg)

### Journal Context Menu

-   Chat commands are now usable in the Journal with a simple right-click! Select the text you want to narrate and give the command. Simple and easy.

![img](https://cdn.discordapp.com/attachments/542495303929036824/756978823077298177/unknown.png)

## License

This module is made by elizeuangelo and it is licensed under a Creative Commons Attribution 4.0 International License.

This work is licensed under Foundry Virtual Tabletop EULA - Limited License Agreement for module development v 0.1.6.
