Register

AI Description Generator

An Add-on Module for Foundry Virtual Tabletop

Author: Pepijn Project Source: Project URL Versions 10+ (Verified 10) Last Updated 1 year, 2 months ago

Although this module is completely free, the AI it uses is not. The module requires an API key obtained from https://beta.openai.com/account/api-keys and an OpenAI account with valid payment information. The pricing can be found at https://openai.com/api/pricing/, but on average you can expect each non-custom request made by this module to cost about $0.002 (2/10th of a single cent). It is advised to set a monthly usage limit if you are worried about costs, you can do so in your account settings here https://beta.openai.com/account/billing/limits.

This module does not require any credentials except for your API key, which is stored locally in your Foundry settings. All billing is done from your OpenAI account. This key could be accessed by other programs and modules although they would have little reason to do so, nevertheless be careful and once again make sure to set a monthly limit to avoid unsuspected costs.

GPT-3 is a text-based AI by OpenAI. This module provides a user-friendly implentation to communicate with its API from within your Foundry games to generate descriptions on the fly. The module provides direct support for actors, items, attacks, spells, and features.

System Support

By default your current rpg system is integrated into the prompt to give GPT-3 the context it needs. By the nature of GPT-3 it will work better for popular systems and worse for very niche systems. If your system produces subpar results you can manually change the system in the settings to something that provides more context than just the system's name.

Language Support

By default your current FoundryVTT language is integrated into the prompt to encourage GPT-3 to reply in that language. GPT-3 was trained mainly in English so the quality of results may vary in other languages.

If you want to have some fun, try out 'Pirate Speech'.

Pirate Speech Description

Chat Commands

There are two new commands available to the GM to send prompts to GPT-3.

/gpt construct (subject)
/gpt send (prompt)

Description Generator

All actors, items, attacks, spells, and features have a button added in their header for the GM to request a short description generated by the AI based on your rpg system and world/setting. Responses are put in the Foundry chat and can optionally only be whispered to you.

The button on the sheet

Player Characters

The prompt constructed for PC actors is a bit different than for other actors. PCs use their lineage and classes as the subject, instead of using the actor's name. Anything written in the appearance text box is also passed along as additional context. It is recommended to be short but concise to generate results that fit the character you have envisioned in your mind, for example: male, wild white hair, steampunk clothing, red eyes.

Examples

Adult Green Dragon

A description generated for an Adult Green Dragon

Air Elemental

A description generated for an Air Elemental

Will O' Wisp

A description generated for a Will O' Wisp

Alchemy Jug

A description generated for an Alchemy Jug

Bag of Holding

A description generated for a Bag of Holding

Flame Tongue Greatsword

A description generated for a Flame Tongue Greatsword

Cone of Cold

A description generated for Cone of Cold

Eldritch Blast

A description generated for Eldritch Blast

Fireball

A description generated for Fireball

Issues and Requests

Please report issues and propose feature requests here.

The module will never send a request to GPT-3 without being told to by pressing a button, using chat commands, or using the API in macros or other modules. Nevertheless if you ever suspect you are being charged for unprovoked requests from this module please disable the module immediately and raise a critical issue.

Categories

Available Versions

  1. Version 1.6.0

    1 year, 2 months ago
    Foundry Version 10+ (Verified 10) Manifest URL Read Notes