create-fvtt-module

A CLI scaffolding tool for creating Foundry VTT modules.

Installation

Global Installation (for end users)

Once published to npm, you can run the script via Bun:

bunx create-fvtt-module

Development Installation

For development purposes:

git clone https://github.com/MrVauxs/create-fvtt-module
cd create-fvtt-module
bun install
bun run dev

Development

# Install dependencies
bun install

# Run in development mode (requires Bun)
bun run dev

# Watch for TypeScript changes
bun run build:watch

Scripts

• bun run build - Compile TypeScript to JavaScript
• bun run build:watch - Watch TypeScript files and rebuild on changes
• bun run dev - Run the CLI in development mode (requires Bun)
• bun run prepublishOnly - Automatically run before publishing

System Support

Currently supports:

• dnd5e - Dungeons & Dragons 5th Edition
• pf2e - Pathfinder 2nd Edition

Additional systems can be added in src/options.ts.

Resources

Foundry VTT Documentation

• dnd5e System Wiki
• dnd5e Module Registration
• PF2e Wiki

Module Development

• Foundry VTT Module Development

License

MIT

Contributing

Contributions are welcome! Please feel free to submit pull requests.

Issues

Found a bug? Please open an issue on GitHub.