create-fvtt-module
v0.7.0
Published
A CLI tool to scaffold Foundry VTT modules
Downloads
309
Maintainers
Readme
create-fvtt-module
A CLI scaffolding tool for creating Foundry VTT modules.
Requires Node.js 24 or newer, including for generated Vite projects.
Installation
Global Installation (for end users)
Once published to npm, you can run the script:
bunx create-fvtt-module
npx create-fvtt-moduleUpdating the package:
bun i -g create-fvtt-module@latest
npm i -g create-fvtt-module@latestDevelopment Installation
For development purposes:
git clone https://github.com/MrVauxs/create-fvtt-module
cd create-fvtt-module
bun install
bun run devDevelopment
TypeScript is kept on 6.0.x because the latest typescript-eslint supports versions below 6.1.
# Install dependencies
bun install
# Run in development mode (requires Bun)
bun run dev
# Watch for TypeScript changes
bun run build:watchScripts
bun run build- Compile TypeScript to JavaScriptbun run build:watch- Watch TypeScript files and rebuild on changesbun 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
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.
