This repo is meant to be used as a starting point for creating your own FoundryVTT module with Typescript. If you are using Github you can get started by clicking the green Use this template button in the upper-right.

Check out our blog post for a walkthrough of the codebase.

Out of the box this template adds a button to the top of the Actors directory. Clicking it brings up a modal with a button that will load a picture of a random dog from the Dog API. This demonstrates how to perform some common tasks such as render templates and call external APIs, and hopefully provides a decent starting point for developing your own module.

If you have just created a new project with this template there are a few changes you should make to start:

• Update the values in src/module.json. At minimum you should change id, title, and description. It is also recommended that you add a contacts field.
• Start using a new module prefix for localizations. The localizations in src/languages/en.json are all prefixed with MYMODULE. to distinguish them from any other installed translations. You should choose a new prefix for your module and use it for any new translations you add, and remove the existing translation entries as they become unnecessary.