This module aims to provide a fast and concise DnD5 Cheatsheet. With easy access buttons (can be disabled in settings).
Available in English and French.
To install, follow these instructions:
- Inside Foundry, select the Game Modules tab in the Configuration and Setup menu.
- Click the Install Module button and enter the following URL: https://raw.githubusercontent.com/pchouzenoux/foundryvtt-dnd5-cheatsheet/main/dist/module.json
- Click Install and wait for installation to complete.
In module configuration you can configure number of buttons, and links with journal entry from any compendium.
You can find all available icons here. Select an icon and on the top find the html code, copy class content in the configuration table.
For example:
- For dungeon icon: https://fontawesome.com/v5.15/icons/dungeon?style=solid
- Html code is
<i class="fas fa-dungeon"></i>
- Copy and past
fas fa-dungeon
in incon configuration
To configure compendium you need to concatenate pack name and entry id with a dot between them.
To help this step simply found the journal entry and drag and drop it in the good input in module configuration table.
You cannot link to a Journal entry that is mot part of a compendium. You cannot link to something else that an Journal entry
To build locally (compile typescript, less, compile packs and babele)
yarn build
: Build the moduleyarn build:watch
: Build the module and start the watcher
Set FOUNDRY_DATA
environment variable to deploy locally and next run one of these two commands:
yarn deploy
: Deploy built module toFOUNDRY_DATA
folderyarn deploy:watch
: Build and deploy module toFOUNDRY_DATA
folder then start the watcher
To simplify the creation of packs use this method:
- Create a folder with the final name of the pack (ex:
my-pack.db
) - One entry in the pack is on
json
file in this folder
You can create an
.html
file with save file name to replace content of the pack by HTML content.
- Update
src/lang/compendium/dnd5-cheatsheet.dnd5-cheatsheet.json
- Instead of writting the
description
you can let it empty and create an_fr.html
in the pack folder. With the pack corresponding name.