Many old links have been removed from this page due to their content not being updated to modern Foundry.
¶ Official API
Foundry has a Developer API Documentation section on the official foundryvtt.com website here, generated from the JSDoc comments within every local installation of Foundry.
You have two options for perusing the source code within resources/app:
- The subfolders
commonandclientbreak the classes up into individual files. Classes insidecommonuse JavaScript modules, so for example the baseDocumentclass is bundled and available atfoundry.abstract.Documentin your client.
Since v13, that is also true forclientclasses. Before v13,clientclasses were all thrown directly into the global scope (with aclient-esmfolder containing ones that were already converted to the modular approach). - Alternatively,
public/scripts/foundry.jsis the entire script as it's delivered to end users; note that it has some external imports for the esmodules content.
It is advisable to open this file up and search it in your IDE, as all of the JSDoc comments are present and you can easily see what is really going on in the code.
¶ Knowledge Base
- Introduction to Development
- Introduction to Module Development
- Introduction to System Development
- Introduction to System Data Models
¶ Official Discord Server
The official Discord is a great place to get up-to-date information and support. If you are looking for help, you might want to ask in the following channels:
#macro-polofor help with macros;#module-developmentfor help with developing your own module;#system-developmentfor help with developing your own system.
¶ Tutorials
¶ Boilerplate System Development Tutorial
Wiki hosted guide to accompany and explain the Boilerplate system as well as a lot of core system development concepts.
Boilerplate is a lightly opinionated boilerplate system that can be used as a starting point to build a custom system.
The main Boilerplate branch and parts of the Boilerplate tutorial could be considered slightly outdated at the time of writing. Consider using the
v12branch of the Boilerplate system, and Data Models instead oftemplate.json.
¶ Development Tools
¶ foundry-vtt-types
- A community effort to cover all of Foundry’s API with TypeScript type definitions.
¶ Quench - End to End testing within Foundry
- Allows devs to register end to end tests powered by Mocha (and also includes Chai), which are then run in-game in a native Foundry Application.