Player Achievements - A FoundryVTT module

This module provides GMs with a way to award players with achievements.

Links

Upcoming Changes	API Documentation
Link	Link

Features

Developers

Provides an API documented in API.md
Provides hooks for after achievement award/unaward.

GMs

Create your own achievements.
Add tags to achievements for easier display filtering.
Choose to show or hide tags when players view achievements.
Assign/Unassign achievements to/from players.
Award achievements to players that are offline and they will recieve them when they next login.
Customize sound played per achievement.
Choose to cloak all unearned achievements details from players.
Choose to allow cloaked achievements to show title on a per achievement basis.
Choose an image to show when an achievement is cloaked.
Choose to hide all unearned achievements from players.
Show achievement earn message to all players or only receiving player.
Backup achievement data to clipboard as JSON.
Restore achievement data from clipboard JSON text.
Use special markup to include newlines, bold, and italic text in descriptions of achievements.

Players

Optionally play a sound when an achievement is earned.
Control the volume of achievement sounds if they play.

All

Sort Achievement View by achievement name (ascending or descending).
Sort Achievement View by owned player.
Filter Achievement View by name.

Known Conflicts

Plugin	id	Conflict
None

Support

Feel free to file a Bug Report / Feature Request under the Issues tab of Github.

How to Use

DMs & Players

Note: Players will see achievements that they are allowed to see based on the DMs options.
Players will also not see the add-achievement/export/import/award/unaward/etc buttons.

First, click the Icon on your side panel:

DM Instructions for main panel

DM Instructions for adding an Achievement

DM Instructions for awarding achievements

Markup

The following tags are supported in the Achievement Description:

{nl} - Inserts a line break
{b}{/b} - Contents will be bold
{i}{/i} - Contents will be italics
{u}{/u} - Contents will be underlined

Developers

Hooks for Achievement Events

The module provides two hooks, “fvtt-player-achievements.awardAchievement” and “fvtt-player-achievements.unAwardAchievement”, allowing developers to integrate custom functionality after an achievement is granted or removed to/from a character.

Both hooks grant two parameters, the Achievement ID and the Character UUID, in that order.

Example Usage

  // Triggered after an achievement is granted to a character
  Hooks.on("fvtt-player-achievements.awardAchievement", (achievementId, characterUUID) => {
    console.log(`Character ${characterUUID} has gained the achievement: ${achievementId}`);
  });