# 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/module.zip)
![GitHub All Releases](https://img.shields.io/github/downloads/elizeuangelo/fvtt-module-narrator-tools/module.zip?label=downloads)

#### Donations

[![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](assets/narrator-tools.webp)

### Token Toolbox

-   New Scenery Tool - dims the canvas and apply vignette

![img](assets/scenery-tool.webp)

### 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](assets/journal-example.webp)

## 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.