Djphoenix719 / PDFoundry

A fully featured PDF viewer module for Foundry VTT, including form fillable actor sheets, journal links, and more!
Apache License 2.0
41 stars 20 forks source link
fillable-forms foundry-vtt pdf-viewer

PDFoundry has been depracated

PDFoundry has been deprecated as Foundry VTT now includes builtin PDF support, and there are only a few cases where PDFoundry's extra features exceed Foundry's. It may return one day to provide the missing features, but will require enough work to do so that it is currently not viable without a more complete re-write.

So long, and thanks for all the fish!

PDFoundry

GitHub release (latest by date) GitHub Workflow Status GitHub issues GitHub license GitHub pull requests

GitHub All Releases GitHub Releases

PDFoundry (pronounced Pee-Dee-Foundry/pi di ˈfaʊndri) is a fully featured PDF viewer for FoundryVTT! PDFoundry supports a full suite of features for viewing PDFs right in Foundry VTT. Fillable forms, bookmarks, page links in journals and LOTS more. You can even use a form fillable PDF character sheet for an actor!

Please consider supporting me on Ko-Fi

Thanks to

Spanish localization: José E. Lozano (lozalojo)

French localization: Baktov

Community Resources

Tutorials and resources created by users of PDFoundry can be found here

Setup

PDFoundry is easily installable - find it in the modules list inside Foundry VTT. Alternatively, you can use the manifest link below.

Manifest

https://raw.githubusercontent.com/Djphoenix719/PDFoundry/master/module.json

System Developers

I highly recommend you do not bundle PDFoundry - if you do however, the module version will disable itself and display a warning to the user. Instead, you can see the documentation for an example of checking for the presence of PDFoundry, and enabling additional support if it is found.

Building PDFoundry

If you wish to build PDFoundry yourself - most commonly because you want to contribute - you can do the following.

  1. Clone the repository anywhere
  2. Copy foundryconfig.example.json and rename it foundryconfig.json. Edit the dataPath to your data folder.
  3. Open a terminal, navigate to the repository directory
  4. Run npm install
  5. Run gulp build to perform a one off build, or gulp watch to perform incremental builds as you change things

API Examples

See the documentation for details and examples.

Roadmap

See the development board for a list of planned features, roughly in the order I plan to get to them.