PDFoundry

KO | EN

gitlite — search

#php #javascript #ruby #python #linux #java #dotfiles #c-sharp #css #macos #vim #zsh

★ 42 Open GitHub ↗

A fully featured PDF viewer module for Foundry VTT, including form fillable actor sheets, journal links, and more!

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 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)](https://img.shields.io/github/v/release/DJPhoenix719/PDFoundry)
![GitHub Workflow Status](https://img.shields.io/github/workflow/status/Djphoenix719/PDFoundry/Release%20Module)
[![GitHub issues](https://img.shields.io/github/issues/Djphoenix719/PDFoundry)](https://github.com/Djphoenix719/PDFoundry/issues)
[![GitHub license](https://img.shields.io/github/license/Djphoenix719/PDFoundry)](https://github.com/Djphoenix719/PDFoundry/blob/master/LICENSE)
[![GitHub pull requests](https://img.shields.io/badge/pull%20requests-welcome-green)](https://github.com/Djphoenix719/PDFoundry/compare)

![GitHub All Releases](https://img.shields.io/github/downloads/Djphoenix719/PDFoundry/total)
![GitHub Releases](https://img.shields.io/github/downloads/Djphoenix719/PDFoundry/latest/total)

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](https://ko-fi.com/djsmods)

#### Thanks to
Spanish localization: [José E. Lozano (lozalojo)](https://github.com/lozalojo)

French localization: [Baktov](https://github.com/Baktov)

## Community Resources
[Tutorials and resources created by users of PDFoundry can be found here](https://github.com/Djphoenix719/PDFoundry/wiki/Community-Resources)

## 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](https://djphoenix719.github.io/PDFoundry/index.html) 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.
2. Open a terminal, navigate to the repository directory
3. Run `npm install`
4. 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](https://djphoenix719.github.io/PDFoundry/index.html) for details and examples.

## Roadmap
See the [development board](https://github.com/Djphoenix719/PDFoundry/projects/1#column-9772243) for a list of planned features, roughly in the order I plan to get to them.

PDFoundry

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README